Service Instance Metrics
This page describes the metrics used to monitor state of an a9s Search Service Instance. For further information on how to monitor an a9s Service Instance, see the Set up Monitoring section of the Application Developer's documentation.
Metrics
These are the all metrics provided by the a9s Search.
| Metric Id | type | Description |
|---|---|---|
metric_fetch_status | Integer (1 = true / 0 = false) | When the last metric update is successful the result is true. |
cluster_health.active_primary_shards | Integer | The number of active primary shards. documentation |
cluster_health.active_shards | Integer | The total number of active primary and replica shards. documentation |
cluster_health.active_shards_percent_as_number | Float | Percent of shards active documentation |
cluster_health.delayed_unassigned_shards | Integer | The number of shards whose allocation has been delayed by this timeout. documentation |
cluster_health.initializing_shards | Integer | The number of shards that are under initialization. documentation |
cluster_health.number_of_data_nodes | Integer | The number of nodes that are dedicated data nodes. documentation |
cluster_health.number_of_in_flight_fetch | Integer | The number of unfinished fetches. documentation |
cluster_health.number_of_nodes | Integer | The number of nodes within the cluster. documentation |
cluster_health.number_of_pending_tasks | Integer | The number of cluster-level changes that have not yet been executed. documentation |
cluster_health.relocating_shards | Integer | The number of shards that are under relocation. documentation |
cluster_health.status | Integer (0 = green / 1 = yellow / 2 = red / 3 = unknown) | Health status of the cluster, based on the state of its primary and replica shards. documentation |
cluster_health.task_max_waiting_in_queue_millis | Integer | The time expressed in milliseconds since the earliest initiated task is waiting for being performed. documentation |
cluster_health.timed_out | Integer (1 = true / 0 = false / 2 = unknown) | If false the response returned within the period of time that is specified by the timeout parameter (30s by default). documentation |
cluster_health.unassigned_shards | Integer | The number of shards that are not allocated documentation |
discovered_master | Integer (1 = true / 0 = false) | Specifies whether the cluster master is discovered. |
discovered_cluster_manager | Integer (1 = true / 0 = false) | Specifies whether the cluster manager is discovered. |
Metrics
``` *.opensearch.*.*.*.*.metric_fetch_status *.opensearch.*.*.*.*.cluster_health.active_primary_shards *.opensearch.*.*.*.*.cluster_health.active_shards *.opensearch.*.*.*.*.cluster_health.active_shards_percent_as_number *.opensearch.*.*.*.*.cluster_health.delayed_unassigned_shards *.opensearch.*.*.*.*.cluster_health.initializing_shards *.opensearch.*.*.*.*.cluster_health.number_of_data_nodes *.opensearch.*.*.*.*.cluster_health.number_of_in_flight_fetch *.opensearch.*.*.*.*.cluster_health.number_of_nodes *.opensearch.*.*.*.*.cluster_health.number_of_pending_tasks *.opensearch.*.*.*.*.cluster_health.relocating_shards *.opensearch.*.*.*.*.cluster_health.status *.opensearch.*.*.*.*.cluster_health.task_max_waiting_in_queue_millis *.opensearch.*.*.*.*.cluster_health.timed_out *.opensearch.*.*.*.*.cluster_health.unassigned_shards *.opensearch.*.*.*.*.cluster_health.discovered_master *.opensearch.*.*.*.*.cluster_health.discovered_cluster_manager ```