All Products
Search
Document Center

:Monitor an Elasticsearch instance

Last Updated:Dec 16, 2024

Managed Service for Prometheus actively pulls performance data from your Elasticsearch instance based on the specified parameters. This way, you can monitor the instance in real time and flexibly analyze the monitoring data. This topic describes how to monitor a Elasticsearch instance.

Prerequisites

Container cluster

ECS instance

Procedure

  1. Log on to the Managed Service for Prometheus console. In the left-side navigation pane, click Integration Center.

  2. Click ElasticSearch and set the parameters as prompted. The following tables describe the key parameters.

    Container cluster

    Parameter

    Description

    ElasticSearch Host

    The following types of Elasticsearch endpoints are supported:

    • Internal endpoint of the instance in the cluster. Example: elasticsearch-server.namespace.

    • Internal IP address of the cluster where the instance is located.

    • Public IPv4 address of the instance.

    ElasticSearch Port

    The port number of the instance. Example: 9200.

    ElasticSearch User Name

    The username of the instance.

    ElasticSearch Password

    The password of the instance.

    Metric collection interval

    The interval for collecting monitoring data. The default value is 15.

    ECS instance

    Parameter

    Description

    ElasticSearch Host

    The following types of Elasticsearch endpoints are supported:

    • Internal endpoint of the instance in the cluster. Example: elasticsearch-server.namespace.

    • Internal IP address of the cluster where the instance is located.

    • Public IPv4 address of the instance.

    ElasticSearch Port

    The port number of the instance. Example: 9200.

    ElasticSearch User Name

    The username of the instance.

    ElasticSearch Password

    The password of the instance.

    Metric collection interval

    The interval for collecting monitoring data. The default value is 15.

    Custom Labels

    Add tags to the metrics of the ECS instance. Then, you can monitor, manage, query, or analyze the metric data in a fine-grained manner when you use tools such as Grafana. For more information, see Add tags to the metrics of an ECS instance using a VPC.

    Note
    • A tag key cannot contain special characters used in the Prometheus functionality, such as hyphens (-), periods (.), or percent signs (%).

    • Tags must be specified in the key-value format required by Prometheus.

View and manage the monitoring data of the instance

The installed component is displayed on the Integration Management page in the Managed Service for Prometheus console. The Integration Management page consists of the Integrated Environments, Integrated Addons, and Query Dashboards tabs, where you can view information such as targets, metrics, dashboards, and alerts.

Targets

In the Targets section of the Self-Monitoring tab, you can view the list of targets discovered by the default jobs.

61.jpg

Metric Scraping

On the Metric Scraping tab, you can view or discard metrics. For more information, see Discard metrics.

60.jpg

Dashboards

In the Dashboards section of the Component Management tab, you can click a dashboard name to go to Grafana and view more dashboard data.

59.jpg

Alert Rule

In the Alert Rule section of the Component Management tab, you can view the alert rules of the instance. For information about how to create alert rules, see Create an alert rule for a Prometheus instance.

58.jpg

References

You can configure alert rules for the instance to monitor the health status of key metrics in real time. This way, you can discover and handle exceptions in a timely manner. For more information, see Create an alert rule for a Prometheus instance.