Apache CouchDB

L'integrazione di Apache CouchDB raccoglie metriche relative al traffico, come il numero di richieste a un nodo e le risposte del nodo. Raccoglie anche metriche del database, come quante sono aperte e il numero di operazioni. L'integrazione raccoglie i log generali di CouchDB e degli accessi e li analizza in un payload JSON. Il risultato include i campi 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 successiva.

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

Configura Ops Agent per CouchDB

Seguendo la guida per la configurazione di Ops Agent, aggiungi gli elementi richiesti per raccogliere la telemetria dalle istanze CouchDB e riavvia l'agente.

Configurazione di esempio

Il comando seguente crea la configurazione per raccogliere e importare i dati di telemetria per CouchDB e riavvia 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 ricevitori per i log prodotti da CouchDB, quindi creare una pipeline per i nuovi ricevitori.

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

Campo Predefinita Descrizione
exclude_paths Un elenco di pattern di percorso del file system da escludere dal set con corrispondenza in base a include_paths.
include_paths [/var/log/couchdb/couchdb.log] Un elenco di percorsi di file system da leggere eseguendo la coda di ogni file. Nei percorsi è possibile utilizzare un carattere jolly (*), ad esempio /var/log/couchdb*/*.log.
record_log_file_path false Se il criterio viene impostato su true, il percorso del file specifico da cui è stato ottenuto il record di 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 Il valore deve essere couchdb.
wildcard_refresh_interval 60s L'intervallo di aggiornamento dei percorsi dei file con caratteri jolly in include_paths. Indicata come durata di tempo, ad esempio 30s o 2m. Questa proprietà può essere utile in caso di velocità effettiva di logging elevate, in cui i file di log vengono ruotati più velocemente dell'intervallo predefinito. Deve essere un multiplo di 1.

Che cosa viene registrato

logName deriva dagli ID destinatario specificati nella configurazione. Di seguito sono riportati i campi dettagliati all'interno di LogEntry.

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 voce di log
jsonPayload.message string Messaggio di log
jsonPayload.node string Nome istanza 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 con codice di stato
severity stringa (LogSeverity) Livello voce di log (tradotto).

Le voci di log non contengono campi vuoti o mancanti.

Configurazione della raccolta di metriche

Per importare le metriche da CouchDB, devi creare un ricevitore per le metriche prodotte da CouchDB, quindi 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:

Campo Predefinita Descrizione
collection_interval 60s Un valore time.Duration, 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 Il valore deve essere couchdb.
username Il nome utente utilizzato per la connessione al server.

Che cosa viene monitorato

La tabella seguente fornisce l'elenco delle metriche raccolte da Ops Agent dall'istanza di 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

In questa sezione viene descritto come verificare la corretta configurazione del ricevitore CouchDB. Ops Agent potrebbe impiegare uno o due minuti per iniziare a raccogliere dati di telemetria.

Per verificare che i log di CouchDB vengano inviati a Cloud Logging, segui questi passaggi:

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

    Vai a Esplora log

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

  2. Inserisci la seguente query nell'editor, quindi fai clic su Esegui query: 
    resource.type="gce_instance"
log_id("couchdb")

Per verificare che le metriche di CouchDB vengano inviate a Cloud Monitoring, segui questi passaggi:

  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 di creazione di query, seleziona il pulsante con il nome  MQL o  PromQL.
  3. Verifica che sia selezionato MQL nell'opzione di attivazione/disattivazione Lingua. L'opzione 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, quindi 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 aver configurato un grafico o una dashboard. L'integrazione di CouchDB include una o più dashboard per te. Qualsiasi dashboard viene installata automaticamente dopo che hai configurato l'integrazione e 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, quindi 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 riesce. Dopo che Ops Agent inizia a raccogliere le metriche, la dashboard viene installata automaticamente.

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 della piattaforma di deployment di Compute Engine.
  3. Individua la voce per 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, vedi Gestire le integrazioni.

Installa criteri di avviso

I criteri di avviso indicano a Cloud Monitoring di avvisarti quando si verificano condizioni specificate. 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 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 per CouchDB e fai clic su Visualizza dettagli.
  3. Seleziona la scheda Avvisi. Questa scheda fornisce le descrizioni dei criteri di avviso disponibili e fornisce un'interfaccia per installarli.
  4. Installa i criteri di avviso. I criteri di avviso devono sapere dove inviare le notifiche di attivazione dell'avviso, pertanto richiedono informazioni da parte tua per l'installazione. Per installare i criteri di avviso, segui questi passaggi:
    1. Dall'elenco dei criteri di avviso disponibili, seleziona quelli che vuoi installare.

    2. Nella sezione Configura notifiche, seleziona uno o più canali di notifica. Puoi scegliere di disabilitare l'utilizzo dei canali di notifica, ma in questo caso i criteri di avviso vengono attivati automaticamente. Puoi verificarne lo stato in Monitoring, ma non riceverai notifiche.

      Per maggiori informazioni sui canali di notifica, consulta la pagina relativa alla gestione dei canali di notifica.

    3. Fai clic su Crea criteri.

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

Per saperne di più sull'utilizzo della pagina Integrazioni, vedi 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 una dashboard di esempio, guarda il video Installare Ops Agent per risolvere i problemi delle applicazioni di terze parti.