agent-config.md 4.6 KB
Agent Configuration
NOTE: subject to change!
Note: The environment variables/system properties in this document are very likely to change over time. Please check back here when trying out a new version!
Please report any bugs or unexpected behavior you find.
Contents
- SDK Autoconfiguration
- Configuring the agent
- Common instrumentation configuration
- Suppressing specific auto-instrumentation
SDK Autoconfiguration
The SDK's autoconfiguration module is used for basic configuration of the agent. Read the docs to find settings such as configuring export or sampling.
Here are some quick links into those docs for the configuration options for specific portions of the SDK & agent:
- Exporters
- Trace context propagation
- OpenTelemetry Resource and service name
- Batch span processor
- Sampler
- Span limits
- Using SPI to further configure the SDK
Configuring the agent
The agent can consume configuration from one or more of the following sources (ordered from highest to lowest priority):
- system properties
- environment variables
- the configuration file
- the
ConfigPropertySourceSPI
Configuration file
You can provide a path to agent configuration file by setting the corresponding property.
| System property | Environment variable | Description |
|---|---|---|
otel.javaagent.configuration-file |
OTEL_JAVAAGENT_CONFIGURATION_FILE |
Path to valid Java properties file which contains the javaagent configuration. |
Extensions
You can enable extensions by setting the corresponding property.
| System property | Environment variable | Description |
|---|---|---|
otel.javaagent.extensions |
OTEL_JAVAAGENT_EXTENSIONS |
Path to a an extension jar file or folder, containing jar files. If pointing to a folder, every jar file in that folder will be treated as separate, independent extension |
Common instrumentation configuration
See common instrumentation configuration properties.