Skip to content

Commit

Permalink
Add SPLUNK_PROFILER_CALL_STACK_INTERVAL (#160)
Browse files Browse the repository at this point in the history
* add SPLUNK_PROFILER_CALL_STACK_INTERVAL and split out default column

* Update specification/configuration.md

Co-authored-by: Steve Flanders <sflanders@splunk.com>

* leave none empty

* seconds -> ms

* add footnote about profiling being experimental

Co-authored-by: Steve Flanders <sflanders@splunk.com>
  • Loading branch information
breedx-splk and flands authored Dec 15, 2021
1 parent 9f93319 commit e282185
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions specification/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,14 +158,15 @@ For all use-cases that support environment variables (e.g. applications and
serverless), it MUST be possible to configure an Instrumentation Library
instance using the following environment variables:

| Name (default value) | Description |
| :------------------------------------: | :--------------------------------------------------------: |
| `SPLUNK_ACCESS_TOKEN` () | Access token added to exported data. [1] |
| `SPLUNK_METRICS_ENDPOINT` () | Endpoint for metrics data ingest. |
| `SPLUNK_PROFILER_ENABLED` (`false`) | Whether profiling is enabled. [2] |
| `SPLUNK_PROFILER_LOGS_ENDPOINT` () | Where profiling data is sent. By default `OTLP_EXPORTER_OTLP_ENDPOINT` is used. |
| `SPLUNK_REALM` (`none`) | Which realm to send exported data. [3] |
| `SPLUNK_TRACE_RESPONSE_HEADER_ENABLED` (`true`) | Whether `Server-Timing` header is added to HTTP responses. [4] |
| Name | Default | Description |
|----------------------------------------|---------|-----------------------------------------------------------------|
| `SPLUNK_ACCESS_TOKEN` | | Access token added to exported data. [1] |
| `SPLUNK_METRICS_ENDPOINT` | | Endpoint for metrics data ingest. |
| `SPLUNK_PROFILER_CALL_STACK_INTERVAL` | 10000 | Interval at which call stacks are sampled (in ms) [5] |
| `SPLUNK_PROFILER_ENABLED` | false | Whether profiling is enabled. [2] [5] |
| `SPLUNK_PROFILER_LOGS_ENDPOINT` | * | Where profiling data is sent. Defaults to the value in `OTLP_EXPORTER_OTLP_ENDPOINT` [5] |
| `SPLUNK_REALM` | `none` | Which realm to send exported data. [3] |
| `SPLUNK_TRACE_RESPONSE_HEADER_ENABLED` | true | Whether `Server-Timing` header is added to HTTP responses. [4] |

- [1]: Not user required if another system performs the authentication. For
example, instrumentation libraries SHOULD send data to a locally running
Expand All @@ -190,6 +191,8 @@ instance using the following environment variables:
precedence.
- [4]: If stitching of RUM spans and APM spans is desired then this parameter
MUST be set to `true`.
- [5]: Applies only to instrumentation libraries with profiling capabilities.
Profiling is experimental status.

In addition to Splunk-specific environment variables, the following
[OpenTelemetry environment
Expand Down

0 comments on commit e282185

Please sign in to comment.