:Integrate Elasticsearch

Integrate Elasticsearch

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

2. Click the Elasticsearch card and follow the on-screen instructions to complete the integration. The following tables describe the key parameters.

   Kubernetes cluster

   Parameter	Description
   Elasticsearch host	The following types of Elasticsearch service endpoints are supported: The internal access address of the Elasticsearch service in the cluster. Example: elasticsearch-server.namespace. The internal IP address of the Elasticsearch service. The public IPv4 address of the service.
   Elasticsearch port	The port number of the Elasticsearch service. Example: 9200.
   Elasticsearch username	The username to log on to the Elasticsearch service.
   Elasticsearch password	The password to log on to the Elasticsearch service.
   Scrape interval (seconds)	The interval for collecting monitoring data. The default value is 15.

   ECS (VPC)

   Parameter	Description
   Elasticsearch host	The following types of Elasticsearch service endpoints are supported: The internal access address of the Elasticsearch service. Example: elasticsearch-server.namespace. The internal IP address of the Elasticsearch service. The public IPv4 address of the service.
   Elasticsearch port	The port number of the Elasticsearch service. Example: 9200.
   Elasticsearch username	The username to log on to the Elasticsearch service.
   Elasticsearch password	The password to log on to the Elasticsearch service.
   Scrape interval (seconds)	The interval for collecting monitoring data. The default value is 15.
   Custom Tags	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 custom tags to ECS instance metrics in 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 Elasticsearch status

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

On this tab, you can view the list of targets discovered by the default integration job.

The page provides All and Unhealthy filter tabs. Each target in the list displays its instance name and health status in the (x/x up) format. A red status, such as (0/1 up), indicates an unhealthy target. A black status, such as (1/1 up), indicates a healthy target.

Metric scraping

On this tab, you can view specific metric information and configure metrics to be discarded. For more information, see Configure discarded metrics.

On the Metric Scraping tab, select Custom Scraping in the left-side navigation pane to view a list of your custom scraping jobs. The list includes the Name, Job name, Component, Service discovery method, Scrape path, Scrape interval, and Actions columns. Click Add in the upper-right corner to add a custom scraping job. You can Stop, View Configuration, or Delete each job.

Dashboards

You can click a dashboard name to view the corresponding Grafana dashboard. The top of the Grafana Elasticsearch Overview dashboard provides Interval, cluster, node name, and Source of metrics filters. The KPI area displays metrics such as Cluster health, CPU usage Avg., JVM memory used Avg., nodes, data nodes, and Pending tasks. The shards area displays shard metrics such as Active primary shards, Active shards, Initializing shards, Relocating shards, Delayed shards, and Unassigned shards. If all metrics are "N/A" or show no data, it indicates that monitoring data has not been scraped. The page also contains collapsible panels with detailed metrics, including JVM Garbage Collection, Translog, Breakers, CPU and Memory, Disk and Network, Documents, Thread Pool, Caches, and Segments.

Alert rules

On this tab, you can view Prometheus alerts. To create a Prometheus alert rule, see Create a Prometheus alert rule. By default, an Elasticsearch ECS cluster includes the following five alert rules: ElasticsearchProcessNotRunning, SystemCPUHigh, ElasticsearchClusterNotHealthy, ElasticsearchPoolJVMHigh, and ElasticsearchTooFewNodesRunning. These rules are in the elasticsearch-ECS-Common alert group, have a Default severity level, and a Running state. You can Edit, Stop, Copy, or View alert events for each rule.

Related documents

After integrating the component, configure alert rules for key metrics to monitor their performance and health. This helps you quickly detect and resolve issues. For more information, see Create alert rules for a Prometheus instance.