etcd

Questo documento descrive come configurare il deployment di Google Kubernetes Engine in modo da poter utilizzare Google Cloud Managed Service per Prometheus per raccogliere le metriche dall'esportatore etcd. Questo documento illustra come:

  • Configura l'esportazione etcd per generare report sulle metriche.
  • Configura una risorsa PodMonitoring per Managed Service per Prometheus per raccogliere le metriche esportate.
  • Accedi a una dashboard in Cloud Monitoring per visualizzare le metriche.
  • Configura regole di avviso per monitorare le metriche.

Queste istruzioni si applicano solo se utilizzi la raccolta gestita con Managed Service per Prometheus. Se utilizzi la raccolta di cui è stato eseguito il deployment autonomo, consulta la documentazione di etcd per informazioni sull'installazione.

Queste istruzioni sono fornite a titolo di esempio e dovrebbero funzionare nella maggior parte degli ambienti Kubernetes. Se riscontri problemi durante l'installazione di un'applicazione o di un esportatore a causa di norme restrittive di sicurezza o dell'organizzazione, ti consigliamo di consultare la documentazione open source per ricevere assistenza.

Per informazioni su etcd, consulta etcd.

Prerequisiti

Per raccogliere metriche dall'esportatore etcd utilizzando Managed Service per Prometheus e la raccolta gestita, il deployment deve soddisfare i seguenti requisiti:

  • Nel cluster deve essere in esecuzione Google Kubernetes Engine versione 1.21.4-gke.300 o successive.
  • Devi eseguire Managed Service per Prometheus con la raccolta gestita abilitata. Per maggiori informazioni, consulta Iniziare a utilizzare la raccolta gestita.

etcd espone automaticamente le metriche in formato Prometheus; non è necessario installarle separatamente. Per verificare che l'esportatore etcd stia emettendo metriche sugli endpoint previsti, segui questi passaggi:

  1. Configura il port forwarding utilizzando il comando seguente:

    kubectl -n NAMESPACE_NAME port-forward POD_NAME 2379

  2. Accedi all'endpoint localhost:2379/metrics utilizzando il browser o l'utilità curl in un'altra sessione del terminale.

Definisci una risorsa PodMonitoring

Per il rilevamento della destinazione, l'operatore Managed Service per Prometheus richiede una risorsa PodMonitoring che corrisponda all'esportatore etcd nello stesso spazio dei nomi.

Puoi utilizzare la seguente configurazione di PodMonitoring:

# Copyright 2023 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: etcd
  labels:
    app.kubernetes.io/name: etcd
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: 2379
    scheme: http
    interval: 30s
    path: /metrics
  selector:
    matchLabels:
      app.kubernetes.io/name: etcd
Assicurati che i valori dei campi port e matchLabels corrispondano a quelli dei pod etcd che vuoi monitorare. Il deployment di etcd utilizzando questo grafico Helm conterrà l'etichetta app.kubernetes.io/name: etcd e la porta client.

Per applicare le modifiche alla configurazione da un file locale, esegui questo comando: 

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le configurazioni.

Definisci regole e avvisi

Puoi utilizzare la seguente configurazione di Rules per definire gli avvisi sulle metriche etcd:

# Copyright 2023 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: etcd-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: etcd-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: etcd
    interval: 30s
    rules:
    - alert: EtcdLongFsyncDuration
      annotations:
        description: |-
          Etcd long fsync duration
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Etcd long fsync duration (instance {{ $labels.instance }})
      expr: histogram_quantile(0.9, rate(etcd_disk_wal_fsync_duration_seconds_bucket[10m])) > 0.1
      for: 5m
      labels:
        severity: critical
    - alert: EtcdRapidLeaderChanges
      annotations:
        description: |-
          Etcd rapid leader changes
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Etcd rapid leader changes (instance {{ $labels.instance }})
      expr: etcd_server_leader_changes_seen_total >= 0.05
      for: 5m
      labels:
        severity: critical

Per applicare le modifiche alla configurazione da un file locale, esegui questo comando: 

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le configurazioni.

Per saperne di più sull'applicazione di regole al cluster, consulta Valutazione e avvisi delle regole gestite.

Puoi regolare le soglie di avviso in base alla tua applicazione.

Verificare la configurazione

Puoi utilizzare Metrics Explorer per verificare di aver configurato correttamente l'esportatore etcd. L'importazione delle metriche da parte di Cloud Monitoring potrebbe richiedere uno o due minuti.

Per verificare che le metriche siano importate:

  1. Nella console Google Cloud, vai alla pagina  Esplora metriche:

    Vai a Esplora metriche

    Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

  2. Nella barra degli strumenti del riquadro di creazione di query, seleziona il pulsante con il nome  MQL o  PromQL.
  3. Verifica che l'opzione PromQL sia selezionata nell'opzione di attivazione/disattivazione Lingua. L'opzione di attivazione/disattivazione della lingua si trova nella stessa barra degli strumenti che ti consente di formattare la query.
  4. Inserisci ed esegui questa query:
    up{job="etcd", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

Visualizza dashboard

L'integrazione di Cloud Monitoring include la dashboard Panoramica di etcd Prometheus. Le dashboard vengono installate automaticamente quando configuri l'integrazione. Puoi anche visualizzare anteprime statiche delle dashboard senza installare l'integrazione.

Per visualizzare una dashboard installata:

  1. Nella console Google Cloud, vai alla pagina Dashboard :

    Vai a Dashboard

    Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

  2. Seleziona la scheda Elenco dashboard.
  3. Scegli la categoria Integrations (Integrazioni).
  4. Fai clic sul nome della dashboard, ad esempio etcd Prometheus Overview.

Per visualizzare un'anteprima statica della dashboard:

  1. Nella console Google Cloud, vai alla pagina  Integrazioni:

    Vai a Integrazioni

    Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

  2. Fai clic sul filtro della piattaforma di deployment Kubernetes Engine.
  3. Individua l'integrazione etcd e fai clic su Visualizza dettagli.
  4. Seleziona la scheda Dashboard.

Risoluzione dei problemi

Per informazioni sulla risoluzione dei problemi di importazione delle metriche, consulta Problemi con la raccolta dagli esportatori in Risoluzione dei problemi lato importazione.