What does the value of the metric mean

[Z-superuser]

Hello, what does it mean to use the values of the metrics displayed by our exporter. Is this documented?

For example, what does the following metric mean by 0.0? How many values are shown for the cluster to be healthy and how many are unhealthy?

# HELP opensearch_cluster_status Cluster status
# TYPE opensearch_cluster_status gauge
opensearch_cluster_status{cluster="opensearch",} 0.0

[NikonNLG]

It's a good question. I'm not a developer, just boring devops, but I dig a little for you.

So about opensearch_cluster_status:

First, I search in the repo about "cluster_status" and found lines like this:

    private void updateClusterMetrics(@Nullable ClusterHealthResponse chr) {
        if (chr != null) {
            catalog.setClusterGauge("cluster_status", chr.getStatus().value());

in https://github.com/Aiven-Open/prometheus-exporter-plugin-for-opensearch/blob/ce8c426331461c87099c93f5bd86f6b998985dd4/src/main/java/org/compuscene/metrics/prometheus/PrometheusMetricsCollector.java#L113-L115

Next, I go take a look what is ClusterHealthResponse. And I found it in the same file:

import org.opensearch.action.admin.cluster.health.ClusterHealthResponse

So. It looks like Opensearch Java API or something like this. After few minutes of search I found API (sorry about .NET) - https://opensearch-project.github.io/opensearch-net/api/OpenSearch.Client.ClusterHealthResponse.html
with description:

Enum:       ClusterStatus

Fields:

Name:
Green	
Red	
Yellow

So, it's basic ENUM, and 0 in status means Green, 1 is Yellow and 2 is Red

Hope it will help you with digging about other values in OpenSearch metrics.

[Z-superuser]

这是个好问题。我不是开发人员，只是无聊的 devops，但我为你挖掘了一些。

那么 opensearch_cluster_status：

首先，我在 repo 中搜索 “cluster_status” 并找到如下行：

    private void updateClusterMetrics(@Nullable ClusterHealthResponse chr) {
        if (chr != null) {
            catalog.setClusterGauge("cluster_status", chr.getStatus().value());

在

prometheus-exporter-plugin-for-opensearch/src/main/java/org/compuscene/metrics/prometheus/PrometheusMetricsCollector.java

第 113 行至第 115 行 在CE8C426

private void updateClusterMetrics（@nullable ClusterHealthResponse chr) {
如果 （chr ！= null) {
目录。setClusterGauge（“cluster_status”， chr.getStatus（） 的价值());
接下来，我去看看什么是 ClusterHealthResponse。我在同一个文件中找到了它：

import org.opensearch.action.admin.cluster.health.ClusterHealthResponse

所以。它看起来像 Opensearch Java API 或类似的东西。搜索几分钟后，我找到了 API（对 .NET 抱歉）- 带有描述的 https://opensearch-project.github.io/opensearch-net/api/OpenSearch.Client.ClusterHealthResponse.html：

Enum:       ClusterStatus

Fields:

Name:
Green	
Red	
Yellow

所以，它是基本的 ENUM，状态中的 0 表示绿色，1 表示黄色，2 表示红色

希望它能帮助您挖掘 OpenSearch 指标中的其他值。

Ok, thank you for helping me with the question. Thank you for giving me an idea.