Monitoring the state of an OpenSearch cluster and hosts

• Process CPU: Processor core workload generated by the JVM OpenSearch process.
• Memory usage: Use of RAM, in bytes.
• JVM heap percent: Use of JVM heap memory, in percentage
• Disk space usage percent: Use of disk space, in percentage.
• Indexing rate: Number of indexing operations per second.
• Search queries: Number of search queries per second.
• Open file descriptors: Number of open file descriptors.
• Write bytes: Disk write rate, in bytes per second.
• Read bytes: Disk read rate, in bytes per second.
• Write thread pool: Requests for indexing, deleting, or updating documents.
• Write operations: Number of write operations per second.
• Read operations: Number of read operations per second.
• Query time: Time spent to run the queries.
• Thread pool queued: Number of enqueued requests.
• Thread pool rejected: Number of rejected requests.
• Indexing time: Time spent to index the documents.
• Merging time: Time spent to merge the documents.

• Is Alive: Status that shows the host is up and running.
• Requests Total: Total number of host requests.
• Process CPU: Processor core workload generated by the JVM OpenSearch process.
• Memory usage: Use of RAM, in bytes.
• Disk read/write bytes: Speed of disk operations, in bytes per second.
• Disk IOPS: Number of disk operations per second.
• Network packets: Number of packets exchanged over the network, per second.
• Network bytes: Speed of data exchange over the network, in bytes per second.

If you do not have the Yandex Cloud (CLI) command line interface yet, install and initialize it.

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

To find out the state and status of a cluster, get information about it:

yc managed-opensearch cluster get <cluster_name_or_ID>

The health parameter gives the cluster state; the status parameter gives the cluster status.

You can request the cluster name and ID with the list of clusters in the folder.

1. Get an IAM token for API authentication and put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.Get method and send the following request, e.g., via cURL:

   curl \
       --request GET \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --url 'https://mdb.api.cloud.yandex.net/managed-opensearch/v1/clusters/<cluster_ID>'
   

   You can request the cluster ID with the list of clusters in the folder.

3. View the server response to make sure the request was successful.

   The cluster health and status are shown in the health and status parameters, respectively.

1. Get an IAM token for API authentication and put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

3. Use the ClusterService.Get call and send the following request, e.g., via gRPCurl:

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/opensearch/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>"
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.opensearch.v1.ClusterService.Get
   

   You can request the cluster ID with the list of clusters in the folder.

4. View the server response to make sure the request was successful.

   The cluster health and status are shown in the health and status parameters, respectively.