Monitoring APM Serveredit

The monitoring features for APM Server require Elasticsearch 6.5 or later.

The Elastic Stack monitoring features enable you to easily monitor APM Server from Kibana. For more information, see Monitoring the Elastic Stack and Beats Monitoring Metrics.

To configure APM Server to collect and send monitoring metrics:

  1. Create a user that has appropriate authority to send system-level monitoring data to Elasticsearch. For example, you can use the built-in apm_system user or assign the built-in apm_system role to another user. For more information, see Setting Up User Authentication and Built-in Roles.
  2. Add the monitoring settings in the APM Server configuration file. If you configured the Elasticsearch output and want to send APM Server monitoring events to the same Elasticsearch cluster, specify the following minimal configuration:

    monitoring:
      enabled: true
      elasticsearch:
        username: apm_system
        password: somepassword

    If you configured a different output, such as Logstash or you want to send APM Server monitoring events to a separate Elasticsearch cluster (referred to as the monitoring cluster), you must specify additional configuration options. For example:

    monitoring:
      enabled: true
      elasticsearch:
        hosts: ["https://example.com:9200", "https://example2.com:9200"] 
        username: apm_system
        password: somepassword

    This setting identifies the hosts and port numbers of Elasticsearch nodes that are part of the monitoring cluster.

  3. Configure monitoring in Kibana.
  4. To verify your monitoring configuration, point your web browser at your Kibana host, and select Monitoring from the side navigation. Metrics reported from APM Server should be visible in the Beats section. When X-Pack security is enabled, to view the monitoring dashboards you must log in to Kibana as a user who has the kibana_user and monitoring_user roles.