Monitorizar recursos personalizados del operador de AlloyDB Omni de Kubernetes

Selecciona una versión de la documentación:

En esta página se describe cómo monitorizar el estado de los recursos personalizados del operador de Kubernetes de AlloyDB Omni mediante kube-state-metrics (KSM).

Si ejecutas KSM con el operador de Kubernetes, puedes hacer lo siguiente:

  • Monitoriza el estado de los recursos personalizados en tiempo real en tu pila de observabilidad compatible con Prometheus, junto con las métricas de AlloyDB Omni.
  • Crea paneles de control y alertas a partir de las métricas de recursos personalizadas para mejorar la visibilidad operativa y detectar problemas de forma proactiva.

Para obtener más información sobre kube-state-metrics, consulta la descripción general. Para saber cómo monitoriza kube-state-metrics los recursos personalizados de Kubernetes, consulta Métricas de estado de recursos personalizados.

Cómo funcionan los recursos personalizados del operador AlloyDB Omni Kubernetes

De forma predeterminada, las métricas de recursos personalizados no están habilitadas. Puedes habilitar métricas de recursos personalizados con el gráfico de Helm del operador de Kubernetes de AlloyDB Omni. Cuando habilitas las métricas de recursos personalizadas, se crea un despliegue de KSM con un configmap que define las métricas de recursos personalizadas y un servicio de tipo ClusterIP para exponer el endpoint de métricas del despliegue de KSM. Tu recopilador de Prometheus puede recoger las métricas, y puedes visualizarlas junto con otras métricas de AlloyDB Omni. Para obtener más información, consulta Métricas de recursos personalizados del operador de Kubernetes de AlloyDB Omni.

Antes de empezar

Asegúrate de que tienes lo siguiente:

  • Un raspador de métricas compatible con Prometheus que se ejecute en tu clúster de Kubernetes.
  • Acceso a la imagen kube-state-metrics alojada en registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0. Puedes extraer previamente la imagen a tu registro privado.
  • El helmgestor de paquetes. Los comandos de Helm se ejecutan en un terminal de línea de comandos de Linux.

Instalar el operador de Kubernetes con las métricas de recursos personalizados habilitadas

En el gráfico de Helm del operador de Kubernetes de AlloyDB Omni, se usan las siguientes variables para controlar la instalación y la eliminación de métricas de recursos personalizados:

Variable Tipo Descripción Predeterminado

crdMetrics.enabled

Booleano (verdadero o falso) Habilita e inhabilita las métricas de recursos personalizadas. false (inhabilitar)

crdMetrics.ksmImage

Cadena Ruta completa de ksmImage

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

Si aún no has instalado el gráfico Helm del operador, define las variables cuando ejecutes la instalación de Helm.

Para instalar el operador de Kubernetes con las métricas de recursos personalizados habilitadas, sigue estos pasos:

  1. Abre un terminal de línea de comandos de Linux.

  2. Define las siguientes variables de entorno ejecutando los siguientes comandos:

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

  3. Descarga el operador de AlloyDB Omni de Kubernetes:

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

  4. Si pre-extraes la imagen pública de KSM en registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 a tu registro privado, omite este paso y ve al siguiente. De lo contrario, instala el operador AlloyDB Omni Kubernetes con métricas de recursos personalizadas y, a continuación, ve al último paso de este procedimiento.

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

  5. Exporta la variable de entorno:

    export KSM_IMAGE=<full path to your KSM image>

  6. Para instalar el operador de Kubernetes de AlloyDB Omni con métricas de recursos personalizadas y tu propia ubicación de imagen de KSM, ejecuta el siguiente 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

    Si la instalación se realiza correctamente, se mostrará el siguiente resultado:

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

  7. Limpia la instalación eliminando el archivo de instalación del operador de Kubernetes de AlloyDB Omni que has descargado. El archivo se llama alloydbomni-operator-VERSION_NUMBER.tgz y se encuentra en el directorio de trabajo actual.

Habilitar métricas de recursos personalizados en un operador de Kubernetes

Si ya tienes instalada la versión 1.3.0 (o una posterior) del operador AlloyDB Omni Kubernetes, puedes habilitar las métricas de recursos personalizados actualizando el operador.

  1. Abre un terminal de línea de comandos de Linux.

  2. Para encontrar la versión actual del operador AlloyDB Omni Kubernetes y definir las variables de entorno, ejecuta los siguientes comandos:

    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

    El resultado es la versión instalada del operador de AlloyDB Omni de Kubernetes, por ejemplo, 1.3.0.

  3. Descarga el operador de versión especificado:

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

  4. Actualiza el operador AlloyDB Omni Kubernetes ejecutando los siguientes comandos y, a continuación, ve al último paso de este procedimiento. Si has pre-extraído la imagen pública de KSM en registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 a tu registro privado, omite este paso y ve directamente al siguiente.

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

  5. Exporta la variable de entorno:

    export KSM_IMAGE=<full path to your KSM image>

  6. Para realizar la actualización, ejecuta el siguiente 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

    Si la actualización se realiza correctamente, se devuelve el siguiente resultado:

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

Inhabilitar las métricas de recursos personalizados en un operador de Kubernetes

  1. Abre un terminal de línea de comandos de Linux.

  2. Ejecuta el siguiente 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. Para inhabilitar las métricas de recursos personalizados, ejecuta el siguiente comando:

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

Ver métricas con la API de Prometheus

Para ver tus métricas, consulta Ver métricas con la API de Prometheus.

Siguientes pasos