Monitoring Kibana with Metricbeatedit

[beta] This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features. In 6.4 and later, you can use Metricbeat to collect data about Kibana and ship it to the monitoring cluster, rather than routing it through the production cluster as described in Configuring monitoring.

Example monitoring architecture

To learn about monitoring in general, see Monitoring the Elastic Stack.

  1. Enable the collection of monitoring data. Set xpack.monitoring.collection.enabled to true on the production cluster.

    For example, you can use the following APIs to review and change this setting:

    GET _cluster/settings
    
    PUT _cluster/settings
    {
      "persistent": {
        "xpack.monitoring.collection.enabled": true
      }
    }

    For more information, see Monitoring settings in Elasticsearch and Cluster update settings.

  2. Disable the default collection of Kibana monitoring metrics.

    Add the following setting in the Kibana configuration file (kibana.yml):

    xpack.monitoring.kibana.collection.enabled: false

    Leave the xpack.monitoring.enabled set to its default value (true).

    For more information, see Monitoring settings in Kibana.

  3. Install Metricbeat on the same server as Kibana.
  4. Enable the Kibana module in Metricbeat.

    For example, to enable the default configuration in the modules.d directory, run the following command:

    metricbeat modules enable kibana

    For more information, see Specify which modules to run and Kibana module.

  5. Configure the Kibana module in Metricbeat.

    You must specify the following settings in the modules.d/kibana.yml file:

    - module: kibana
      metricsets:
        - stats
      period: 10s
      hosts: ["http://localhost:5601"] 
      xpack.enabled: true

    This setting identifies the host and port number that are used to access Kibana.

    Note

    If you configured Kibana to use encrypted communications, you must access it via HTTPS. For example, https://localhost:5601.

  6. Identify where to send the monitoring data.

    Tip

    In production environments, we strongly recommend using a separate cluster (referred to as the monitoring cluster) to store the data. Using a separate monitoring cluster prevents production cluster outages from impacting your ability to access your monitoring data. It also prevents monitoring activities from impacting the performance of your production cluster.

    For example, specify the Elasticsearch output information in the Metricbeat configuration file (metricbeat.yml):

    output.elasticsearch:
      hosts: ["http://es-mon-1:9200", "http://es-mon2:9200"] 

    In this example, the data is stored on a monitoring cluster with nodes es-mon-1 and es-mon-2.

    Note

    If you configured the monitoring cluster to use encrypted communications, you must access it via HTTPS. For example, https://es-mon-1:9200.

    For more information about these configuration options, see Configure the Elasticsearch output.

  7. Start Kibana.
  8. Start Metricbeat.
  9. View the monitoring data in Kibana.