Controlador NGINX de entrada

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 controlador NGINX. Esta página mostra como fazer o seguinte:

• Configurar o controlador NGINX de Entrada 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 NGINX de Ingress para 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.

Para mais informações sobre o NGINX de Entrada, consulte NGINX de Entrada.

Pré-requisitos

Para coletar métricas do controlador NGINX de Entrada usando o serviço gerenciado para Prometheus e a coleção gerenciada, sua 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.

O NGINX de Entrada expõe métricas no formato do Prometheus automaticamente. Não é necessário instalá-lo separadamente. Para verificar se o controlador NGINX de Entrada está expondo métricas, execute o seguinte comando:

  kubectl exec -n NAMESPACE_NAME deploy/ingress-nginx-controller -- curl http://localhost:10254/metrics
  

Definir um recurso do PodMonitoring

Para descobrir o valor desejado, o operador do serviço gerenciado para Prometheus, é necessário um recurso PodMonitoring que corresponde ao exportador do NGINX de Entrada no mesmo namespace.

É possível usar a seguinte configuração do PodMonitoring:

# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: monitoring.googleapis.com/v1
kind: PodMonitoring
metadata:
  name: ingress-nginx
  labels:
    app.kubernetes.io/name: ingress-nginx
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: 10254
    scheme: http
    interval: 30s
    path: /metrics
  selector:
    matchLabels:
      app.kubernetes.io/name: ingress-nginx

Verifique se os valores dos campos port e matchLabels correspondem aos pods do NGINX de Entrada que você quer monitorar. Por padrão, o controlador NGINX de Entrada expõe métricas na porta 10254 e tem o rótulo app.kubernetes.io/name: ingress-nginx.

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 métricas do Nginx:

# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: monitoring.googleapis.com/v1
kind: Rules
metadata:
  name: ingress-nginx-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: ingress-nginx-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: ingress-nginx
    interval: 30s
    rules:
    - alert: NGINXIngressDroppedConnections
      annotations:
        description: |-
          NGINX Ingress dropped connections
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: NGINX Ingress dropped connections (instance {{ $labels.instance }})
      expr: (nginx_ingress_controller_nginx_process_connections_total{state="accepted"} - nginx_ingress_controller_nginx_process_connections_total{state="handled"}) > 0
      for: 5m
      labels:
        severity: critical
    - alert: NGINXIngressHighRequestRate
      annotations:
        description: |-
          NGINX Ingress high request rate
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: NGINX Ingress high request rate (instance {{ $labels.instance }})
      expr: rate(nginx_ingress_controller_requests[5m]) > 100
      for: 5m
      labels:
        severity: warning
    - alert: NGINXIngressLowRequestRate
      annotations:
        description: |-
          NGINX Ingress low request rate
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: NGINX Ingress low request rate (instance {{ $labels.instance }})
      expr: rate(nginx_ingress_controller_requests[5m]) < 10
      for: 5m
      labels:
        severity: warning

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 NGINX de Entrada. 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:

1. No painel de navegação do console do Google Cloud, selecione Monitoramento e  Metrics Explorer:

   Acesse o Metrics explorer

2. Na barra de ferramentas do painel do criador de consultas, selecione o botão  MQL ou  PromQL.
3. Verifique se PromQL está selecionado na opção de ativar/desativar Idioma. A alternância de idiomas está na mesma barra de ferramentas que permite formatar sua consulta.
4. Digite e execute a seguinte consulta:
   

   up{job="ingress-nginx", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

Ver painéis

A integração do Cloud Monitoring inclui o painel Visão geral do NGINX Prometheus de entrada. 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.

Observação: alguns gráficos no painel podem aparecer não preenchidos na configuração inicial porque o Ingress NGINX só exporta métricas como nginx_ingress_controller_requests depois que o recurso Ingress começa a receber solicitações.

Para ver um painel instalado, faça o seguinte:

1. No painel de navegação do console do Google Cloud, selecione Monitoramento e  Painéis:

   Ir para Painéis

2. Selecione a guia Lista de painéis.
3. Escolha a categoria Integrações.
4. Clique no nome do painel, por exemplo, Visão geral do NGINX Prometheus de entrada.

Para acessar uma visualização estática do painel, faça o seguinte:

1. No painel de navegação do console do Google Cloud, selecione Monitoramento e  Integrações:

   Acessar Integrações

2. Clique no filtro de plataforma de implantação do Kubernetes Engine.
3. Localize a integração do controlador do NGINX de entrada e clique em Visualizar detalhes.
4. 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.