Skip to content

Commit 9ab6193

Browse files
msailesmaxday
authored andcommitted
Update README.md (#77)
Added information regarding the alpha status of the release.
1 parent 1d3f455 commit 9ab6193

File tree

1 file changed

+2
-6
lines changed

1 file changed

+2
-6
lines changed

aws-lambda-java-profiler/README.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ profiling data and automatically uploads the data as flame graphs to S3.
1212
<img src="docs/example-cold-start-flame-graph.png" alt="A flame graph of a Java Lambda function">
1313
</p>
1414

15+
This is an alpha release and not yet ready for production use. We're especially interested in early feedback on features, performance, and compatibility. Please send feedback by opening a [GitHub issue](https://github.com/aws/aws-lambda-java-libs/issues/new).
16+
1517
### Usage
1618

1719
To use the profiler you need to
@@ -76,12 +78,6 @@ When the agent is constructed, it starts the profiler and registers itself as a
7678
A new thread is created to handle calling `/next` and uploading the results of the profiler to S3. The bucket to upload
7779
the result to is configurable using an environment variable.
7880

79-
### Project Structure
80-
81-
- `Agent.java`: Main class that coordinates profiling and S3 uploads.
82-
- `AgentEntry.java`: Entry point for the Java agent.
83-
- `ExtensionClient.java`: Handles communication with the Lambda Extensions API.
84-
8581
### Troubleshooting
8682

8783
- Ensure the Lambda function has the necessary permissions to write to the S3 bucket.

0 commit comments

Comments
 (0)