Collect monitoring data using legacy collectors

edit

Collect monitoring data using legacy collectors

edit

If you enable the Elastic monitoring features in your cluster, you can optionally collect metrics about Kibana.

Elastic Agent and Metricbeat are the recommended methods for collecting and shipping monitoring data to a monitoring cluster.

If you have previously configured legacy collection methods, you should migrate to using Elastic Agent or Metricbeat collection. Do not use legacy collection alongside other collection methods.

For more information, refer to Collect monitoring data with Elastic Agent and Collect monitoring data with Metricbeat.

The following method involves sending the metrics to the production cluster, which ultimately routes them to the monitoring cluster.

To learn about monitoring in general, see Monitor a cluster.

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

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

    • To update the cluster settings in Kibana:

      1. Open Kibana in your web browser.

        By default, if you are running Kibana locally, go to https://127.0.0.1:5601/.

        If security features are enabled, log in.

      2. Go to the Stack Monitoring page using the global search field. 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.

  2. Verify that monitoring.enabled and monitoring.kibana.collection.enabled are set to true in the kibana.yml file. These are the default values. For more information, see Monitoring settings in Kibana.
  3. Identify where to send monitoring data. Kibana automatically sends metrics to the Elasticsearch cluster specified in the elasticsearch.hosts setting in the kibana.yml file. This property has a default value of https://127.0.0.1:9200.

    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.

    If security features are enabled on the production cluster, use an HTTPS URL such as https://<your_production_cluster>:9200 in this setting.

  4. If security features are enabled on the production cluster:

    1. Verify that there is a valid user ID and password in the elasticsearch.username and elasticsearch.password settings in the kibana.yml file. These values are used when Kibana sends monitoring data to the production cluster.
    2. Configure encryption for traffic between Kibana and Elasticsearch.
  5. Start Kibana.
  6. View the monitoring data in Kibana.