Apache CouchDB

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 Apache CouchDB. Questo documento mostra come eseguire le seguenti operazioni:

• Configurare l'esportatore per CouchDB in modo che riporti le metriche.
• Accedere a una dashboard predefinita in Cloud Monitoring per visualizzare le metriche.
• Configurare le 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 con deployment autonomo, consulta il repository di origine dell'esportatore CouchDB 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 Apache CouchDB, consulta CouchDB.

Prerequisiti

Per raccogliere metriche da CouchDB 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 CouchDB, devi utilizzare couchdb-prometheus-exporter versione v30.4.3 o successive.

  Per maggiori informazioni sulle dashboard disponibili, consulta Visualizza dashboard.

Installare l'esportatore CouchDB

Ti consigliamo di installare l'esportatore CouchDB, couchdb-prometheus-exporter, come sidecar del carico di lavoro CouchDB. Per informazioni sull'utilizzo dei sidecar, consulta Applicazioni estese su Kubernetes con pod multi-container pods.

Per installare couchdb-prometheus-exporter come sidecar di CouchDB, modifica la configurazione di CouchDB 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.

apiVersion: apps/v1
kind: StatefulSet
metadata:
  name: couchdb
spec:
  serviceName: couchdb
  selector:
    matchLabels:
+     app.kubernetes.io/name: couchdb
  template:
    metadata:
      labels:
+       app.kubernetes.io/name: couchdb
    spec:
      containers:
      - name: couchdb
        image: couchdb:3.2.2
        env:
          - name: COUCHDB_USER
            value: "otelu"
          - name: COUCHDB_PASSWORD
            value: "otelp"
          - name: NODENAME
            valueFrom:
              fieldRef:
                fieldPath: metadata.name
          - name: ERL_FLAGS
            value: "-setcookie otel"
        ports:
        - containerPort: 5984
+     - name: couchdb-exporter
+       image: gesellix/couchdb-prometheus-exporter:v30.4.3
+       args:
+       - --couchdb.uri=http://localhost:5984
+       - --logtostderr
+       env:
+         - name: COUCHDB_USERNAME
+           value: "otelu"
+         - name: COUCHDB_PASSWORD
+           value: "otelp"
+       ports:
+       - containerPort: 9984
+         name: prometheus

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

Aggiorna le variabili di ambiente COUCHDB_USERNAME e COUCHDB_PASSWORD dell'esportatore con quelle dell'utente di monitoraggio.

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

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le configurazioni.

Definire una risorsa PodMonitoring

Per l'individuazione dei target, l'operatore Managed Service per Prometheus richiede una risorsa PodMonitoring che corrisponda all'esportatore CouchDB 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: couchdb
  labels:
    app.kubernetes.io/name: couchdb
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: prometheus
    scheme: http
    interval: 30s
    path: /metrics
    params:
      format:
      - prometheus
  selector:
    matchLabels:
      app.kubernetes.io/name: couchdb

Assicurati che i selettori di etichette e la porta corrispondano ai selettori e alla porta utilizzati in Installare l'esportatore CouchDB.

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

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le configurazioni.

Definire regole e avvisi

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

# 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: couchdb-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: couchdb-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: couchdb
    interval: 30s
    rules:
    - alert: CouchDBHighRequestRate
      annotations:
        description: |-
          CouchDB high request rate
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: CouchDB high request rate (instance {{ $labels.instance }})
      expr: rate(couchdb_httpd_requests[5m]) > 100
      for: 5m
      labels:
        severity: warning
    - alert: CouchDBHighServerErrorRate
      annotations:
        description: |-
          CouchDB high server error rate
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: CouchDB high server error rate (instance {{ $labels.instance }})
      expr: rate(couchdb_httpd_status_codes{code="500"}[5m]) > 0
      for: 5m
      labels:
        severity: warning
    - alert: CouchDBLowRequestRate
      annotations:
        description: |-
          CouchDB low request rate
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: CouchDB low request rate (instance {{ $labels.instance }})
      expr: rate(couchdb_httpd_requests[5m]) < 10
      for: 5m
      labels:
        severity: warning

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

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le configurazioni.

Per maggiori informazioni sull'applicazione delle regole al cluster, consulta Valutazione e avvisi delle regole gestite.

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

Verificare la configurazione

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

Per verificare che le metriche siano state inserite:

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="couchdb", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

Visualizzare le dashboard

L'integrazione di Cloud Monitoring include la dashboard Panoramica di CouchDB 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 CouchDB 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 Apache CouchDB e fai clic su Visualizza dettagli.
4. Seleziona la scheda Dashboard.

Risoluzione dei problemi

Per informazioni sulla risoluzione dei problemi di inserimento delle metriche, consulta Problemi con la raccolta dagli esportatori in Risoluzione dei problemi relativi all'inserimento.