This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Configure APM agent configuration Configure the Kibana endpoint »

› › › ›

Configure APM instrumentation

edit

Configure APM instrumentation

edit

APM Server uses the Elastic APM Go Agent to instrument its publishing pipeline. To gain insight into the performance of APM Server, you can enable this instrumentation and send trace data to APM Server. Currently, only the Elasticsearch output is instrumented.

Example configuration with instrumentation enabled:

instrumentation:
  enabled: true
  environment: production
  hosts:
    - "http://localhost:8200"
  api_key: L5ER6FEvjkmlfalBealQ3f3fLqf03fazfOV

Configuration options

edit

You can specify the following options in the instrumentation section of the apm-server.yml config file:

enablededit

Set to true to enable instrumentation of APM Server. Defaults to false.

environmentedit

Set the environment in which APM Server is running, for example, staging, production, dev, etc. Environments can be filtered in the Kibana Applications UI.

hostsedit

The APM Server hosts to report instrumentation data to. Defaults to http://localhost:8200.

api_keyedit

API key used to secure communication with the APM Server(s). If api_key is set then secret_token will be ignored.

secret_tokenedit

Secret token used to secure communication with the APM Server(s).

« Configure APM agent configuration Configure the Kibana endpoint »