Collecting Kibana monitoring data with Metricbeatedit

Warning

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 Collecting monitoring data.

Example monitoring architecture

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

  1. 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.

  2. Start Kibana.
  3. Set the xpack.monitoring.collection.enabled setting to true on each node in the production cluster. By default, it is disabled (false).

    Note

    You can specify this setting in either the elasticsearch.yml on each node or across the cluster as a dynamic cluster setting. If Elasticsearch security features are enabled, you must have monitor cluster privileges to view the cluster settings and manage cluster privileges to change them.

    • In Kibana:

      1. Open Kibana in your web browser.

        If you are running Kibana locally, go to http://localhost:5601/.

        If the Elastic security features are enabled, log in.

      2. In the side navigation, click Monitoring. If data collection is disabled, you are prompted to turn it on.
    • From the Console or command line, 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.

  4. Install Metricbeat on the same server as Kibana.
  5. 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.

  6. 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.

    This setting ensures that Kibana can read the monitoring data successfully. That is to say, it’s stored in the same location and format as monitoring data that is sent by exporters.

  7. If the Elastic security features are enabled, you must also provide a user ID and password so that Metricbeat can collect metrics successfully.

    1. Create a user on the production cluster that has the remote_monitoring_collector built-in role. Alternatively, use the remote_monitoring_user built-in user.

      1. Add the username and password settings to the Kibana module configuration file.

        For example, add the following settings in the modules.d/kibana.yml file:

        - module: kibana
          ...
          username: remote_monitoring_user
          password: YOUR_PASSWORD
  8. If you configured Kibana to use encrypted communications, you must access it via HTTPS. For example, use a hosts setting like https://localhost:5601 in the modules.d/kibana.yml file.
  9. 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.

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

  10. If the Elasticsearch security features are enabled on the monitoring cluster, you must provide a valid user ID and password so that Metricbeat can send metrics successfully.

    1. Create a user on the monitoring cluster that has the remote_monitoring_agent built-in role. Alternatively, use the remote_monitoring_user built-in user.

      1. Add the username and password settings to the Elasticsearch output information in the Metricbeat configuration file (metricbeat.yml):

        output.elasticsearch:
          ...
          username: remote_monitoring_user
          password: YOUR_PASSWORD
  11. If you configured the monitoring cluster to use encrypted communications, you must access it via HTTPS. For example, use a hosts setting like https://es-mon-1:9200 in the metricbeat.yml file.
  12. Start Metricbeat.
  13. View the monitoring data in Kibana.