Monitora le risorse personalizzate dell'operatore Kubernetes AlloyDB Omni

Questa pagina descrive come monitorare lo stato delle risorse personalizzate dell'operatore Kubernetes di AlloyDB Omni utilizzando kube-state-metrics (KSM).

L'esecuzione di KSM con l'operatore Kubernetes ti consente di:

  • Monitora lo stato delle risorse personalizzate in tempo reale nel tuo stack di osservabilità compatibile con Prometheus, insieme alle metriche di AlloyDB Omni.
  • Crea dashboard e avvisi in base alle metriche delle risorse personalizzate per una migliore visibilità operativa e il rilevamento proattivo dei problemi.

Per ulteriori informazioni su kube-state-metrics, consulta la panoramica. Per scoprire in che modo kube-state-metrics monitora le risorse personalizzate di Kubernetes, consulta Metriche relative allo stato delle risorse personalizzate.

Come funzionano le risorse personalizzate dell'operatore Kubernetes AlloyDB Omni

Per impostazione predefinita, le metriche delle risorse personalizzate non sono abilitate. Puoi attivare le metriche delle risorse personalizzate utilizzando il grafico Helm dell'operatore Kubernetes AlloyDB Omni. Quando attivi le metriche delle risorse personalizzate, viene creato un deployment KSM con un configmap che definisce le metriche delle risorse personalizzate e un servizio di tipo ClusterIP per esporre l'endpoint delle metriche del deployment KSM. Il tuo colector Prometheus può raccogliere le metriche, che puoi visualizzare con altre metriche di AlloyDB Omni. Per ulteriori informazioni, consulta Metriche delle risorse personalizzate per l'operatore Kubernetes AlloyDB Omni.

Prima di iniziare

Assicurati di disporre di quanto segue:

  • Uno scraper delle metriche compatibile con Prometheus in esecuzione nel tuo cluster Kubernetes.
  • Accedi all'immagine kube-state-metrics ospitata su registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0. Puoi eseguire il pre-pull dell'immagine nel tuo registry privato.
  • Il gestore dei pacchetti helm. Esegui i comandi Helm in un terminale a riga di comando Linux.

Installa l'operatore Kubernetes con le metriche delle risorse personalizzate abilitate

Nel grafico Helm dell'operatore Kubernetes AlloyDB Omni utilizzi le seguenti variabili per controllare l'installazione e la rimozione delle metriche delle risorse personalizzate:

Variabile Tipo Descrizione Predefinito

crdMetrics.enabled

Booleano (true/false) Attiva e disattiva le metriche delle risorse personalizzate false (disattiva)

crdMetrics.ksmImage

Stringa Percorso completo del file ksmImage

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

Se non hai ancora installato il grafico Helm dell'operatore, imposta le variabili quando esegui l'installazione di Helm.

Per installare l'operatore Kubernetes con le metriche delle risorse personalizzate abilitate, segui questi passaggi:

  1. Apri un terminale a riga di comando Linux.

  2. Definisci le seguenti variabili di ambiente eseguendo i seguenti comandi:

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

  3. Scarica l'operatore AlloyDB Omni Kubernetes:

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

  4. Se prelevi l'immagine KSM pubblica all'indirizzoregistry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 nel tuo registry privato, salta questo passaggio e vai al successivo. In caso contrario, installa l'operatore AlloyDB Omni Kubernetes con le metriche delle risorse personalizzate e poi vai al passaggio finale di questa procedura.

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

  5. Esporta la variabile di ambiente:

    export KSM_IMAGE=<full path to your KSM image>

  6. Per installare l'operatore Kubernetes AlloyDB Omni con le metriche delle risorse personalizzate e la posizione dell'immagine KSM, esegui il seguente comando:

    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

    Un'installazione riuscita restituisce il seguente output:

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

  7. Ripulisci l'installazione eliminando il file di installazione dell'operatore AlloyDB Omni Kubernetes scaricato. Il file si chiama alloydbomni-operator-VERSION_NUMBER.tgz e si trova nella directory di lavoro corrente.

Attivare le metriche delle risorse personalizzate su un operatore Kubernetes esistente

Se hai già installato l'operatore AlloyDB Omni Kubernetes 1.3.0 (o versioni successive), puoi attivare le metriche delle risorse personalizzate eseguendo l'upgrade dell'operatore esistente.

  1. Apri un terminale a riga di comando Linux.

  2. Individua la versione corrente dell'operatore AlloyDB Omni Kubernetes e definisci le variabili di ambiente eseguendo i seguenti comandi:

    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

    L'output è la versione dell'operatore AlloyDB Omni Kubernetes installato, ad esempio 1.3.0.

  3. Scarica l'operatore della versione specificato:

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

  4. Esegui l'upgrade dell'operatore AlloyDB Omni Kubernetes eseguendo i seguenti comandi, quindi vai al passaggio finale di questa procedura. Se prelevi in anteprima l'immagine KSM pubblica all'indirizzo registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 nel tuo registro privato, salta questo passaggio e vai direttamente al passaggio successivo.

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

  5. Esporta la variabile di ambiente:

    export KSM_IMAGE=<full path to your KSM image>

  6. Per eseguire l'upgrade, esegui il seguente comando:

    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

    Un upgrade riuscito restituisce il seguente output:

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

Disattivare le metriche delle risorse personalizzate su un operatore Kubernetes esistente

  1. Apri un terminale a riga di comando Linux.

  2. Esegui questo comando:

    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. Per disattivare le metriche delle risorse personalizzate, esegui il seguente comando:

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

Visualizzare le metriche utilizzando l'API Prometheus

Per visualizzare le metriche, consulta Visualizzare le metriche utilizzando l'API Prometheus.

Passaggi successivi