Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,25 @@ OTEL_CONFIG_FILE=/path/to/config.yaml opentelemetry-instrument python app.py
See the [basic declarative configuration example](docs/examples/declarative-config.yaml),
which exports traces, metrics, and logs to a local Collector at `http://localhost:4317`.

This support configures upstream OpenTelemetry SDK components. The GDI
`distribution.splunk` configuration block is not supported yet. Configure
This support configures upstream OpenTelemetry SDK components. Configure
exporters, including their endpoints and authentication headers, in the YAML file.

Support for the GDI `distribution.splunk` configuration block is limited to
`instrumentations.http.trace_response_header_enabled`, which defaults to `true`.
To disable the trace response header, add this block to the YAML file:

```yaml
distribution:
splunk:
instrumentations:
http:
trace_response_header_enabled: false
```

When `OTEL_CONFIG_FILE` is set, the distribution does not enable
[continuous or call graph profiling](docs/profiling.md) or
[PostgreSQL trace correlation](docs/postgresql.md).

OpAMP does not report the declarative file as effective configuration and cannot
manage it remotely yet.

Expand Down
4 changes: 4 additions & 0 deletions docs/profiling.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ profiling** (also called snapshot profiling). Both modes collect CPU stack trace
export them as `pprof` data via the OTel logs exporter, with trace and span IDs
embedded so profiles can be correlated with traces in Splunk APM.

Both profiling modes require `OTEL_CONFIG_FILE` to be unset. When it is set, the
distribution does not start either profiler, even if its environment variable is
set to `true`.

## Continuous profiling

Continuous profiling samples all threads at a fixed interval, regardless of whether
Expand Down
Loading