Monitorize recursos personalizados do operador do Kubernetes do AlloyDB Omni

Selecione uma versão da documentação:

Esta página descreve como monitorizar o estado dos recursos personalizados do operador do Kubernetes do AlloyDB Omni através do kube-state-metrics (KSM).

A execução do KSM com o operador do Kubernetes permite-lhe fazer o seguinte:

  • Monitorize o estado dos recursos personalizados em tempo real na sua pilha de observabilidade compatível com o Prometheus, juntamente com as métricas do AlloyDB Omni.
  • Crie painéis de controlo e alertas com base nas métricas de recursos personalizados para ter uma melhor visibilidade operacional e deteção proativa de problemas.

Para mais informações sobre as métricas de estado do kube, consulte a vista geral. Para saber como o kube-state-metrics monitoriza recursos personalizados do Kubernetes, consulte o artigo Métricas de estado de recursos personalizados.

Como funcionam os recursos personalizados do operador do Kubernetes do AlloyDB Omni

Por predefinição, as métricas de recursos personalizadas não estão ativadas. Pode ativar as métricas de recursos personalizados através do gráfico Helm do operador Kubernetes do AlloyDB Omni. Quando ativa as métricas de recursos personalizados, é criada uma implementação do KSM com um configmap que define as métricas de recursos personalizados e um serviço do tipo ClusterIP para expor o ponto final de métricas da implementação do KSM. O coletor do Prometheus pode recolher as métricas, e pode visualizar estas métricas com outras métricas do AlloyDB Omni. Para mais informações, consulte o artigo Métricas de recursos personalizados para o operador do Kubernetes do AlloyDB Omni.

Antes de começar

Certifique-se de que tem o seguinte:

  • Um analisador de métricas compatível com o Prometheus em execução no seu cluster do Kubernetes.
  • Acesso à imagem kube-state-metrics alojada em registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0. Pode extrair previamente a imagem para o seu registo privado.
  • O helmgestor de pacotes. Executa comandos Helm num terminal de linha de comandos do Linux.

Instale o operador do Kubernetes com as métricas de recursos personalizados ativadas

Use as seguintes variáveis no gráfico Helm do operador Kubernetes do AlloyDB Omni para controlar a instalação e a remoção de métricas de recursos personalizados:

Variável Tipo Descrição Predefinição

crdMetrics.enabled

Booleano (verdadeiro/falso) Ativa e desativa as métricas de recursos personalizados false (desativar)

crdMetrics.ksmImage

String Caminho completo do ksmImage

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

Se ainda não instalou o gráfico Helm do operador, defina as variáveis quando executar a instalação do Helm.

Para instalar o operador do Kubernetes com as métricas de recursos personalizados ativadas, siga estes passos:

  1. Abra um terminal de linha de comandos do Linux.

  2. Defina as seguintes variáveis de ambiente executando os seguintes comandos:

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

  3. Transfira o operador do Kubernetes do AlloyDB Omni:

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

  4. Se pré-extrair a imagem KSM pública em registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 para o seu registo privado, ignore este passo e avance para o passo seguinte. Caso contrário, instale o operador do Kubernetes do AlloyDB Omni com métricas de recursos personalizadas e, em seguida, avance para o passo final deste procedimento.

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

  5. Exporte a variável de ambiente:

    export KSM_IMAGE=<full path to your KSM image>

  6. Para instalar o operador do Kubernetes do AlloyDB Omni com métricas de recursos personalizados e a sua própria localização da imagem do KSM, execute o seguinte 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

    Uma instalação bem-sucedida devolve o seguinte resultado:

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

  7. Limpe a instalação eliminando o ficheiro de instalação do operador do Kubernetes do AlloyDB Omni transferido. O ficheiro chama-se alloydbomni-operator-VERSION_NUMBER.tgz e encontra-se no seu diretório de trabalho atual.

Ative as métricas de recursos personalizados num operador do Kubernetes existente

Se já tiver a versão 1.3.0 (ou posterior) do operador do Kubernetes do AlloyDB Omni instalada, pode ativar as métricas de recursos personalizados atualizando o operador existente.

  1. Abra um terminal de linha de comandos do Linux.

  2. Encontre a versão atual do operador do Kubernetes do AlloyDB Omni e defina as variáveis de ambiente executando os seguintes 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

    O resultado é a versão do operador do Kubernetes do AlloyDB Omni instalada, por exemplo, 1.3.0.

  3. Transfira o operador da versão especificada:

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

  4. Atualize o operador do Kubernetes do AlloyDB Omni executando os seguintes comandos e, em seguida, avance para o passo final deste procedimento. Se pré-extrair a imagem KSM pública em registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0 para o seu registo privado, ignore este passo e avance diretamente para o passo seguinte.

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

  5. Exporte a variável de ambiente:

    export KSM_IMAGE=<full path to your KSM image>

  6. Para fazer a atualização, execute o seguinte 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

    Uma atualização bem-sucedida devolve o seguinte resultado:

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

Desative as métricas de recursos personalizados num operador do Kubernetes existente

  1. Abra um terminal de linha de comandos do Linux.

  2. Execute o seguinte 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 desativar as métricas de recursos personalizadas, execute o seguinte comando:

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

Veja métricas através da API Prometheus

Para ver as suas métricas, consulte o artigo Veja métricas através da API Prometheus.

O que se segue?