Memantau resource kustom operator AlloyDB Omni Kubernetes

Pilih versi dokumentasi:

Halaman ini menjelaskan cara memantau status resource kustom operator AlloyDB Omni Kubernetes menggunakan kube-state-metrics (KSM).

Menjalankan KSM dengan operator Kubernetes memungkinkan Anda melakukan hal berikut:

  • Memantau status resource kustom secara real time di stack observabilitas yang kompatibel dengan Prometheus, bersama dengan metrik AlloyDB Omni.
  • Membuat dasbor dan pemberitahuan berdasarkan metrik resource kustom untuk visibilitas operasional yang lebih baik dan deteksi masalah proaktif.

Untuk mengetahui informasi selengkapnya tentang kube-state-metrics, lihat Ringkasan. Untuk mempelajari cara kube-state-metrics memantau resource kustom Kubernetes, lihat Metrik Status Resource Kustom.

Cara kerja resource kustom operator AlloyDB Omni Kubernetes

Secara default, metrik resource kustom tidak diaktifkan. Anda dapat mengaktifkan metrik resource kustom menggunakan diagram Helm operator AlloyDB Omni Kubernetes. Saat Anda mengaktifkan metrik resource kustom, deployment KSM akan dibuat dengan configmap yang menentukan metrik resource kustom dan layanan berjenis ClusterIP untuk mengekspos endpoint metrik deployment KSM. Pengumpul Prometheus Anda dapat mengumpulkan metrik, dan Anda dapat memvisualisasikan metrik ini dengan metrik AlloyDB Omni lainnya. Untuk mengetahui informasi selengkapnya, lihat Metrik resource kustom untuk operator AlloyDB Omni Kubernetes.

Sebelum memulai

Pastikan hal-hal berikut:

  • Scraper metrik yang kompatibel dengan Prometheus berjalan di cluster Kubernetes Anda.
  • Akses ke image kube-state-metrics yang dihosting di registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0. Anda dapat melakukan pre-pull image ke registry pribadi Anda.
  • Pengelola paket helm. Anda menjalankan perintah Helm di terminal command line Linux.

Menginstal operator Kubernetes dengan metrik resource kustom diaktifkan

Anda menggunakan variabel berikut dalam diagram Helm operator AlloyDB Omni Kubernetes untuk mengontrol penginstalan dan penghapusan metrik resource kustom:

Variabel Jenis Deskripsi Default

crdMetrics.enabled

Boolean (true/false) Mengaktifkan dan menonaktifkan metrik resource kustom false (nonaktifkan)

crdMetrics.ksmImage

String Jalur lengkap ksmImage

registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0

Jika Anda belum menginstal diagram Helm operator, tetapkan variabel saat Anda menjalankan penginstalan Helm.

Untuk menginstal operator Kubernetes dengan metrik resource kustom diaktifkan, ikuti langkah-langkah berikut:

  1. Buka terminal command line Linux.

  2. Tentukan variabel lingkungan berikut dengan menjalankan perintah berikut:

    export GCS_BUCKET=alloydb-omni-operator
export HELM_PATH=$(gcloud storage cat gs://$GCS_BUCKET/latest)
export OPERATOR_VERSION="${HELM_PATH%%/*}"

  3. Download operator AlloyDB Omni Kubernetes:

    gcloud storage cp gs://$GCS_BUCKET/$HELM_PATH ./ --recursive

  4. Jika Anda melakukan pre-pull image KSM publik di registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 ke registry pribadi Anda, lewati langkah ini dan lanjutkan ke langkah berikutnya. Jika tidak, instal operator AlloyDB Omni Kubernetes dengan metrik resource kustom, lalu lanjutkan ke langkah terakhir dalam prosedur ini.

    helm install alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \
--create-namespace \
--namespace alloydb-omni-system \
--set crdMetrics.enabled=true \
--atomic \
--timeout 5m

  5. Ekspor variabel lingkungan:

    export KSM_IMAGE=<full path to your KSM image>

  6. Untuk menginstal operator AlloyDB Omni Kubernetes dengan metrik resource kustom dan lokasi image KSM Anda sendiri, jalankan perintah berikut:

    helm install alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \
--create-namespace \
--namespace alloydb-omni-system \
--set crdMetrics.enabled=true,crdMetrics.ksmImage=${KSM_IMAGE} \
--atomic \
--timeout 5m

    Penginstalan yang berhasil akan menampilkan output berikut:

    NAME: alloydbomni-operator
LAST DEPLOYED: CURRENT_TIMESTAMP
NAMESPACE: alloydb-omni-system
STATUS: deployed
REVISION: 1
TEST SUITE: None

  7. Bersihkan penginstalan dengan menghapus file penginstalan operator AlloyDB Omni Kubernetes yang didownload. File ini diberi nama alloydbomni-operator-VERSION_NUMBER.tgz, dan terletak di direktori kerja Anda saat ini.

Mengaktifkan metrik resource kustom di operator Kubernetes yang ada

Jika Anda sudah menginstal operator AlloyDB Omni Kubernetes versi 1.3.0 (atau yang lebih baru), Anda dapat mengaktifkan metrik resource kustom dengan mengupgrade operator yang ada.

  1. Buka terminal command line Linux.

  2. Temukan versi operator AlloyDB Omni Kubernetes Anda saat ini dan tentukan variabel lingkungan dengan menjalankan perintah berikut:

    export OPERATOR_VERSION=$(helm ls -n alloydb-omni-system  -o json | jq -r 'map(select(.name == "alloydbomni-operator") | .chart)| .[0]')

OPERATOR_VERSION=${OPERATOR_VERSION#"alloydbomni-operator-"}

echo $OPERATOR_VERSION

export GCS_BUCKET=alloydb-omni-operator

export HELM_PATH=$OPERATOR_VERSION/alloydbomni-operator-$OPERATOR_VERSION.tgz

    Outputnya adalah versi operator AlloyDB Omni Kubernetes yang diinstal, misalnya, 1.3.0.

  3. Download operator versi yang ditentukan:

    gcloud storage cp gs://$GCS_BUCKET/$HELM_PATH ./ --recursive

  4. Upgrade operator AlloyDB Omni Kubernetes dengan menjalankan perintah berikut, lalu buka langkah terakhir dalam prosedur ini. Jika Anda melakukan pre-pull image KSM publik di registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 ke registry pribadi Anda, lewati langkah ini dan lanjutkan langsung ke langkah berikutnya.

    helm upgrade alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \
--namespace alloydb-omni-system \
--reuse-values \
--set crdMetrics.enabled=true \
--atomic \
--timeout 5m

  5. Ekspor variabel lingkungan:

    export KSM_IMAGE=<full path to your KSM image>

  6. Untuk melakukan upgrade, jalankan perintah berikut:

    helm upgrade alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \
--namespace alloydb-omni-system \
--reuse-values \
--set crdMetrics.enabled=true,crdMetrics.ksmImage=${KSM_IMAGE} \
--atomic \
--timeout 5m

    Upgrade yang berhasil akan menampilkan output berikut:

    NAME: alloydbomni-operator
LAST DEPLOYED: CURRENT_TIMESTAMP
NAMESPACE: alloydb-omni-system
STATUS: deployed
REVISION: 2
TEST SUITE: None

Menonaktifkan metrik resource kustom di operator Kubernetes yang ada

  1. Buka terminal command line Linux.

  2. Jalankan perintah berikut:

    export OPERATOR_VERSION=$(helm ls -n alloydb-omni-system  -o json | jq -r 'map(select(.name == "alloydbomni-operator") | .chart)| .[0]')

OPERATOR_VERSION=${OPERATOR_VERSION#"alloydbomni-operator-"}

  3. Untuk menonaktifkan metrik resource kustom, jalankan perintah berikut:

    helm upgrade alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \
--namespace alloydb-omni-system \
--reuse-values \
--set crdMetrics.enabled=false \
--atomic \
--timeout 5m

Melihat metrik menggunakan Prometheus API

Untuk melihat metrik Anda, lihat Melihat metrik menggunakan Prometheus API.

Langkah berikutnya