HashiCorp Consul

Questo documento descrive come configurare il deployment di Google Kubernetes Engine in modo da poter utilizzare Google Cloud Managed Service per Prometheus per raccogliere metriche da HashiCorp Consul. Questo documento mostra come eseguire le seguenti operazioni:

  • Configurare Consul per segnalare le metriche.
  • Accedere a una dashboard predefinita in Cloud Monitoring per visualizzare le metriche.

Queste istruzioni si applicano solo se utilizzi la raccolta gestita con Managed Service per Prometheus. Se utilizzi la raccolta con deployment automatico, consulta la documentazione di Consul per informazioni sull'installazione.

Queste istruzioni sono fornite a titolo di esempio e dovrebbero funzionare nella maggior parte degli ambienti Kubernetes. Se hai difficoltà a installare un'applicazione o un esportatore a causa di politiche di sicurezza o organizzative restrittive, ti consigliamo di consultare la documentazione open source per ricevere assistenza.

Per informazioni su HashiCorp Consul, vedi Consul.

Prerequisiti

Per raccogliere le metriche da l'esportatore Consul utilizzando Managed Service per Prometheus e la raccolta gestita, il deployment deve soddisfare i seguenti requisiti:

  • Il cluster deve eseguire Google Kubernetes Engine versione 1.28.15-gke.2475000 o successive.
  • Devi eseguire Managed Service per Prometheus con la raccolta gestita abilitata. Per maggiori informazioni, consulta la guida introduttiva alla raccolta gestita.

  • Per utilizzare le dashboard disponibili in Cloud Monitoring per l'integrazione di Consul, devi utilizzare la versione 1.13.3 o successive.consul

    Per maggiori informazioni sulle dashboard disponibili, vedi Visualizzare le dashboard.

Consul espone le metriche in formato Prometheus quando vengono impostate le opzioni di configurazione della telemetria prometheus_retention_time e disable_hostname. Queste opzioni possono essere impostate montando un configmap in /consul/config/metrics.hcl. HashiCorp consiglia di utilizzare un tempo di conservazione doppio rispetto all'intervallo di raccolta.

Modificare la configurazione di Consul

Modifica la configurazione di Consul come mostrato nell'esempio seguente:

# 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.

kind: StatefulSet
metadata:
  name: consul
spec:
  serviceName: consul
  selector:
    matchLabels:
+     app.kubernetes.io/name: consul
  template:
    metadata:
      labels:
+       app.kubernetes.io/name: consul
    spec:
      containers:
      - name: consul
        image: hashicorp/consul:1.16.0
        ports:
        - containerPort: 8500
          name: consul
          protocol: TCP
+       volumeMounts:
+       - mountPath: /consul/config/metrics.hcl
+         subPath: metrics.hcl
+         name: consul-telemetry
+     volumes:
+     - name: consul-telemetry
+       configMap:
+         name: consul-telemetry
+         items:
+         - key: metrics.hcl
+           path: metrics.hcl

Devi aggiungere alla configurazione tutte le righe precedute dal simbolo +.

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

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le configurazioni.

Per determinare se Consul espone le metriche, esegui il comando seguente: 
  kubectl exec -n NAMESPACE_NAME POD_NAME -- curl -sS localhost:8500/v1/agent/metrics?format=prometheus

Definire una risorsa PodMonitoring

Per l'individuazione dei target, l'operatore Managed Service per Prometheus richiede una risorsa PodMonitoring che corrisponda all'esportatore Consul nello stesso spazio dei nomi.

Puoi utilizzare la seguente configurazione 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: consul
  labels:
    app.kubernetes.io/name: consul
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: 8500
    scheme: http
    interval: 30s
    path: /v1/agent/metrics
    params:
      format:
      - prometheus
  selector:
    matchLabels:
      app.kubernetes.io/name: consul

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

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le configurazioni.

Verificare la configurazione

Puoi utilizzare Metrics Explorer per verificare di aver configurato correttamente l'esportatore Consul. Cloud Monitoring potrebbe richiedere uno o due minuti per importare le metriche.

Per verificare che le metriche siano state importate:

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

    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 del generatore di query, seleziona il pulsante il cui nome è  PromQL.
  3. Inserisci ed esegui la seguente query:
    up{job="consul", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

Visualizzare dashboard

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

Per visualizzare una dashboard installata:

  1. Nella Google Cloud console, 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 Integrazioni.
  4. Fai clic sul nome della dashboard, ad esempio Panoramica di Consul Prometheus.

Per visualizzare un'anteprima statica della dashboard:

  1. Nella Google Cloud console, 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 di HashiCorp Consul e fai clic su Visualizza dettagli.
  4. Seleziona la scheda Dashboard.

Risoluzione dei problemi

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