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. In descending order of precedence:

  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. file
    You can place a in the same directory the agent jar resides in. To customize the location, set the config_file ( [1.8.0] Added in 1.8.0. ) option. No prefix is required for the configuration keys.

Central configuration overrides all other settings. Java system properties override Environment variables. Environment variables override

Configuration options marked with Dynamic true can be changed at runtime via configuration sources which support dynamic reloading. Central configuration and the 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.



Environment variables.


Option referenceedit

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