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.

• Shards count: Number of index shards.

• Primary shards count: Number of primary index shards.

• Open file descriptors: Number of open file descriptors.

• Indexing rate: Indexing speed (operations per second).

• Search queries: Number of search queries per second.

• Write thread pool: Requests for indexing, deleting, or updating documents.

• Average query time: Average query execution time.

• Average indexing time: Average time spent on document indexing.

• Thread pool queued: Number of enqueued requests.

• Thread pool rejected: Number of rejected requests.

• Merging time: Time spent to merge the documents.

• Under Disk Metrics Details:

  • Disk write latency (percentiles): Disk write time, in percentiles.
  • Disk write bytes: Average and maximum disk write rate.
  • Disk write operations: Average and maximum number of write operations per second.
  • Disk read latency (percentiles): Disk read time, in percentiles.
  • Disk read bytes: Average and maximum disk read rate.
  • Disk read operations: Average and maximum number of read operations per second.
  • Disk write throttler latency (percentiles): Write delay introduced by exceeding disk quota, percentiles.
  • Disk read throttler latency (percentiles): Read delay introduced by exceeding disk quota, percentiles.
  • Disk used quota: Disk operation quota usage.

• 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 yet, install and initialize it.

The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id. If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

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 into 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 into 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.