Updated on 2024-10-12 GMT+08:00

Using Cloud Eye to Monitor OpenSearch Clusters

With CSS, you can use Cloud Eye to monitor created clusters. After configuring the cluster monitoring, you can log in to the Cloud Eye management console to view cluster metrics.

The procedure for configuring cluster monitoring:

  1. Creating Alarm Rules: Customize alarm rules for the monitoring metrics. Once a metric exceeds the threshold, the system will notify you by sending emails or HTTP/HTTPS requests.
  2. Configuring Monitoring Metrics: Configure monitoring metrics for a cluster or a node in the cluster.
  3. Viewing Cluster Monitoring Information: View the statistics of the monitoring metrics in specific periods.

Recommended Monitoring Metrics

  • For routine monitoring of a cluster, you are advised to focus on disk usage and cluster health status.
  • Cluster CPU and JVM usage. You are advised to configure the following monitoring metrics: average JVM heap usage, maximum JVM heap usage, average CPU usage, and maximum CPU usage.
  • Cluster write and search latency and throughput. You are advised to configure the following monitoring metrics: average index latency, average index rate, average search latency, and average QPS.
  • Cluster write and query queue and rejected tasks. You are advised to configure the following monitoring metrics: tasks in write queue, tasks in search queue, rejected tasks in write queue, and rejected tasks in search queue.

Prerequisites

  • The cluster is in the Available or Processing status.
  • The cluster has been running properly for more than 10 minutes.

Creating Alarm Rules

  1. Log in to the Cloud Eye console.
  2. In the navigation pane on the left, choose Alarm Management > Alarm Rules.
  3. In the Resource Type column, select Cloud Search Service to filter alarm rules.

    If no alarm rules are available, create one by referring to Creating an Alarm Rule. Table 1 describes the key parameters. For more parameters, customize them as needed.

    Table 1 Alarm rule configuration parameters

    Parameter

    Description

    Alarm Type

    Select Metric.

    Cloud Service

    Select Cloud Search Service.

    Resource Layer

    Select the layer by which you are going to configure alarm rules.

    • CSS Clusters: Alarm rules are specified by cluster.
    • CSS Clusters - CSS Instances: Alarm rules are specified by node in a cluster.

Configuring Monitoring Metrics

  1. Create a monitoring panel by referring to Creating a Dashboard. If an available monitoring panel has been created, skip this step.
  2. Add CSS monitoring graphs by referring to Adding a Graph.

Viewing Cluster Monitoring Information

In the cluster list, check the monitoring information of clusters and cluster nodes.

  1. Log in to the CSS management console.
  2. In the navigation pane on the left, choose Clusters, and click a cluster type to go to the cluster list.
  3. In the cluster list, select a cluster and click View Metric in the Operation column to check the metrics of the cluster and cluster nodes.
    Figure 1 Viewing metrics
    • Click the Instances tab to check cluster metrics.
      • Instances: Select a cluster to check its metrics. The current cluster is selected by default. Multiple clusters can be selected so that you may compare between them.
      • You can also set monitoring periods so that you can compare metrics between different periods for the same cluster.
      • Add Graph Group: You can add a custom group in addition to the default group. When you move the pointer over a group name on the left, the icons for changing the group name and deleting the group are displayed on the right. You can modify the group.
      • Select Metric: In the displayed Select Metric dialog box, set All Metrics and Top N Metrics.
    • Click the CSS Instances tab to check the metrics of cluster nodes. Only the node monitoring information of the first cluster selected on the Instances tab is displayed.
      • CSS Instances: Select the cluster nodes whose metrics and information you want to check. By default, the first node of the current cluster is selected. Multiple nodes can be selected so that you may compare between them.
      • You can also set monitoring periods so that you can compare metrics between different periods for the same cluster.
      • Add Graph Group: You can add a custom group in addition to the default group. When you move the pointer over a group name on the left, the icons for changing the group name and deleting the group are displayed on the right. You can modify the group.
      • Select Metric: In the displayed Select Metric dialog box, set All Metrics.