Apache CouchDB

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

Per ulteriori informazioni su CouchDB, consulta la documentazione di Apache CouchDB.

Prerequisiti

Per raccogliere la 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 CouchDB 2.3.x, 3.1 e versioni successive.

Configurare Ops Agent per CouchDB

Segui la guida alla configurazione di Ops Agent, aggiungi gli elementi necessari per raccogliere la 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 e riavviare Ops Agent.

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# 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
  service:
    pipelines:
      couchdb:
        receivers:
          - couchdb

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

sudo service google-cloud-ops-agent restart
sleep 30

Configura la raccolta dei log

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

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

Campo Predefinito Descrizione
exclude_paths Un elenco di pattern di percorsi del file system da escludere dall'insieme corrispondente a include_paths.
include_paths [/var/log/couchdb/couchdb.log] Un elenco di percorsi del file system da leggere tramite il comando tail di ogni file. Nei percorsi è possibile utilizzare un carattere jolly (*), ad esempio /var/log/couchdb*/*.log.
record_log_file_path false Se impostato su true, il percorso del file specifico da cui è stato ottenuto il record del log viene visualizzato nella voce di log di output come valore dell'etichetta agent.googleapis.com/log_file_path. Quando utilizzi un carattere jolly, viene registrato solo il percorso del file da cui è stato ottenuto il record.
type Questo valore deve essere couchdb.
wildcard_refresh_interval 60s L'intervallo di aggiornamento dei percorsi file con caratteri jolly in include_paths. Specificato come durata, ad esempio 30s o 2m. Questa proprietà potrebbe essere utile in caso di flussi di lavoro elevati per la registrazione, in cui i file di log vengono ruotati più velocemente dell'intervallo predefinito.

Che cosa viene registrato nei log

Il logName è ricavato dagli ID dei destinatari specificati nella configurazione. I campi dettagliati all'interno di LogEntry sono i seguenti.

I log couchdb contengono i seguenti campi in LogEntry:

Campo Tipo Descrizione
httpRequest oggetto Leggi HttpRequest
jsonPayload.host string Nome istanza host
jsonPayload.level string Livello di voce di log
jsonPayload.message string Messaggio di log
jsonPayload.node string Nome dell'istanza del nodo
jsonPayload.path string Percorso richiesta
jsonPayload.pid string ID processo
jsonPayload.remote_user string Nome utente autenticato per la richiesta
jsonPayload.status_message string Messaggio del codice di stato
severity stringa (LogSeverity) Livello di voce del log (tradotto).

Configurazione della raccolta di metriche

Per importare le metriche da CouchDB, devi creare un ricevitore per le metriche prodotte da CouchDB e poi 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 destinatario per le metriche couchdb, specifica i seguenti campi:

Campo Predefinito Descrizione
collection_interval 60s Un valore di durata, ad esempio 30s o 5m.
password La password utilizzata per connettersi al server.
server_status_url http://localhost:5984 L'URL esposto da CouchDB.
type Questo valore deve essere couchdb.
username Il nome utente utilizzato per connettersi al server.

Che cosa viene monitorato

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

Tipo di metrica 
Tipo, Tipo
Risorse monitorate		 Etichette
workload.googleapis.com/couchdb.average_request_time
GAUGE, DOUBLE
gce_instance 		 
workload.googleapis.com/couchdb.database.open
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/couchdb.database.operations
CUMULATIVE, INT64
gce_instance 		operation
workload.googleapis.com/couchdb.file_descriptor.open
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/couchdb.httpd.bulk_requests
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/couchdb.httpd.requests
CUMULATIVE, INT64
gce_instance 		http_method
workload.googleapis.com/couchdb.httpd.responses
CUMULATIVE, INT64
gce_instance 		http_status_code
workload.googleapis.com/couchdb.httpd.views
CUMULATIVE, INT64
gce_instance 		view

Verificare la configurazione

Questa sezione descrive come verificare di aver configurato correttamente il ricevitore CouchDB. L'inizio della raccolta della telemetria da parte di Ops Agent potrebbe richiedere uno o due minuti.

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

  1. Nella console Google Cloud, 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 di CouchDB vengano inviate a Cloud Monitoring:

  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 Query Builder, seleziona il pulsante  MQL o  PromQL.
  3. Verifica che sia selezionato MQL nel pulsante di attivazione/disattivazione Lingua. Il pulsante di attivazione/disattivazione della lingua si trova nella stessa barra degli strumenti che consente di formattare la query.
  4. Inserisci la seguente query nell'editor e poi fai clic su Esegui query: 
    fetch gce_instance
| metric 'workload.googleapis.com/couchdb.database.open'
| every 1m

Visualizza dashboard

Per visualizzare le metriche di CouchDB, devi avere configurato un grafico o una dashboard. L'integrazione di CouchDB include una o più dashboard. Le dashboard vengono installate automaticamente dopo aver configurato l'integrazione e dopo che Ops Agent ha iniziato a raccogliere i dati delle metriche.

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, controlla che l'Ops Agent sia in esecuzione. Se non sono disponibili dati metrici per un grafico nella dashboard, l'installazione della dashboard non va a buon fine. Una volta 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 Integrations (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 Compute Engine.
  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 ulteriori informazioni sull'utilizzo della pagina Integrazioni, consulta Gestire le integrazioni.

Installa i criteri di avviso

I criteri di avviso chiedono a Cloud Monitoring di inviarti una notifica quando si verificano condizioni specifiche. L'integrazione di CouchDB include uno o più criteri di avviso da utilizzare. Puoi visualizzare e installare questi criteri di avviso dalla pagina Integrazioni in Monitoraggio.

Per visualizzare le descrizioni dei criteri di avviso disponibili e installarli:

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

    Vai a Integrations (Integrazioni).

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

  2. Individua la voce per 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 i criteri di avviso. I criteri di avviso devono sapere dove inviare le notifiche che indicano che l'avviso è stato attivato, quindi richiedono informazioni da te per l'installazione. Per installare i criteri di avviso:
    1. Nell'elenco dei criteri di avviso disponibili, seleziona quelli che vuoi installare.

    2. Nella sezione Configura 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 modo silenzioso. Puoi controllarne lo stato in monitoraggio, ma non ricevi notifiche.

      Per saperne di più sui canali di notifica, consulta la pagina Gestire i canali di notifica.

    3. Fai clic su Crea criteri.

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

Per ulteriori informazioni sull'utilizzo della pagina Integrazioni, consulta Gestire le integrazioni.

Passaggi successivi

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