Neste documento, descrevemos como configurar a implantação do Google Kubernetes Engine para usar o Google Cloud Managed Service para Prometheus a fim de coletar métricas do exportador do Jenkins. Esta página mostra como fazer o seguinte:
- Configurar o exportador do Jenkins para gerar relatórios de métricas.
- Configurar um recurso PodMonitoring para o serviço gerenciado para Prometheus a fim de coletar as métricas exportadas.
- Instalar um painel no Cloud Monitoring para ver as métricas.
- Configure regras de alertas para monitorar as métricas.
Estas instruções se aplicam somente ao usar a coleção gerenciada com o serviço gerenciado para Prometheus. Se você estiver usando a coleção autoimplantada, consulte a documentação do Jenkins para ver informações da instalação.
Estas instruções são um exemplo e devem funcionar na maioria dos ambientes do Kubernetes. Se você estiver com problemas para instalar um aplicativo ou exportador devido a políticas restritivas de segurança ou da organização, recomendamos consultar a documentação de código aberto para receber suporte.
Consulte Jenkins para saber mais.
Pré-requisitos
Para coletar métricas do exportador do Jenkins usando o Managed Service para Prometheus e a coleção gerenciada, a implantação precisa atender aos seguintes requisitos:
- Seu cluster precisa executar a versão 1.21.4-gke.300 ou posterior do Google Kubernetes Engine.
- É necessário executar o Managed Service para Prometheus com a coleta gerenciada ativada. Para mais informações, consulte Começar a usar a coleta gerenciada.
- Para usar os painéis disponíveis no Cloud Monitoring para a
integração do Jenkins, você precisa usar o
jenkins
versão 2.0.11 ou posterior.Para mais informações sobre os painéis disponíveis, consulte Visualizar painéis.
Se você tiver instalado o gráfico do helm da comunidade Jenkins, será possível anexar os plug-ins das métricas e do Prometheus no campo de valores controller.installPlugins
:
controller: installPlugins: - kubernetes:3734.v562b_b_a_627ea_c - workflow-aggregator:590.v6a_d052e5a_a_b_5 - git:4.13.0 - configuration-as-code:1569.vb_72405b_80249 - metrics - prometheus:2.0.11
Outra opção é criar sua própria imagem de contêiner do Jenkins com o seguinte Dockerfile:
FROM jenkins/jenkins:lts RUN jenkins-plugin-cli --plugins prometheus metrics
Para verificar se o exportador do Jenkins está emitindo métricas nos endpoints esperados, faça o seguinte:
Configure o encaminhamento de portas com o seguinte comando:
kubectl -n NAMESPACE_NAME port-forward POD_NAME 8080
Acesse o endpoint
localhost:8080/prometheus
usando o navegador ou o utilitáriocurl
em outra sessão de terminal.
Definir um recurso do PodMonitoring
Para descobrir o destino, o operador do Managed Service para Prometheus requer um recurso PodMonitoring que corresponde ao exportador do Jenkins no mesmo namespace.
É possível usar a seguinte configuração do PodMonitoring:
Verifique se os valores dos camposport
e matchLabels
correspondem aos dos pods do Jenkins que você quer monitorar. Por padrão, as instalações do Helm do Jenkins
incluem um valor port
de http
e um rótulo app.kubernetes.io/name
com o valor jenkins
.
Para aplicar as alterações de configuração de um arquivo local, execute o seguinte comando:
kubectl apply -n NAMESPACE_NAME -f FILE_NAME
Também é possível usar o Terraform para gerenciar as configurações.
Definir regras e alertas
Use a configuração Rules
a seguir para definir
alertas nas suas métricas do Jenkins:
Para aplicar as alterações de configuração de um arquivo local, execute o seguinte comando:
kubectl apply -n NAMESPACE_NAME -f FILE_NAME
Também é possível usar o Terraform para gerenciar as configurações.
Para mais informações sobre como aplicar regras ao cluster, consulte Avaliação e alerta de regras gerenciadas.
É possível ajustar os limites de alertas conforme seu aplicativo.Verificar a configuração
Use o Metrics Explorer para verificar se você configurou corretamente o exportador do Jenkins. Pode levar um ou dois minutos para que o Cloud Monitoring ingira as métricas.
Para verificar se as métricas foram transferidas, faça o seguinte:
-
No Console do Google Cloud, acesse a página do leaderboard Metrics Explorer:
Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.
- Na barra de ferramentas do painel do criador de consultas, selecione o botão code MQL ou code MQL.
- Verifique se PromQL está selecionado na opção de ativar/desativar PromQL. A alternância de idiomas está na mesma barra de ferramentas que permite formatar sua consulta.
- Digite e execute a seguinte consulta:
up{job="jenkins", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}
Ver painéis
A integração com o Cloud Monitoring inclui o painel Visão geral do Jenkins Prometheus. Os painéis são instalados automaticamente ao configurar a integração. Também é possível visualizar visualizações estáticas de painéis sem instalar a integração.
Para ver um painel instalado, faça o seguinte:
-
No console do Google Cloud, acesse a página Painéis:
Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.
- Selecione a guia Lista de painéis.
- Escolha a categoria Integrações.
- Clique no nome do painel, por exemplo, Visão geral do Jenkins Prometheus.
Para acessar uma visualização estática do painel, faça o seguinte:
-
No console do Google Cloud, acesse a página Integrações:
Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.
- Clique no filtro de plataforma de implantação do Kubernetes Engine.
- Localize a integração com o Jenkins e clique em Visualizar detalhes.
- Selecione a guia Painéis.
Solução de problemas
Para resolver problemas de transferências de métricas, consulte Problemas com a coleta de exportadores em Resolver problemas no processamento.