L'integrazione di Apache CouchDB raccoglie metriche relative al traffico, come numero di richieste a un nodo e risposte da quest'ultimo. Inoltre, raccoglie le metriche del database, ad esempio quante sono aperte e il numero di operazioni. La L'integrazione raccoglie i log generali di CouchDB e di accesso e li analizza in un file JSON per il payload. Il risultato include i campi utente, host, livello e messaggio.
Per ulteriori informazioni su CouchDB, vedi 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 alla configurazione delle operazioni Agent, aggiungi gli elementi richiesti per raccogliere dati di telemetria dalle istanze CouchDB riavvia l'agente.
Configurazione di esempio
I comandi seguenti creano la configurazione per raccogliere e importare dati di telemetria per CouchDB e riavvia Ops Agent.
Configura la raccolta dei log
Per importare i log da CouchDB, devi creare un ricevitore per i log prodotto da CouchDB, per poi creare una pipeline per il nuovo ricevitore.
Per configurare un ricevitore per i log di couchdb
, specifica quanto segue
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 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 |
Questo valore deve essere couchdb . |
|
wildcard_refresh_interval |
60s |
L'intervallo di aggiornamento dei percorsi file con caratteri jolly in include_paths . Data come durata di tempo, ad esempio 30s o 2m . Questa proprietà può essere utile in caso di velocità effettiva di registrazione elevate, in cui i file di log vengono ruotati più velocemente dell'intervallo predefinito. |
Che cosa viene registrato
logName
deriva da
gli ID destinatario specificati nella configurazione. Campi dettagliati all'interno
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 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). |
Configurazione della raccolta di metriche
Per importare le metriche da CouchDB, devi creare un ricevitore per le metriche prodotto da CouchDB, per poi creare una pipeline per il nuovo ricevitore.
Questo ricevitore non supportare l'uso 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 distinguerli.
Per configurare un ricevitore per le metriche couchdb
, specifica quanto segue
campi:
Campo | Predefinito | Descrizione |
---|---|---|
collection_interval |
60s |
Un valore di durata temporale, 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 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. Potrebbero essere necessari uno o due minuti prima che Ops Agent inizi a raccogliere dati di telemetria.
Per verificare che i log di CouchDB vengano inviati a Cloud Logging, segui questi passaggi:
-
Nella console Google Cloud, vai alla pagina Esplora log:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Logging.
- 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, segui questi passaggi:
-
Nella console Google Cloud, vai alla pagina leaderboard Esplora metriche:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
- Nella barra degli strumenti della riquadro Query Builder, seleziona il pulsante con code MQL o code PromQL.
- Verifica che sia selezionato MQL con l'opzione Lingua. Il pulsante di attivazione/disattivazione della lingua si trova nella stessa barra degli strumenti. consente di formattare la query.
- 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 per te. 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 installando l'integrazione.
Per visualizzare una dashboard installata:
-
Nella console Google Cloud, vai alla pagina Dashboard :
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
- Seleziona la scheda Elenco dashboard, quindi scegli la Categoria Integrazioni.
- Fai clic sul nome della dashboard che vuoi visualizzare.
Se hai configurato un'integrazione, ma la dashboard non è stata installato, quindi verifica che Ops Agent sia in esecuzione. Quando non c'è 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 per te.
Per visualizzare un'anteprima statica della dashboard:
-
Nella console Google Cloud, vai alla pagina Integrazioni:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
- Fai clic sul filtro della piattaforma di deployment di Compute Engine.
- Individua la voce per CouchDB e fai clic su Visualizza dettagli.
- Seleziona la scheda Dashboard per visualizzare un'anteprima statica. Se sia installata, quindi puoi accedervi facendo clic Visualizza dashboard.
Per saperne di più sulle dashboard in Cloud Monitoring, consulta Dashboard e grafici.
Per saperne di più sull'utilizzo della pagina Integrazioni, vedi Gestisci le integrazioni.
Installa criteri di avviso
I criteri di avviso indicano a Cloud Monitoring di avvisarti quando che si verifichino determinate condizioni. L'integrazione di CouchDB include uno o più criteri di avviso per da utilizzare. Puoi visualizzare e installare questi criteri di avviso dalla pagina Integrations (Integrazioni) in Monitoraggio.
Per visualizzare le descrizioni dei criteri di avviso disponibili e procedi nel seguente modo:
-
Nella console Google Cloud, vai alla pagina Integrazioni:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
- Individua la voce per CouchDB e fai clic su Visualizza dettagli.
- Seleziona la scheda Avvisi. Questa scheda fornisce le descrizioni criteri di avviso disponibili e fornisce un'interfaccia per l'installazione che li rappresentano.
- Installa i criteri di avviso. I criteri di avviso richiedono
per sapere dove inviare le notifiche relative a un avviso
vengono attivati, quindi richiedono informazioni per l'installazione.
Per installare i criteri di avviso, segui questi passaggi:
- Dall'elenco dei criteri di avviso disponibili, seleziona quelli da installare.
Nella sezione Configura notifiche, seleziona una o più canali di notifica. Puoi scegliere di disattivare l'uso dei canali di notifica, ma se lo fai, la funzione si attivano automaticamente. Puoi verificarne lo stato nella Monitoraggio, ma non riceverai notifiche.
Per ulteriori informazioni sui canali di notifica, consulta Gestire canali di notifica.
- Fai clic su Crea criteri.
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, vedi Gestisci le integrazioni.
Passaggi successivi
Per una procedura dettagliata su come utilizzare Ansible per installare Ops Agent, configura un'applicazione di terze parti e installare una dashboard di esempio, consulta Video: installa Ops Agent per risolvere i problemi relativi alle applicazioni di terze parti.