Apache Zookeeper

Este documento descreve como configurar a sua implementação do Google Kubernetes Engine para que possa usar o Google Cloud Managed Service for Prometheus para recolher métricas do Apache Zookeeper. Este documento mostra como fazer o seguinte:

• Configure o Zookeeper para comunicar métricas.
• Aceda a um painel de controlo no Cloud Monitoring para ver as métricas.
• Configure regras de alerta para monitorizar as métricas.

Estas instruções aplicam-se apenas se estiver a usar a recolha gerida com o serviço gerido para Prometheus. Se estiver a usar a recolha implementada automaticamente, consulte a documentação do Zookeeper para obter informações de instalação.

Estas instruções são fornecidas como exemplo e espera-se que funcionem na maioria dos ambientes do Kubernetes. Se estiver com problemas na instalação de uma aplicação ou de um exportador devido a políticas organizacionais ou de segurança restritivas, recomendamos que consulte a documentação de código aberto para receber apoio técnico.

Para obter informações sobre o Apache Zookeeper, consulte o artigo Zookeeper.

Pré-requisitos

Para recolher métricas do exportador do Zookeeper através do Managed Service for Prometheus e da recolha gerida, a sua implementação tem de cumprir os seguintes requisitos:

• O cluster tem de estar a executar a versão 1.28.15-gke.2475000 ou posterior do Google Kubernetes Engine.
• Tem de estar a executar o Managed Service for Prometheus com a recolha gerida ativada. Para mais informações, consulte o artigo Comece a usar a recolha gerida.

• Para usar os painéis de controlo disponíveis no Cloud Monitoring para a integração do Zookeeper, tem de usar a versão 3.8.0 ou posterior.zookeeper

  Para mais informações acerca dos painéis de controlo disponíveis, consulte o artigo Ver painéis de controlo.

Modifique a configuração do Zookeeper

Modifique a configuração do Zookeeper, conforme mostrado no seguinte exemplo:

# 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: apps/v1
kind: Deployment
metadata:
  name: zookeeper
spec:
  selector:
    matchLabels:
+     app.kubernetes.io/name: zookeeper
  template:
    metadata:
      labels:
+       app.kubernetes.io/name: zookeeper
    spec:
      containers:
      - name: zookeeper
        image: zookeeper:3.8.0
+       env:
+       - name: ZOO_CFG_EXTRA
+         value: "metricsProvider.className=org.apache.zookeeper.metrics.prometheus.PrometheusMetricsProvider metricsProvider.httpPort=7000 metricsProvider.exportJvmInfo=true"
+       ports:
+       - containerPort: 7000
+         name: prometheus

Tem de adicionar todas as linhas precedidas pelo símbolo + à sua configuração.

Para aplicar alterações de configuração a partir de um ficheiro local, execute o seguinte comando:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Também pode usar o Terraform para gerir as suas configurações.

Defina um recurso PodMonitoring

Para a deteção de destinos, o operador do Managed Service for Prometheus requer um recurso PodMonitoring que corresponda ao exportador do Zookeeper no mesmo espaço de nomes.

Pode usar a seguinte configuração 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: zookeeper
  labels:
    app.kubernetes.io/name: zookeeper
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: prometheus
    scheme: http
    interval: 30s
    path: /metrics
  selector:
    matchLabels:
      app.kubernetes.io/name: zookeeper

Para aplicar alterações de configuração a partir de um ficheiro local, execute o seguinte comando:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Também pode usar o Terraform para gerir as suas configurações.

Defina regras e alertas

Pode usar a seguinte configuração Rules para definir alertas nas suas métricas do Zookeeper:

# 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: zookeeper-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: zookeeper-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: zookeeper
    interval: 30s
    rules:
    - alert: ZooKeeperHighAverageLatency
      annotations:
        description: |-
          ZooKeeper high average latency
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: ZooKeeper high average latency (instance {{ $labels.instance }})
      expr: avg_latency > 100
      for: 5m
      labels:
        severity: warning
    - alert: ZooKeeperHighFsyncDuration
      annotations:
        description: |-
          ZooKeeper high fsync duration
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: ZooKeeper high fsync duration (instance {{ $labels.instance }})
      expr: fsynctime_sum > 100
      for: 5m
      labels:
        severity: warning
    - alert: ZooKeeperLowFreeFileDescriptors
      annotations:
        description: |-
          ZooKeeper high fsync duration
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: ZooKeeper high fsync duration (instance {{ $labels.instance }})
      expr: open_file_descriptor_count >= max_file_descriptor_count - 15
      for: 5m
      labels:
        severity: critical

Para aplicar alterações de configuração a partir de um ficheiro local, execute o seguinte comando:

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Também pode usar o Terraform para gerir as suas configurações.

Para mais informações sobre a aplicação de regras ao seu cluster, consulte o artigo Avaliação e alertas de regras geridas.

Valide a configuração

Pode usar o Explorador de métricas para verificar se configurou corretamente o exportador do Zookeeper. O Cloud Monitoring pode demorar um ou dois minutos a carregar as suas métricas.

Para verificar se as métricas são carregadas, faça o seguinte:

1. Na Google Cloud consola, aceda à página leaderboard Explorador de métricas:

   Aceda ao Metrics Explorer

   Se usar a barra de pesquisa para encontrar esta página, selecione o resultado cujo subtítulo é Monitorização.

2. Na barra de ferramentas do painel do criador de consultas, selecione o botão cujo nome é code MQL ou code PromQL.
3. Verifique se a opção PromQL está selecionada no botão Idioma. O botão para alternar o idioma encontra-se na mesma barra de ferramentas que lhe permite formatar a consulta.
4. Introduza e execute a seguinte consulta:
   

   up{job="zookeeper", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

Veja painéis de controlo

A integração do Cloud Monitoring inclui o painel de controlo Vista geral do Zookeeper Prometheus. Os painéis de controlo são instalados automaticamente quando configura a integração. Também pode ver pré-visualizações estáticas de painéis de controlo sem instalar a integração.

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

1. Na Google Cloud consola, aceda à página  Painéis de controlo:

   Aceda a Painéis de controlo

   Se usar a barra de pesquisa para encontrar esta página, selecione o resultado cujo subtítulo é Monitorização.

2. Selecione o separador Lista do painel de controlo.
3. Escolha a categoria Integrações.
4. Clique no nome do painel de controlo, por exemplo, Vista geral do Zookeeper Prometheus.

Para ver uma pré-visualização estática do painel de controlo, faça o seguinte:

1. Na Google Cloud consola, aceda à página  Integrações:

   Aceda a Integrações

   Se usar a barra de pesquisa para encontrar esta página, selecione o resultado cujo subtítulo é Monitorização.

2. Clique no filtro de plataforma de implementação Kubernetes Engine.
3. Localize a integração do Apache Zookeeper e clique em Ver detalhes.
4. Selecione o separador Painéis de controlo.

Resolução de problemas

Para informações sobre a resolução de problemas de carregamento de métricas, consulte a secção Problemas com a recolha de exportadores em Resolução de problemas do lado do carregamento.