Core configuration optionsedit

ServiceNameedit

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.

Note

The service name must conform to this regular expression: ^[a-zA-Z0-9 _-]+$. In less regexy terms: Your service name must only contain characters from the ASCII alphabet, numbers, dashes, underscores and spaces. Characters in service name which don’t match regular expression will be replaced by __ symbol.

Environment variable nameIConfiguration key

ELASTIC_APM_SERVICE_NAME

ElasticApm:ServiceName

DefaultType

Name of the entry assembly

String

ServiceVersionedit

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 variable nameIConfiguration key

ELASTIC_APM_SERVICE_VERSION

ElasticApm:ServiceVersion

DefaultType

Informational version of the entry assembly

String

TransactionSampleRateedit

By default, the agent will sample every transaction (e.g. a 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. The agent will still record the overall time and result for unsampled transactions, but no context information, labels, or spans will be recorded.

Note

When parsing the value for this option, the agent doesn’t consider the current culture. It also expects that a period (.) is used to separate the integer and the fraction of a floating-point number.

Environment variable nameIConfiguration key

ELASTIC_APM_TRANSACTION_SAMPLE_RATE

ElasticApm:TransactionSampleRate

DefaultType

1.0

Double