Monitoring in a production environment

edit

Monitoring in a production environment

edit

In production, you should send monitoring data to a separate monitoring cluster so that historical data is available even when the nodes you are monitoring are not.

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.

If you have at least a Gold Subscription, using a dedicated monitoring cluster also enables you to monitor multiple clusters from a central location.

To store monitoring data in a separate cluster:

  1. Set up the Elasticsearch cluster you want to use as the monitoring cluster. For example, you might set up a two host cluster with the nodes es-mon-1 and es-mon-2.

    • Ideally the monitoring cluster and the production cluster run on the same Elastic Stack version. However, a monitoring cluster on the latest release of 9.x also works with production clusters that use the same major version. Monitoring clusters that use 9.x also work with production clusters that use the latest release of 8.x.
    • There must be at least one ingest node in the monitoring cluster; it does not need to be a dedicated ingest node.
    1. (Optional) Verify that the collection of monitoring data is disabled on the monitoring cluster. By default, the xpack.monitoring.collection.enabled setting is false.

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

      resp = client.cluster.get_settings()
      print(resp)
      
      resp1 = client.cluster.put_settings(
          persistent={
              "xpack.monitoring.collection.enabled": False
          },
      )
      print(resp1)
      response = client.cluster.get_settings
      puts response
      
      response = client.cluster.put_settings(
        body: {
          persistent: {
            'xpack.monitoring.collection.enabled' => false
          }
        }
      )
      puts response
      const response = await client.cluster.getSettings();
      console.log(response);
      
      const response1 = await client.cluster.putSettings({
        persistent: {
          "xpack.monitoring.collection.enabled": false,
        },
      });
      console.log(response1);
      GET _cluster/settings
      
      PUT _cluster/settings
      {
        "persistent": {
          "xpack.monitoring.collection.enabled": false
        }
      }
    2. If the Elasticsearch security features are enabled on the monitoring cluster, create users that can send and retrieve monitoring data:

      If you plan to use Kibana to view monitoring data, username and password credentials must be valid on both the Kibana server and the monitoring cluster.

      • If you plan to use Elastic Agent, create a user that has the remote_monitoring_collector built-in role and that the monitoring related integration assets have been installed on the remote monitoring cluster.
      • If you plan to use Metricbeat, create a user that has the remote_monitoring_collector built-in role and a user that has the remote_monitoring_agent built-in role. Alternatively, use the remote_monitoring_user built-in user.
      • If you plan to use HTTP exporters to route data through your production cluster, create a user that has the remote_monitoring_agent built-in role.

        For example, the following request creates a remote_monitor user that has the remote_monitoring_agent role:

        resp = client.security.put_user(
            username="remote_monitor",
            password="changeme",
            roles=[
                "remote_monitoring_agent"
            ],
            full_name="Internal Agent For Remote Monitoring",
        )
        print(resp)
        const response = await client.security.putUser({
          username: "remote_monitor",
          password: "changeme",
          roles: ["remote_monitoring_agent"],
          full_name: "Internal Agent For Remote Monitoring",
        });
        console.log(response);
        POST /_security/user/remote_monitor
        {
          "password" : "changeme",
          "roles" : [ "remote_monitoring_agent"],
          "full_name" : "Internal Agent For Remote Monitoring"
        }

        Alternatively, use the remote_monitoring_user built-in user.

  2. Configure your production cluster to collect data and send it to the monitoring cluster:

  3. (Optional) Configure Logstash to collect data and send it to the monitoring cluster.
  4. (Optional) Configure Enterprise Search monitoring.
  5. (Optional) Configure the Beats to collect data and send it to the monitoring cluster. Skip this step for Beats that are managed by Elastic Agent.

  6. (Optional) Configure APM Server monitoring
  7. (Optional) Configure Kibana to collect data and send it to the monitoring cluster:

  8. (Optional) Create a dedicated Kibana instance for monitoring, rather than using a single Kibana instance to access both your production cluster and monitoring cluster.

    If you log in to Kibana using SAML, Kerberos, PKI, OpenID Connect, or token authentication providers, a dedicated Kibana instance is required. The security tokens that are used in these contexts are cluster-specific; therefore you cannot use a single Kibana instance to connect to both production and monitoring clusters.

    1. (Optional) Disable the collection of monitoring data in this Kibana instance. Set the xpack.monitoring.kibana.collection.enabled setting to false in the kibana.yml file. For more information about this setting, see Monitoring settings in Kibana.
  9. Configure Kibana to retrieve and display the monitoring data.