Docs
APM Java Agent Reference [1.x] » Configuration
«  Metrics     Core configuration options  »

Configurationedit

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. Central configuration
  2. Java system properties All configuration keys are prefixed with elastic.apm.
  3. Environment variables All configuration keys are in uppercase and prefixed with ELASTIC_APM_
  4. elasticapm.properties file You can place a elasticapm.properties in the same directory the agent jar resides in. To customize the location, set the config_file ( ) option. 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. Central configuration and the elasticapm.properties file are such sources. Java system properties can be dynamic as well by being set from within the application.

In order to get started with Elastic APM, the most important configuration options are service_name, server_urls 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,org.another.example
-Delastic.apm.server_urls=http://localhost:8200

elasticapm.properties.  

service_name=my-cool-service
application_packages=org.example,org.another.example
server_urls=http://localhost:8200

Environment variables.  

ELASTIC_APM_SERVICE_NAME=my-cool-service
ELASTIC_APM_APPLICATION_PACKAGES=org.example,org.another.example
ELASTIC_APM_SERVER_URLS=http://localhost:8200

Option referenceedit

This is a list of all configuration options grouped by their category. Click on a key to get more information.

«  Metrics     Core configuration options  »