Apache CouchDB

L'integrazione di Apache CouchDB raccoglie metriche relative al traffico, ad esempio il numero di richieste a un nodo e le risposte del nodo. Raccoglie anche metriche del database, ad esempio il numero di database aperti e il numero di operazioni. L'integrazione raccoglie i log di accesso e generali di CouchDB e li analizza in un payload JSON. Il risultato include i campi per utente, host, livello e messaggio.

Per saperne di più su CouchDB, consulta la documentazione di Apache CouchDB.

Prerequisiti

Per raccogliere i dati di telemetria di CouchDB, devi installare Ops Agent:

• Per le metriche, installa la versione 2.10.0 o successive.
• Per i log, installa la versione 2.11.0 o successive.

Questa integrazione supporta le versioni 2.3.x e 3.1 e successive di CouchDB.

Configura l'istanza CouchDB

Questa integrazione non richiede alcuna configurazione aggiuntiva con le versioni di CouchDB precedenti alla 3.4.0 o sulle distribuzioni basate su Debian.

A partire dalla versione 3.4.0, CouchDB si comporta in modo diverso nelle distribuzioni basate su RPM (come RHEL o Rocky Linux). Per far funzionare CouchDB con la configurazione predefinita di questo ricevitore di logging su questi sistemi, devi configurare Apache CouchDB per scrivere in /var/log/couchdb/couchdb.log anziché in journald.

Per scrivere i log in /var/log/couchdb/couchdb.log, completa i seguenti passaggi:

1. Crea il file /opt/couchdb/etc/local.d/ops-agent-filelog.ini.

2. Aggiungi le seguenti righe al file:

   [log]
   writer = file
   file = /var/log/couchdb/couchdb.log
   level = info
   

3. Riavvia Apache CouchDB:

   sudo systemctl restart couchdb
   

Configura Ops Agent per CouchDB

Segui la guida per configurare Ops Agent, aggiungi gli elementi richiesti per raccogliere i dati di telemetria dalle istanze CouchDB e riavvia l'agente.

Configurazione di esempio

I seguenti comandi creano la configurazione per raccogliere e importare la telemetria per CouchDB:

# Configures Ops Agent to collect telemetry from the app. You must restart the agent for the configuration to take effect.

set -e

# Check if the file exists
if [ ! -f /etc/google-cloud-ops-agent/config.yaml ]; then
  # Create the file if it doesn't exist.
  sudo mkdir -p /etc/google-cloud-ops-agent
  sudo touch /etc/google-cloud-ops-agent/config.yaml
fi

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    couchdb:
      type: couchdb
      username: admin
      password: otelp
      # To use the googlesecretmanager provider to replace plaintext passwords, refer to the example below.
      # password: ${googlesecretmanager:projects/<project-id>/secrets/<secret-id>/versions/<version-id>}
  service:
    pipelines:
      couchdb:
        receivers:
          - couchdb

logging:
  receivers:
    couchdb:
      type: couchdb
  service:
    pipelines:
      couchdb:
        receivers:
          - couchdb
EOF

Per applicare queste modifiche, devi riavviare l'Ops Agent:

Configura la raccolta dei log

Per importare i log da CouchDB, devi creare un ricevitore per i log prodotti da CouchDB e poi creare una pipeline per il nuovo ricevitore.

Per configurare un ricevitore per i log couchdb, specifica i seguenti campi:

Che cosa viene registrato

logName deriva dagli ID destinatario specificati nella configurazione. I campi dettagliati all'interno di LogEntry sono i seguenti.

I log couchdb contengono i seguenti campi in LogEntry:

Configurazione della raccolta di metriche

Per importare le metriche da CouchDB, devi creare un ricevitore per le metriche prodotte da CouchDB e poi creare una pipeline per il nuovo ricevitore.

Questo ricevitore non supporta l'utilizzo di più istanze nella configurazione, ad esempio per monitorare più endpoint. Tutte queste istanze scrivono nella stessa serie temporale e Cloud Monitoring non ha modo di distinguerle.

Per configurare un ricevitore per le metriche couchdb, specifica i seguenti campi:

Che cosa viene monitorato

La seguente tabella fornisce l'elenco delle metriche raccolte da Ops Agent dall'istanza CouchDB.

Verificare la configurazione

Questa sezione descrive come verificare di aver configurato correttamente il ricevitore CouchDB. Potrebbero essere necessari uno o due minuti prima che Ops Agent inizi a raccogliere i dati di telemetria.

Per verificare che i log di CouchDB vengano inviati a Cloud Logging:

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

   Vai a Esplora log

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

2. Inserisci la seguente query nell'editor e poi fai clic su Esegui query:
   

   resource.type="gce_instance"
   log_id("couchdb")
   

Per verificare che le metriche CouchDB vengano inviate a Cloud Monitoring, procedi nel seguente modo:

1. Nella console Google Cloud , vai alla pagina leaderboard 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 Query Builder, seleziona il pulsante il cui nome è code MQL o code PromQL.
3. Verifica che PromQL sia selezionato nel pulsante di attivazione/disattivazione Lingua. Il pulsante di attivazione/disattivazione della lingua si trova nella stessa barra degli strumenti che ti consente di formattare la query.
4. Inserisci la seguente query nell'editor e poi fai clic su Esegui query:
   

   {"workload.googleapis.com/couchdb.database.open", monitored_resource="gce_instance"}
   

Visualizza dashboard

Per visualizzare le metriche di CouchDB, devi configurare un grafico o una dashboard. L'integrazione di CouchDB include uno o più dashboard. Le dashboard vengono installate automaticamente dopo la configurazione dell'integrazione e l'inizio della raccolta dei dati delle metriche da parte di Ops Agent.

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 e poi scegli la categoria Integrazioni.
3. Fai clic sul nome della dashboard che vuoi visualizzare.

Se hai configurato un'integrazione, ma la dashboard non è stata installata, verifica che Ops Agent sia in esecuzione. Se non sono presenti dati delle metriche per un grafico nella dashboard, l'installazione della dashboard non va a buon fine. Dopo che Ops Agent inizia a raccogliere le metriche, la dashboard viene installata per te.

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 Compute Engine della piattaforma di deployment.
3. Individua la voce relativa a CouchDB e fai clic su Visualizza dettagli.
4. Seleziona la scheda Dashboard per visualizzare un'anteprima statica. Se la dashboard è installata, puoi accedervi facendo clic su Visualizza dashboard.

Per ulteriori informazioni sulle dashboard in Cloud Monitoring, consulta Dashboard e grafici.

Per saperne di più sull'utilizzo della pagina Integrazioni, consulta Gestire le integrazioni.

Installare criteri di avviso

I criteri di avviso indicano a Cloud Monitoring di inviarti una notifica quando si verificano le condizioni specificate. L'integrazione di CouchDB include una o più policy di avviso da utilizzare. Puoi visualizzare e installare queste norme di avviso dalla pagina Integrazioni in Monitoring.

Per visualizzare le descrizioni dei criteri di avviso disponibili e installarli, segui questi passaggi:

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. Individua la voce relativa a CouchDB e fai clic su Visualizza dettagli.
3. Seleziona la scheda Avvisi. Questa scheda fornisce descrizioni dei criteri di avviso disponibili e un'interfaccia per installarli.
4. Installa criteri di avviso. I criteri di avviso devono sapere dove inviare le notifiche di attivazione dell'avviso, pertanto richiedono informazioni per l'installazione. Per installare i criteri di avviso:
   1. Dall'elenco dei criteri di avviso disponibili, seleziona quelli che vuoi installare.

   2. Nella sezione Configura le notifiche, seleziona uno o più canali di notifica. Hai la possibilità di disattivare l'utilizzo dei canali di notifica, ma in questo caso i criteri di avviso vengono attivati in modalità silenziosa. Puoi controllare il loro stato in Monitoraggio, ma non ricevi notifiche.

      Per saperne di più sui canali di notifica, consulta l'articolo Gestire i canali di notifica.

   3. Fai clic su Crea policy.

Per ulteriori informazioni sui criteri di avviso in Cloud Monitoring, consulta la pagina Introduzione agli avvisi.

Per saperne di più sull'utilizzo della pagina Integrazioni, consulta Gestire le integrazioni.

Passaggi successivi

Per una procedura dettagliata su come utilizzare Ansible per installare Ops Agent, configurare un'applicazione di terze parti e installare un dashboard di esempio, guarda il video Installare Ops Agent per risolvere i problemi delle applicazioni di terze parti.