To adapt the Elastic APM Go agent to your needs, you can configure it using one of the following three methods, in descending order of precedence:
-
{apm-app-ref}/agent-configuration.html[APM Agent Configuration via Kibana] (supported options are marked with
) -
In code, using the Tracer Config API
-
Environment variables
Configuration defined via Kibana will take precedence over the same configuration defined in code, which takes precedence over environment variables. If configuration is defined via Kibana, and then that is later removed, the agent will revert to configuration defined locally via either the Tracer Config API or environment variables.
To simplify development and testing,
the agent defaults to sending data to the Elastic APM Server at http://localhost:8200.
To send data to an alternative location, you must configure
ELASTIC_APM_SERVER_URL. Depending on the configuration
of your server, you may also need to set ELASTIC_APM_API_KEY,
ELASTIC_APM_SECRET_TOKEN, and
ELASTIC_APM_VERIFY_SERVER_CERT. All other variables
have usable defaults.
Configuration options marked with the 
badge can be changed at runtime
when set from a supported source.
The Go Agent supports {apm-app-ref}/agent-configuration.html[Central configuration],
which allows you to fine-tune certain configurations via the APM app.
This feature is enabled in the Agent by default, with ELASTIC_APM_CENTRAL_CONFIG.
Some options require a unit, either duration or size. These need to be provided in a specific format.
The duration format is used for options like timeouts. The unit is provided as a suffix directly after the number, without any whitespace.
Example: 5ms
Supported units:
-
ms(milliseconds) -
s(seconds) -
m(minutes)
The size format is used for options such as maximum buffer sizes. The unit is provided as a suffix directly after the number, without any whitespace.
Example: 10KB
Supported units:
-
B (bytes)
-
KB (kilobytes)
-
MB (megabytes)
-
GB (gigabytes)
|
Note
|
We use the power-of-two sizing convention, e.g. 1KB = 1024B. |
| Environment | Default | Example |
|---|---|---|
|
The URL for your Elastic APM server. The server supports both HTTP and HTTPS.
If you use HTTPS, then you may need to configure your client machines so
that the server certificate can be verified. You can also disable certificate
verification with ELASTIC_APM_VERIFY_SERVER_CERT.
| Environment | Default | Example |
|---|---|---|
|
|
|
The timeout for requests made to your Elastic APM server. When set to zero or a negative value, timeouts will be disabled.
| Environment | Default | Example |
|---|---|---|
|
"A random string" |
This string is used to ensure that only your agents can send data to your APM server. Both the agents and the APM server have to be configured with the same secret token.
|
Warning
|
the secret token is sent as plain-text in every request to the server, so you should also secure your communications using HTTPS. Unless you do so, your secret token could be observed by an attacker. |
| Environment | Default | Example |
|---|---|---|
|
"A base64-encoded string" |
This base64-encoded string is used to ensure that only your agents can send data to your APM server. You must have created the API key using the APM server command line tool. Please see the APM server documentation for details on how to do that.
|
Note
|
This feature is fully supported in the APM Server versions >= 7.6. |
|
Warning
|
the API Key is sent as plain-text in every request to the server, so you should also secure your communications using HTTPS. Unless you do so, your API Key could be observed by an attacker. |
| Environment | Default | Example |
|---|---|---|
|
Executable name |
|
The name of your service/application. This is used to keep all the errors and transactions of your service together and is the primary filter in the Elastic APM user interface.
If you do not specify ELASTIC_APM_SERVICE_NAME, the Go agent will use the
executable name. e.g. if your executable is called "my-app.exe", then your
service will be identified as "my-app".
|
Note
|
The service name must conform to this regular expression: ^[a-zA-Z0-9 _-]+$.
In other words: your service name must only contain characters from the ASCII
alphabet, numbers, dashes, underscores and spaces.
|
| Environment | Default | Example |
|---|---|---|
|
A string indicating the version of the deployed service |
A version string for the currently deployed version of the service.
If you don’t version your deployments, the recommended value for this field is the commit identifier
of the deployed revision, e.g. the output of git rev-parse HEAD.
| Environment | Default | Example |
|---|---|---|
|
|
Optional name used to differentiate between nodes in a service. Must be unique, otherwise data from multiple nodes will be aggregated together.
If you do not specify ELASTIC_APM_SERVICE_NODE_NAME, service nodes will be identified using the container ID if available,
otherwise the host name.
|
Note
|
This feature is fully supported in the APM Server versions >= 7.5. |
| Environment | Default | Example |
|---|---|---|
|
|
The name of the environment this service is deployed in, e.g. "production" or "staging".
Environments allow you to easily filter data on a global level in the APM app. It’s important to be consistent when naming environments across agents. See {apm-app-ref}/filters.html#environment-selector[environment selector] in the APM app for more information.
|
Note
|
This feature is fully supported in the APM app in Kibana versions >= 7.2. You must use the query bar to filter for a specific environment in versions prior to 7.2. |
| Environment | Default | Example |
|---|---|---|
|
true |
|
Enable or disable the agent. If set to false, then the Go agent does not send any data to the Elastic APM server, and instrumentation overhead is minimized.
| Environment | Default | Example |
|---|---|---|
|
true |
|
Enable or disable recording of events. If set to false, then the Go agent does send any events to the Elastic APM server, and instrumentation overhead is minimized, but the agent will continue to poll the server for configuration changes.
| Environment | Default | Example |
|---|---|---|
|
|
Labels added to all events, with the format key=value[,key=value[,…]]. Any labels set by application via the API will override global labels with the same keys.
This option requires APM Server 7.2 or greater, and will have no effect when using older server versions.
| Environment | Default | Example |
|---|---|---|
|
|
A list of patterns to match HTTP requests to ignore. An incoming HTTP request whose request line matches any of the patterns will not be reported as a transaction.
This option supports the wildcard , which matches zero or more characters.
Examples: /foo//bar//baz, foo. Matching is case insensitive by default.
Prefixing a pattern with (?-i) makes the matching case sensitive.
|
Note
|
this configuration was previously known as ELASTIC_APM_IGNORE_URLS, which has been deprecated and will be removed in a future major
version of the agent.
|
| Environment | Default | Example |
|---|---|---|
|
|
|
A list of patterns to match the names of HTTP headers, cookies, and POST form fields to redact.
This option supports the wildcard , which matches zero or more characters.
Examples: /foo//bar//baz, foo. Matching is case insensitive by default.
Prefixing a pattern with (?-i) makes the matching case sensitive.
| Environment | Default |
|---|---|
|
|
For transactions that are HTTP requests, the Go agent can optionally capture request and response headers.
Possible values: true, false.
Captured headers are subject to sanitization, per ELASTIC_APM_SANITIZE_FIELD_NAMES.
| Environment | Default |
|---|---|
|
|
For transactions that are HTTP requests, the Go agent can optionally capture the request body.
Possible values: errors, transactions, all, off.
|
Warning
|
request bodies often contain sensitive values like passwords, credit card numbers, etc. If your service handles data like this, enable this feature with care. |
| Environment | Default | Example |
|---|---|---|
|
|
|
The host name to use when sending error and transaction data to the APM server.
| Environment | Default |
|---|---|
|
|
Amount of time to wait before ending a request to the Elastic APM server. When you report transactions, spans and errors, the agent will initiate a request and send them to the server when there is enough data to send; the request will remain open until this time has been exceeded, or until the maximum request size has been reached.
| Environment | Default | Minimum | Maximum |
|---|---|---|---|
|
|
|
|
The maximum size of request bodies to send to the Elastic APM server. The agent will maintain an in-memory buffer of compressed data for streaming to the APM server.
| Environment | Default | Minimum | Maximum |
|---|---|---|---|
|
|
|
|
The maximum number of bytes of uncompressed, encoded events to store in memory while the agent is busy. When the agent is able to, it will transfer buffered data to the request buffer, and start streaming it to the server. If the buffer fills up, new events will start replacing older ones.
| Environment | Default |
|---|---|
|
|
Limits the amount of spans that are recorded per transaction.
This is helpful in cases where a transaction creates a large number of spans (e.g. thousands of SQL queries). Setting an upper limit will prevent overloading the agent and the APM server with too much work for such edge cases.
| Environment | Default |
|---|---|
|
|
The APM agent will collect a stack trace for every recorded span whose duration exceeds this configured value. While this is very helpful to find the exact place in your code that causes the span, collecting this stack trace does have some processing and storage overhead.
| Environment | Default |
|---|---|
|
|
Limits the number of frames captured for each stack trace.
Setting the limit to 0 will disable stack trace collection, while any positive integer value will be used as the maximum number of frames to collect. Setting a negative value, such as -1, means that all frames will be collected.
| Environment | Default |
|---|---|
|
|
By default, the agent will sample every transaction (e.g. request to your service).
To reduce overhead and storage requirements, you can set the sample rate to a value
between 0.0 and 1.0. We still record overall time and the result for unsampled
transactions, but no context information, tags, or spans.
| Environment | Default |
|---|---|
|
30s |
The interval at which APM agent gathers and reports metrics. Set to 0s to disable.
| Environment | Default | Example |
|---|---|---|
|
|
Disables the collection of certain metrics. If the name of a metric matches any of the wildcard expressions, it will not be collected.
This option supports the wildcard , which matches zero or more characters.
Examples: /foo//bar//baz, foo. Matching is case insensitive by default.
Prefixing a pattern with (?-i) makes the matching case sensitive.
| Environment | Default |
|---|---|
|
|
Capture breakdown metrics. Set to false to disable.
| Environment | Default |
|---|---|
|
If you have configured your APM Server with a self signed TLS certificate, or you
just wish to pin the server certificate, you can specify the path to the PEM-encoded
certificate via the ELASTIC_APM_SERVER_CERT configuration.
| Environment | Default |
|---|---|
|
|
By default, the agent verifies the server’s certificate if you use an
HTTPS connection to the APM server. Verification can be disabled by
changing this setting to false. This setting is ignored when
ELASTIC_APM_SERVER_CERT is set.
| Environment | Default |
|---|---|
|
ELASTIC_APM_LOG_FILE specifies the output file for the agent’s default, internal
logger. The file will be created, or truncated if it exists, when the process starts.
By default, logging is disabled. You must specify ELASTIC_APM_LOG_FILE to enable
it. This environment variable will be ignored if a logger is configured programatically.
There are two special file names that the agent recognizes: stdout and stderr.
These will configure the logger to write to standard output and standard error
respectively.
| Environment | Default |
|---|---|
|
|
ELASTIC_APM_LOG_LEVEL specifies the log level for the agent’s default, internal
logger. The only two levels used by the logger are "error" and "debug". By default,
logging is disabled. You must specify ELASTIC_APM_LOG_FILE to enable it.
This environment variable will be ignored if a logger is configured programatically.
| Environment | Default |
|---|---|
|
|
Activate APM Agent Configuration via Kibana. By default the agent will poll the server
for agent configuration changes. This can be disabled by changing the setting to false.
|
Note
|
This feature requires APM Server v7.3 or later and that the APM Server is configured with kibana.enabled: true.
|
Environment |
Default |
|
|
To enable {apm-overview-ref-v}/distributed-tracing.html[distributed tracing], the agent
adds trace context headers to outgoing HTTP requests made with [builtin-modules-apmhttp].
These headers (traceparent and tracestate) are defined in the
W3C Trace Context specification.
When this setting is true, the agent will also add the header elastic-apm-traceparent
for backwards compatibility with older versions of Elastic APM agents.