Halaman ini menjelaskan cara memantau status resource kustom operator Kubernetes AlloyDB Omni menggunakan kube-state-metrics (KSM).
Dengan menjalankan KSM dengan operator Kubernetes, Anda dapat melakukan hal berikut:
- Pantau status resource kustom secara real time di stack observabilitas yang kompatibel dengan Prometheus, bersama dengan metrik AlloyDB Omni.
- Buat dasbor dan pemberitahuan di atas metrik resource kustom untuk visibilitas operasional yang lebih baik dan deteksi masalah secara proaktif.
Untuk 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 Kubernetes AlloyDB Omni
Secara default, metrik resource kustom tidak diaktifkan. Anda dapat mengaktifkan metrik resource kustom menggunakan diagram Helm operator Kubernetes AlloyDB Omni. 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 informasi selengkapnya, lihat
Metrik resource kustom untuk operator Kubernetes AlloyDB Omni.
Sebelum memulai
Pastikan Anda memiliki hal berikut:
- Scraper metrik yang kompatibel dengan Prometheus yang 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 pra-pull image ke registry pribadi. - Pengelola paket
helm
. Anda menjalankan perintah Helm di terminal command line Linux.
Menginstal operator Kubernetes dengan metrik resource kustom yang diaktifkan
Anda menggunakan variabel berikut dalam diagram Helm operator AlloyDB Omni Kubernetes untuk mengontrol penginstalan dan penghapusan metrik resource kustom:
Variabel | Jenis | Deskripsi | Default |
---|---|---|---|
|
Boolean (benar/salah) | Mengaktifkan dan menonaktifkan metrik resource kustom | false (nonaktifkan) |
|
String | Jalur lengkap ksmImage |
|
Jika Anda belum menginstal diagram Helm operator, tetapkan variabel saat Anda menjalankan penginstalan Helm.
Untuk menginstal operator Kubernetes dengan metrik resource kustom yang diaktifkan, ikuti langkah-langkah berikut:
- Buka terminal command line Linux.
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%%/*}"
Download operator AlloyDB Omni Kubernetes:
gcloud storage cp gs://$GCS_BUCKET/$HELM_PATH ./ --recursive
Jika Anda melakukan pra-pull gambar KSM publik di
registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0
ke registry pribadi, 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
Ekspor variabel lingkungan:
export KSM_IMAGE=<full path to your KSM image>
Untuk menginstal operator Kubernetes AlloyDB Omni 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
Bersihkan penginstalan dengan menghapus file penginstalan operator Kubernetes AlloyDB Omni yang didownload. File ini diberi nama
alloydbomni-operator-VERSION_NUMBER.tgz
, dan terletak di direktori kerja saat ini.
Mengaktifkan metrik resource kustom di operator Kubernetes yang ada
Jika 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.
- Buka terminal command line Linux.
Temukan versi operator AlloyDB Omni Kubernetes 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
Output-nya adalah versi operator Kubernetes AlloyDB Omni yang diinstal, misalnya,
1.3.0
.Download operator versi yang ditentukan:
gcloud storage cp gs://$GCS_BUCKET/$HELM_PATH ./ --recursive
Upgrade operator AlloyDB Omni Kubernetes dengan menjalankan perintah berikut, lalu lanjutkan ke langkah terakhir dalam prosedur ini. Jika Anda melakukan pra-pull gambar KSM publik di
registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0
ke registry pribadi, 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
Mengekspor variabel lingkungan:
export KSM_IMAGE=<full path to your KSM image>
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
- Buka terminal command line Linux.
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-"}
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, lihat Melihat metrik menggunakan Prometheus API.