Esta página descreve como monitorar o status dos recursos personalizados do operador do AlloyDB Omni Kubernetes usando kube-state-metrics (KSM).
A execução do KSM com o operador do Kubernetes permite fazer o seguinte:
- Monitore o status do recurso personalizado em tempo real na sua pilha de observabilidade compatível com o Prometheus, junto com as métricas do AlloyDB Omni.
- Crie painéis e alertas com base nas métricas de recursos personalizados para melhor visibilidade operacional e detecção proativa de problemas.
Para mais informações sobre o kube-state-metrics, consulte Visão geral. Para saber como o kube-state-metrics monitora recursos personalizados do Kubernetes, consulte Métricas de estado de recursos personalizados.
Como funcionam os recursos personalizados do operador AlloyDB Omni no Kubernetes
Por padrão, as métricas de recursos personalizados não estão ativadas. É possível
ativar as métricas de recursos personalizados usando o gráfico do Helm do operador AlloyDB Omni no Kubernetes. Quando você
ativa as métricas de recursos personalizados, uma implantação do KSM é criada com um configmap
que define
as métricas de recursos personalizados e um serviço do tipo ClusterIP para expor o endpoint de métricas
da implantação do KSM. O coletor do
Prometheus
pode coletar as métricas, e você pode visualizá-las com
outras métricas do AlloyDB Omni. Para mais informações, consulte
Métricas de recursos personalizados para o operador AlloyDB Omni Kubernetes.
Antes de começar
Verifique se você tem os recursos a seguir:
- Um extrator de métricas compatível com o Prometheus em execução no cluster do Kubernetes.
- Acesso à imagem kube-state-metrics hospedada em
registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0
. Você pode extrair a imagem para o registro particular. - O gerenciador de pacotes
helm
. Você executa comandos do Helm em um terminal de linha de comando do Linux.
Instalar o operador do Kubernetes com as métricas de recursos personalizadas ativadas
Use as variáveis a seguir no gráfico Helm do operador do AlloyDB Omni Kubernetes para controlar a instalação e a remoção de métricas de recursos personalizados:
Variável | Tipo | Descrição | Padrão |
---|---|---|---|
|
Booleano (verdadeiro/falso) | Ativa e desativa as métricas de recursos personalizados | false (desativado) |
|
String | Caminho completo do ksmImage |
|
Se você ainda não instalou o gráfico do Helm do operador, defina as variáveis ao executar a instalação do Helm.
Para instalar o operador do Kubernetes com as métricas de recursos personalizadas ativadas, siga estas etapas:
- Abra um terminal de linha de comando do Linux.
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%%/*}"
Faça o download do operador AlloyDB Omni no Kubernetes:
gcloud storage cp gs://$GCS_BUCKET/$HELM_PATH ./ --recursive
Se você pré-extrair a imagem pública do KSM em
registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0
para seu registro particular, pule esta etapa e prossiga para a próxima. Caso contrário, instale o operador do AlloyDB Omni Kubernetes com métricas de recursos personalizados e siga para a etapa 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
Exporte a variável de ambiente:
export KSM_IMAGE=<full path to your KSM image>
Para instalar o operador AlloyDB Omni Kubernetes com métricas de recursos personalizados e seu próprio local de 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 retorna a seguinte saída:
NAME: alloydbomni-operator LAST DEPLOYED: CURRENT_TIMESTAMP NAMESPACE: alloydb-omni-system STATUS: deployed REVISION: 1 TEST SUITE: None
Limpe a instalação excluindo o arquivo de instalação do operador AlloyDB Omni Kubernetes. O arquivo é chamado
alloydbomni-operator-VERSION_NUMBER.tgz
e está localizado no diretório de trabalho atual.
Ativar as métricas de recursos personalizados em um operador do Kubernetes
Se você já tiver a versão 1.3.0 (ou mais recente) do operador AlloyDB Omni no Kubernetes instalada, ative as métricas de recursos personalizados atualizando o operador atual.
- Abra um terminal de linha de comando do Linux.
Encontre a versão atual do operador do AlloyDB Omni Kubernetes 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
A saída é a versão instalada do operador AlloyDB Omni no Kubernetes, por exemplo,
1.3.0
.Faça o download do operador de versão especificado:
gcloud storage cp gs://$GCS_BUCKET/$HELM_PATH ./ --recursive
Faça upgrade do operador AlloyDB Omni Kubernetes executando os comandos a seguir e depois vá para a etapa final deste procedimento. Se você pré-extrair a imagem pública do KSM em
registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.14.0
para seu registro particular, pule esta etapa e prossiga diretamente para a próxima.helm upgrade alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \ --namespace alloydb-omni-system \ --reuse-values \ --set crdMetrics.enabled=true \ --atomic \ --timeout 5m
Exporte a variável de ambiente:
export KSM_IMAGE=<full path to your KSM image>
Para fazer o upgrade, 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
Um upgrade bem-sucedido retorna a seguinte saída:
NAME: alloydbomni-operator LAST DEPLOYED: CURRENT_TIMESTAMP NAMESPACE: alloydb-omni-system STATUS: deployed REVISION: 2 TEST SUITE: None
Desativar as métricas de recursos personalizados em um operador do Kubernetes
- Abra um terminal de linha de comando do Linux.
Execute este 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-"}
Para desativar as métricas de recursos personalizados, 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
Conferir métricas usando a API Prometheus
Para conferir suas métricas, consulte Visualizar métricas usando a API Prometheus.
A seguir
- Saiba mais sobre as métricas de definição de recursos personalizados para o operador do AlloyDB Omni Kubernetes.