IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Introduction Core configuration options »
Elastic Docs ›

Configuration

edit

Configuration

edit

To adapt the Elastic APM agent to your needs, you can configure it using different configuration sources, which have different naming conventions for the property key. The first configuration sources override the configuration values of over the latter sources.

  1. Java system properties
    All configuration keys are prefixed with elastic.apm.
  2. Environment variables
    All configuration keys are in uppercase and prefixed with ELASTIC_APM_
  3. elasticapm.properties file
    You can place a elasticapm.properties in the same directory the agent jar resides in. No prefix is required for the configuration keys.

Configuration options marked with Dynamic true can be changed at runtime via configuration sources which support dynamic reloading. Java system properties can be set from within the application.

In order to get started with Elastic APM, the most important configuration options are service_name (required), server_url and application_packages. So a minimal version of a configuration might look like this:

System properties.

-Delastic.apm.service_name=my-cool-service
-Delastic.apm.application_packages=org.example
-Delastic.apm.server_url=http://localhost:8300

elasticapm.properties.

service_name=my-cool-service
application_packages=org.example
server_url=http://localhost:8300

Environment variables.

ELASTIC_APM_SERVICE_NAME=my-cool-service
ELASTIC_APM_APPLICATION_PACKAGES=org.example
ELASTIC_APM_SERVER_URL=http://localhost:8300
« Introduction Core configuration options »