This page describes the custom resource (CR) metrics for the AlloyDB Omni Kubernetes operator. The AlloyDB Omni Kubernetes operator exposes metrics constructed from custom resource manifests in a Prometheus format using kube-state-metrics.
Metric types follow the definition of Prometheus metrics types. A Prometheus Info metric is a special kind of Prometheus Gauge metric, which always has a value of 1 and has multiple labels carrying important information about the corresponding AlloyDB Omni Kubernetes operator Custom Resource.
To learn how to enable custom resource metrics, see Monitor AlloyDB Omni Kubernetes operator custom resources.
Custom Resource Definition (CRD) metadata labels
All custom resource metrics have the following labels that mark the group, version, and kind of the CRD. For more information, see Kubernetes API concepts. Label definitions and naming are listed in the following table:
Key | Description | Example Value |
---|---|---|
|
The group of the CRD. |
|
|
The version of the CRD. |
|
|
The kind of the CRD. |
|
DBCluster metrics
DBCluster metrics are exposed from DBCluster
resource manifests. All
DBCluster metric names start with alloydb_omni_dbcluster_
. All DBCluster
metrics have the following labels:
Key | Value |
---|---|
|
The namespace that the DBCluster belongs to. |
|
The name of the DBCluster custom resource. |
The labels in the following table will have an empty value —and are considered equivalent to labels that don't exist per Prometheus metric names and labels— if the relevant field isn't present in the DBCluster manifest.
Metric Name | Description | Label | Unit | Type |
---|---|---|---|---|
|
The high availability (HA) readiness of the `DBCluster`:
1 if ha-ready , otherwise
0. |
reason : The reason why this DBCluster is
(un)ready for HA. |
1 | Gauge |
|
The readiness of the DBCluster primary node:
1 if ready, otherwise 0. |
reason : The reason why this DBCluster 's
primary node is (un)ready. |
1 | Gauge |
|
The current status of the DBCluster. |
|
1 | Info |
|
DBCluster configuration under the spec
field of the DBCluster manifest. |
|
1 | Info |
|
The number of standbys defined in the DBCluster
spec. |
N/A | 1 | Gauge |
|
Critical incident entries under the DBCluster manifest
status.criticalIncidents section. |
|
1 | Info |
|
The time when the critical incident occurred, expressed in Unix epoch time format. |
|
sec | Gauge |
Failover metrics
Failover metrics are metrics exposed from the Failover
resource manifest. All
failover metric names start with alloydb_omni_failover_
. All Failover metrics
have the following labels:
Key | Value |
---|---|
|
The namespace that the Failover belongs to. |
|
The name of the Failover custom resource. |
|
The name of the DBCluster custom resource that the Failover targets.
This value is the same as the spec.dbclusterRef field of
the Failover . |
The labels in the following table will have an empty value —and are considered equivalent to labels that don't exist based on Prometheus metric names and labels— if the relevant field isn't present in the Failover manifest.
Metric name | Description | Label | Unit | Type |
---|---|---|---|---|
|
The time when this Failover started, expressed in
Unix epoch time format. |
|
sec | Gauge |
|
The time when the Failover finished, expressed in Unix epoch time format |
|
sec | Gauge |
|
The current status of the Failover . |
|
1 | Info |
PgBouncer metrics
PgBouncer metrics are metrics that are exposed fromPgBouncer
resource
manifests. All PgBouncer metric names start with alloydb_omni_pgbouncer_
. All
PgBouncer metrics have the following labels:
Key | Value |
---|---|
|
The namespace that the PgBouncer belongs to. |
|
The name of the PgBouncer custom resource. |
|
The name of the DBCluster custom resource that this
PgBouncer targets. This value is the same as the
spec.dbclusterRef field of the
PgBouncer . |
The labels in the following table will have an empty value —and are considered equivalent to labels that don't exist based on Prometheus metric names and labels— if the relevant field isn't present in the PgBouncer manifest..
Metric Name | Description | Label | Unit | Type |
---|---|---|---|---|
|
The current status of the PgBouncer. |
|
1 | Info |