Environment variables π
The Splunk Distribution of the OpenTelemetry Collector uses both upstream and Splunk-specific environment variables.
Upstream environment variables π
Upstream environment variables are common to all OpenTelemetry implementations, such as OTEL_RESOURCE_ATTRIBUTES
or OTEL_SERVICE_NAME
.
For a detailed list of the upstream environment variables, refer to OpenTelemetry official docs. See more at Environment variable specification .
Splunk-specific environment variables π
Splunk-specific environment variables are listed on the table below:
Name |
Description |
Default config? |
---|---|---|
|
The Splunk access token to authenticate requests |
Yes |
|
The Splunk API URL. For example, https://api.us0.signalfx.com |
Yes |
|
|
No |
|
The path to the Smart Agent bundle. For example, |
Yes |
|
The path to the collectd config directory for the Smart Agent. For example, |
Yes |
|
Destination path of the Collector custom configuration file |
No |
|
Specifies your custom configuration YAML. This is useful in environments where access to the underlying file system is not readily available |
No |
|
By default, the Collector provides a sensitive value-redacting, local config server listening at http://localhost:55554/debug/configz/effective, which is helpful in troubleshooting. To disable it, set |
No |
|
The Splunk HEC authentication token |
Yes |
|
The Splunk HEC endpoint URL. For example, https://ingest.us0.signalfx.com/v1/log |
Yes |
|
The Splunk ingest URL. For example, https://ingest.us0.signalfx.com |
Yes |
|
The network interface the agent receivers listen on. |
Yes |
|
Use it to set the memory limit for the |
No |
|
Total memory in MiB to allocate to the Collector |
No |
|
Your Splunk realm |
No |
|
The Splunk trace endpoint URL. For example, https://ingest.us0.signalfx.com/v2/trace |
Yes |
SPLUNK_*_URL
environment variables are automatically derived from SPLUNK_REALM
. For example, SPLUNK_INGEST_URL
= https://ingest.SPLUNK_REALM.signalfx.com.