Console HashiCorp

Questo documento descrive come configurare il tuo deployment Google Kubernetes Engine in modo da poter utilizzare Google Cloud Managed Service per Prometheus per raccogliere l'esportatore di Consul. Questo documento illustra come:

  • Configura l'esportatore di Consul 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.

Queste istruzioni sono valide solo se utilizzi raccolta gestita con Managed Service per Prometheus. Se utilizzi una raccolta di cui è stato eseguito il deployment autonomo, controlla Documentazione di Consul per informazioni sull'installazione.

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

Per informazioni su Consul, vedi Consul.

Prerequisiti

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

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

  • Per utilizzare le dashboard disponibili in Cloud Monitoring per Integrazione di Consul, devi usare consul versione 1.13.3 o successiva.

    Per ulteriori informazioni sulle dashboard disponibili, consulta Visualizza dashboard.

Consul espone le metriche in formato Prometheus quando le opzioni di configurazione della telemetria prometheus_retention_time e disable_hostname sono impostati. Queste opzioni possono essere impostate montando una configmap in /consul/config/metrics.hcl. HashiCorp consiglia di utilizzare un tempo di conservazione due volte dell'intervallo di raccolta.

Modifica la configurazione di Consul

Modifica la configurazione di Consul come illustrato di seguito esempio:

# 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 eventuali righe precedute dal simbolo + alla configurazione.

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

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizza Terraform per gestire le configurazioni.

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

Definisci una risorsa PodMonitoring

Per il rilevamento del target, l'operatore Managed Service per Prometheus richiede una risorsa PodMonitoring che corrisponda Esportatore di Console nello stesso spazio dei nomi.

Puoi utilizzare la seguente configurazione di 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 questo comando: 

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizza Terraform per gestire le configurazioni.

Verificare la configurazione

Puoi utilizzare Metrics Explorer per verificare di aver configurato correttamente Esportatore di Console. Potrebbero essere necessari uno o due minuti Cloud Monitoring per importare le tue metriche.

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

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

Visualizza 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 anteprime statiche delle dashboard senza installare e 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 Monitoraggio.

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

Per visualizzare un'anteprima statica della dashboard:

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

    Vai a Integrazioni

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

  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, consulta Problemi con la raccolta dagli esportatori in Risoluzione dei problemi lato importazione.