OpenSearch cluster and host state monitoring

• Process CPU: Processor core workload generated by the JVM OpenSearch process.
• Memory usage: Use of RAM, in bytes.
• JVM heap percent: Percentage of the JVM heap memory used.
• Disk space usage percent: Percentage of the disk space used.
• 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 requests.
• 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 available.
• 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: Network packet exchange rate, in packets per second.
• Network bytes: Speed of network data exchange, in bytes per second.

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command 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>

You will see the cluster state in the health parameter and the cluster status, in the status parameter.

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

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

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.Get method, e.g., via the following cURL request:

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

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

3. Check the server response to make sure your request was successful.

   You will see the cluster health and status in the health and status parameters, respectively.

1. Get an IAM token for API authentication and put it in an 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 that the repository contents reside in the ~/cloudapi/ directory.

3. Call the ClusterService.Get method, e.g., via the following gRPCurl request:

   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 get the cluster ID with the list of clusters in the folder.

4. Check the server response to make sure your request was successful.

   You will see the cluster health and status in the health and status parameters, respectively.