docs: Update grafana agent java example readme #3136
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
knylander-grafana
approved these changes
Mar 27, 2024
knylander-grafana
added
the
type/docs
apply code changes Co-authored-by: Kim Nylander <[email protected]>
aleks-p
reviewed
Mar 27, 2024
Comment on lines
11
to
21
| Java applications can be profiled via Pyroscope using three methodologies. The example emphasizes the first method, showcasing the attachment of the Pyroscope profiler as a `javaagent`. | ||
|
|
||
| Refer to the [official documentation](https://grafana.com/docs/pyroscope/latest/configure-client/grafana-agent/java/) for an in-depth understanding and additional configuration options for Java profiling with the Grafana Agent. | ||
|
|
||
| The three methodologies are as follows: | ||
|
|
||
| 1. **Java Agent** (this example): Attach the Pyroscope profiler as a `javaagent` to a running process, initializing the profiler at application startup without source code modifications or extra dependencies. Manage configuration using Java parameters or environment variables. | ||
|
|
||
| 2. **OTel Integration** ([docs](https://grafana.com/docs/pyroscope/next/configure-client/trace-span-profiles/java-span-profiles/)): Utilize the OTel integration as an extension to `otel-java-instrumentation`, in conjunction with `opentelemetry-javaagent` to link java profiles with trace spans. This method is suitable for applications already using OpenTelemetry. | ||
|
|
||
| 3. **Direct Dependency** ([docs](https://grafana.com/docs/pyroscope/next/configure-client/language-sdks/java/)): Integrate Pyroscope directly within your application's code to allow dynamic profiler management. |
There was a problem hiding this comment.
This example doesn't show the first method (or the other 2). In this approach the grafana agent attaches to the running Java processes and auto-instruments them (starts profiling) with async-profiler. Perhaps remove this section altogether and add a note in the next section about how this works.
To clarify, the first method mentioned above requires changing the command to start the java application, an example of this is
Rperry2174
commented
Mar 27, 2024
Rperry2174
commented
Mar 27, 2024
|
|
||
| ### Grafana Agent and async-profiler | ||
|
|
||
| The Grafana Agent automates Java process discovery for profiling, streamlining the setup per application. It enables precise and targeted profiling configurations through the Grafana Agent settings. |
There was a problem hiding this comment.
@aleks-p is this more correct (or if not what would you change this to)?
There was a problem hiding this comment.
I made a change that makes it more accurate imo. Take a look and change wording as needed (we might want another pass from @knylander-grafana as well?)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates grafana agent java example to have some more details explaining what the example actually does and how it works