Skip to content

Commit

Permalink
docs: Add parameters from otel-profiling-java (#3444)
Browse files Browse the repository at this point in the history
I would like to get rid of the rich READMEs and link everything into
docs. This is something that our docs don't have.

(cherry picked from commit 126da8a)
  • Loading branch information
simonswine authored and grafana-delivery-bot[bot] committed Jul 24, 2024
1 parent 5ab858d commit 4e0f234
Showing 1 changed file with 8 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,14 @@ ENV PYROSCOPE_SERVER_ADDRESS=http://localhost:4040
CMD ["java", "-Dserver.port=5000", "-javaagent:./opentelemetry-javaagent.jar", "-javaagent:pyroscope.jar", "-jar", "./my-app.jar" ]
```

### Available configuration options

| Flag | Description | Default |
| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| `otel.pyroscope.start.profiling` | Boolean flag to start PyroscopeAgent. Set to false if you want to start the PyroscopeAgent manually. | `true` |
| `otel.pyroscope.root.span.only` | Boolean flag. When enabled, the tracer will annotate only the first span created locally (the root span), but the profile will include samples of all the nested spans. This may be helpful in case if the trace consists of multiple spans shorter than 10ms and profiler can't collect and annotate samples properly. | `true` |
| `otel.pyroscope.add.span.name` | Boolean flag. Controls whether the span name added to profile labels. | `true` |

## View the span profiles in Grafana Tempo

To view the span profiles in Grafana Tempo, you need to have a Grafana instance running and a data source configured to link trace spans and profiles.
Expand Down

0 comments on commit 4e0f234

Please sign in to comment.