AlloyDB Omni Kubernetes オペレーターのカスタム リソース指標

ドキュメントのバージョンを選択してください。

このページでは、AlloyDB Omni Kubernetes オペレーターのカスタム リソース（CR）指標について説明します。AlloyDB Omni Kubernetes Operator は、kube-state-metrics を使用して、カスタム リソース マニフェストから構築された指標を Prometheus 形式で公開します。

指標タイプは Prometheus 指標タイプの定義に従います。Prometheus Info 指標は、Prometheus Gauge 指標の特殊な種類です。この指標の値は常に 1 で、対応する AlloyDB Omni Kubernetes Operator カスタム リソースに関する重要な情報を伝える複数のラベルが付けられています。

カスタム リソース指標を有効にする方法については、AlloyDB Omni Kubernetes Operator のカスタム リソースをモニタリングするをご覧ください。

カスタム リソース定義（CRD）のメタデータ ラベル

すべてのカスタム リソース指標には、CRD のグループ、バージョン、種類を示す次のラベルが付けられてます。詳細については、Kubernetes API のコンセプトをご覧ください。ラベルの定義と命名は次の表に示します。

Key（キー） 説明 値の例

customresource_group

CRD のグループ。

alloydbomni.dbadmin.goog

customresource_version

CRD のバージョン。

v1

customresource_kind

CRD の種類。

DBCluster

バックアップ指標

バックアップ指標は、Backup リソース マニフェストから公開されます。すべてのバックアップ指標名は alloydb_omni_backup_ で始まります。すべてのバックアップ指標には次のラベルが付けられています。

Key（キー） 値

backup

[metadata, name]

backupplan

[metadata, name]

namespace

[metadata, namespace]

dbcluster

[spec, dbclusterRef]

次の表のラベルは、バックアップ マニフェストに関連するフィールドが存在しない場合、値が空になり、Prometheus 指標名とラベルに基づいて存在しないラベルと同等と見なされます。

指標名 説明 ラベル 単位 型

alloydb_omni_backup_phase

バックアップの現在のステータス（成功、進行中、失敗）

なし

1

StateSet

alloydb_omni_backup_start_time

バックアップの開始時刻の Unix タイムスタンプ

なし

秒

ゲージ

alloydb_omni_backup_end_time

バックアップの終了時刻の Unix タイムスタンプ

なし

秒

ゲージ

alloydb_omni_backup_duration_seconds

バックアップ オペレーションの期間（秒）

なし

秒

ゲージ

alloydb_omni_backup_backup_size

完了したバックアップのサイズ（バイト単位）

なし

バイト

ゲージ

alloydb_omni_backup_spec_info

バックアップの仕様
  • backup_source_role: [spec, backupSourceRole]
  • manual: [spec, manual]
  • backup_type: [spec, physicalBackupSpec, backupType]

1

情報

alloydb_omni_backup_status_info

バックアップのステータス
  • phase: [status, phase]
  • backup_id: [status, physicalBackupStatus, backupID]
  • prior_backup: [status, physicalBackupStatus, priorBackup]
  • backup_type: [status, physicalBackupStatus, backupType]
  • lsn_start: [status, physicalBackupStatus, lsn, start]
  • lsn_stop: [status, physicalBackupStatus, lsn, stop]
  • wal_start: [status, physicalBackupStatus, wal, start]
  • wal_stop: [status, physicalBackupStatus, wal, stop]
  • retain_expire_time: [status, retainExpire_time]

1

情報

alloydb_omni_backup_critical_incident_info

重大なインシデントをバックアップする
  • create_time: [status, criticalIncidents, createTime]
  • message: [status, criticalIncidents, message]
  • code: [status, criticalIncidents, code]

1

情報

alloydb_omni_backup_critical_incident_createtime

Backup critical incident createTime
  • message: [status, criticalIncidents, message]
  • code: [status, criticalIncidents, code]

秒

ゲージ

BackupPlan の指標

BackupPlan 指標は、BackupPlan リソース マニフェストから公開されます。すべての BackupPlan 指標名は alloydb_omni_backupplan_ で始まります。すべての BackupPlan 指標には次のラベルが付けられています。

Key（キー） 値

backupplan

[metadata, name]

namespace

[metadata, namespace]

dbcluster

[spec, dbclusterRef]

次の表のラベルは、BackupPlan マニフェストに関連するフィールドが存在しない場合、値が空になり、Prometheus 指標名とラベルに基づいて存在しないラベルと同等と見なされます。

指標名 説明 ラベル 単位 型

alloydb_omni_backupplan_phase

バックアップ プランの現在のステータス

なし

1

StateSet

alloydb_omni_backupplan_last_backup_time

プランによる最後のスケジュールされたバックアップの UNIX タイムスタンプ

なし

秒

ゲージ

alloydb_omni_backupplan_next_backup_time

プランによる次回スケジュールされているバックアップの UNIX タイムスタンプ

なし

秒

ゲージ

alloydb_omni_backupplan_recovery_window_begin

復元の開始時刻の Unix タイムスタンプ

なし

秒

ゲージ

alloydb_omni_backupplan_recovery_window_end

復元の終了時刻の Unix タイムスタンプ

なし

秒

ゲージ

alloydb_omni_backupplan_spec_info

backupplan の仕様
  • full_schedule: [spec, backupSchedules, full]
  • differential_schedule: [spec, backupSchedules, differential]
  • incremental_schedule: [spec, backupSchedules, incremental]
  • backup_retain_days: [spec, backupRetainDays]
  • backup_source_strategy: [spec, backupSourceStrategy]
  • paused: [spec, paused]

1

情報

alloydb_omni_backupplan_status_info

backupplan のステータス
  • phase: [status, phase]
  • last_backup_time: [status, lastBackupTime]
  • next_backup_time: [status, nextBackupTime]
  • recovery_window_begin: [status, recoveryWindow, begin]
  • recovery_window_end: [status, recoveryWindow, end]

1

情報

alloydb_omni_backupplan_critical_incident_info

Backupplan の重大なインシデント
  • create_time: [status, criticalIncidents, createTime]
  • message: [status, criticalIncidents, message]
  • code: [status, criticalIncidents, code]

1

情報

alloydb_omni_backupplan_critical_incident_createtime

Backupplan の重大なインシデントの createTime
  • message: [status, criticalIncidents, message]
  • code: [status, criticalIncidents, code]

秒

ゲージ

DBCluster 指標

DBCluster 指標は、DBCluster リソース マニフェストから公開されます。すべての DBCluster 指標名は alloydb_omni_dbcluster_ で始まります。すべての DBCluster 指標には次のラベルが付けられています。

Key（キー） 値

namespace

DBCluster が属する名前空間。

dbcluster

DBCluster カスタム リソースの名前。

次の表のラベルの値は空になります。DBCluster マニフェストに関連するフィールドが存在しない場合、これらのラベルは Prometheus 指標名とラベルによって存在しないラベルと同等と見なされます。

指標名 説明 ラベル 単位 タイプ

alloydb_omni_dbcluster_ha_ready

DBCluster の高可用性（HA）の readiness: ha-ready の場合は 1、それ以外の場合は 0. reason: この DBCluster が HA の準備ができている（できていない）理由。 1 ゲージ

alloydb_omni_dbcluster_primary_ready

DBCluster プライマリ ノードの readiness: 準備ができている場合は 1、そうでない場合は 0. reason: この DBCluster のプライマリ ノードの準備ができている（できていない）理由。 1 ゲージ

alloydb_omni_dbcluster_status_info

DBCluster. の現在のステータス
  • phase: DBCluster のフェーズ。
  • database_version: AlloyDB Omni イメージの現在実行中のバージョン（15.7.0 など）。
  • controlplane_agents_version: コントロール プレーン エージェント イメージの現在実行中のバージョン（1.3.0 など）。
  • read_write_endpoint: DBCluster . の読み取り / 書き込みエンドポイント
  • read_only_endpoint: DBCluster の読み取り専用エンドポイント。
  • primary_phase: DBCluster プライマリ ノードのフェーズ。
  • haready_status: HAReady の状態ステータス（True または False.）
  • haready_reason: HAReady 状態の理由。
 1 情報

alloydb_omni_dbcluster_spec_info

DBCluster マニフェストの spec フィールドの DBCluster 構成。
  • num_standbys: 構成されたスタンバイ ノードの数。
  • database_version: 構成された AlloyDB Omni イメージのバージョン（15.7.0 など）。
  • controlplane_agents_version: 構成されたコントロール プレーン エージェント イメージのバージョン（1.3.0 など）。
  • is_deleted: この DBCluster が削除対象かどうかを示します。true または false. に設定します。
  • allow_external_incoming_traffic: この DBCluster が Kubernetes クラスタ外からのトラフィックを許可するように構成されているかどうかを示します（true または false）。
 1 情報

alloydb_omni_dbcluster_spec_num_standbys

DBCluster 仕様で定義されたスタンバイの数。 なし 1 ゲージ

alloydb_omni_dbcluster_critical_incident_info

DBCluster マニフェスト status.criticalIncidents セクションの重大なインシデント エントリ。
  • create_time: 重大なインシデントが発生した時刻。
  • message: 重大なインシデントのエラー メッセージ。
  • code: 重大なインシデントのエラーコード。
 1 情報

alloydb_omni_dbcluster_critical_incident_create_time

重大なインシデントが発生した時刻。Unix エポック時刻形式で表します。
  • message: 重大なインシデントのエラー メッセージ。
  • code: 重大なインシデントのエラーコード。
 秒 ゲージ

フェイルオーバー指標

フェイルオーバー指標は、Failover リソース マニフェストから公開される指標です。すべてのフェイルオーバー指標名は alloydb_omni_failover_ で始まります。すべてのフェイルオーバー指標には、次のラベルが付けられています。

Key（キー） 値

namespace

Failover が属する名前空間。

failover

Failover: カスタム リソースの名前。

dbcluster

フェイルオーバーのターゲットとなる DBCluster カスタム リソースの名前。この値は、Failover の spec.dbclusterRef フィールドと同じです。

次の表のラベルは、フェイルオーバー マニフェストに関連するフィールドが存在しない場合、値が空になり、Prometheus 指標名とラベルに基づいて存在しないラベルと同等と見なされます。

指標名 説明 ラベル 単位 タイプ

alloydb_omni_failover_start_time

この Failover の開始時刻。Unix エポック時間形式で表されます。
  • state: Failover の状態。
  • phase: Failover のフェーズ。
 秒 ゲージ

alloydb_omni_failover_end_time

Failover が終了した時刻。Unix エポック時間形式で表されます。
  • state: Failover の状態
  • phase: Failover のフェーズ
 秒 ゲージ

alloydb_omni_failover_status_info

Failover の現在のステータス。
  • start_time: Failover の開始時刻。
  • end_time: Failover の終了時刻。
  • new_primary: Failover の終了後のプライマリ ノードの名前。
  • old_primary: Failover の開始前のプライマリ ノードの名前
  • phase: Failover のフェーズ。
  • state: Failover の状態。
 1 情報

PgBouncer の指標

PgBouncer 指標は、PgBouncer リソース マニフェストから公開される指標です。PgBouncer の指標名はすべて alloydb_omni_pgbouncer_ で始まります。すべての PgBouncer 指標には次のラベルが付けられています。

Key（キー） 値

namespace

PgBouncer が属する名前空間。

pgbouncer

PgBouncer: カスタム リソースの名前。

dbcluster

この PgBouncer がターゲットとする DBCluster カスタム リソースの名前。この値は、PgBouncer の spec.dbclusterRef フィールドと同じです。

次の表のラベルは、PgBouncer マニフェストに関連するフィールドが存在しない場合、値が空になり、Prometheus 指標名とラベルに基づいて存在しないラベルと同等と見なされます。

指標名 説明 ラベル 単位 タイプ

alloydb_omni_pgbouncer_status_info

PgBouncer の現在のステータス。
  • endpoint: この PgBouncer によって公開されるエンドポイント。このエンドポイントに接続して、この PgBouncer がターゲットとする DBCluster に対してクエリを実行します。
  • phase: PgBouncer のフェーズ
 1 情報

次のステップ