Skip to content

Commit ce8bf7e

Browse files
author
Davide Melfi
committed
chore: add readme info and a version metadata/.
1 parent 133df31 commit ce8bf7e

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

experimental/aws-lambda-java-profiler/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,25 @@ When the agent is constructed, it starts the profiler and registers itself as a
8383
A new thread is created to handle calling `/next` and uploading the results of the profiler to S3. The bucket to upload
8484
the result to is configurable using an environment variable.
8585

86+
### Custom Parameters for the Profiler
87+
88+
Users can configure the profiler output by setting environment variables.
89+
90+
```
91+
# Example: Output as JFR format instead of HTML
92+
AWS_LAMBDA_PROFILER_START_COMMAND="start,event=wall,interval=1us,file=/tmp/profile.jfr"
93+
AWS_LAMBDA_PROFILER_STOP_COMMAND="stop,file=%s"*Issue #, if available:*
94+
```
95+
96+
Defaults are the following:
97+
98+
```
99+
AWS_LAMBDA_PROFILER_START_COMMAND="start,event=wall,interval=1us"
100+
AWS_LAMBDA_PROFILER_STOP_COMMAND="stop,file=%s,include=*AWSLambda.main,include=start_thread"
101+
```
102+
103+
See [async-profiler's ProfilerOptions](https://github.com/async-profiler/async-profiler/blob/master/docs/ProfilerOptions.md) for all available profiler parameters.
104+
86105
### Troubleshooting
87106

88107
- Ensure the Lambda function execution role has the necessary permissions to write to the S3 bucket.

experimental/aws-lambda-java-profiler/integration_tests/helloworld/build.gradle

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,7 @@ task buildZip(type: Zip) {
2828
}
2929
}
3030

31+
version = '0.0.1'
32+
33+
3134
build.dependsOn buildZip

0 commit comments

Comments
 (0)