Custom resource metrics for the AlloyDB Omni Kubernetes operator

Select a documentation version:

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

customresource_group

The group of the CRD.

alloydbomni.dbadmin.goog

customresource_version

The version of the CRD.

v1

customresource_kind

The kind of the CRD.

DBCluster

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

namespace

The namespace that the DBCluster belongs to.

dbcluster

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

alloydb_omni_dbcluster_ha_ready

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

alloydb_omni_dbcluster_primary_ready

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

alloydb_omni_dbcluster_status_info

The current status of the DBCluster.
  • phase: the phase of the DBCluster.
  • database_version: the current running version of the AlloyDB Omni image, for example, 15.7.0.
  • controlplane_agents_version: the current running version of the control plane agents image, for example, 1.3.0.
  • read_write_endpoint: the read-write endpoint of the DBCluster.
  • read_only_endpoint: the read-only endpoint of the DBCluster.
  • primary_phase: the phase of the DBCluster primary node.
  • haready_status: HAReady condition status, True or False.
  • haready_reason: the reason for the HAReady condition.
 1 Info

alloydb_omni_dbcluster_spec_info

DBCluster configuration under the spec field of the DBCluster manifest.
  • num_standbys:the number of standby nodes configured.
  • database_version: the version of the AlloyDB Omni image configured, for example, 15.7.0.
  • controlplane_agents_version: the version of the control plane agents image configured, for example, 1.3.0.
  • is_deleted: indicates whether this DBCluster is marked for deletion, set to true or false.
  • allow_external_incoming_traffic: indicates whether this DBCluster is configured to allow traffic from out of the Kubernetes cluster, true or false.
 1 Info

alloydb_omni_dbcluster_spec_num_standbys

The number of standbys defined in the DBCluster spec. N/A 1 Gauge

alloydb_omni_dbcluster_critical_incident_info

Critical incident entries under the DBCluster manifest status.criticalIncidents section.
  • create_time: The time when the critical incident occurred.
  • message: The error message of the critical incident.
  • code: The error code of the critical incident.
 1 Info

alloydb_omni_dbcluster_critical_incident_create_time

The time when the critical incident occurred, expressed in Unix epoch time format.
  • message: The error message of the critical incident.
  • code: The error code of the critical incident.
 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

namespace

The namespace that the Failover belongs to.

failover

The name of the Failover custom resource.

dbcluster

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

alloydb_omni_failover_start_time

The time when this Failover started, expressed in Unix epoch time format.
  • state: the state of the Failover.
  • phase: the phase of the Failover.
 sec Gauge

alloydb_omni_failover_end_time

The time when the Failover finished, expressed in Unix epoch time format
  • state: the state of the Failover
  • phase: the phase of the Failover
 sec Gauge

alloydb_omni_failover_status_info

The current status of the Failover.
  • start_time: the time when the Failover started.
  • end_time: the time when the Failover finished.
  • new_primary: the name of the primary node after the Failover finished.
  • old_primary: the name of the primary node before the Failover started
  • phase: the phase of the Failover.
  • state: the state 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

namespace

The namespace that the PgBouncer belongs to.

pgbouncer

The name of the PgBouncer custom resource.

dbcluster

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

alloydb_omni_pgbouncer_status_info

The current status of the PgBouncer.
  • endpoint: The endpoint exposed by this PgBouncer. You connect to this endpoint to run queries against the DBCluster that this PgBouncer targets.
  • phase: the phase of the PgBouncer
 1 Info

What's next