Couchbase

L'integrazione di Couchbase raccoglie metriche del bucket come operazioni, utilizzo della memoria ed espulsioni. L'integrazione raccoglie le metriche dal server Prometheus esposte su un nodo. L'integrazione raccoglie anche i log generali di Couchbase, dell'accesso HTTP e tra datacenter ("goxdcr").

Per ulteriori informazioni su couchbase, consulta la documentazione di Couchbase.

Prerequisiti

Per raccogliere dati di telemetria sul divano, devi installare Ops Agent 2.18.2 o versioni successive.

Questa integrazione supporta le versioni couchbase 6.5, 6.6 e 7.0.

Configura Ops Agent per couchbase

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

Configurazione di esempio

Il comando seguente crea la configurazione per raccogliere e importare i dati di telemetria per couchbase 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:
    couchbase:
      type: couchbase
      username: admin
      password: password
      collection_interval: 30s
  service:
    pipelines:
      couchbase:
        receivers:
          - couchbase

logging:
  receivers:
    couchbase_general:
      type: couchbase_general
    couchbase_http_access:
      type: couchbase_http_access
    couchbase_goxdcr:
      type: couchbase_goxdcr
  service:
    pipelines:
      couchbase:
        receivers:
          - couchbase_general
          - couchbase_http_access
          - couchbase_goxdcr

EOF

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

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 couchbase_general contengono i seguenti campi in LogEntry:

Campo Tipo Descrizione
jsonPayload.level string Gravità della voce di log per il log di couchbase
jsonPayload.message string Messaggio di log
jsonPayload.module_name string Il nome del modulo che emette la voce
jsonPayload.node_name string Il nome del nodo che invia il messaggio di log
jsonPayload.source string Origine da cui ha avuto origine il log
jsonPayload.type string Il tipo di log
severity stringa (LogSeverity) Livello voce di log (tradotto).

I log couchbase_http_access contengono i seguenti campi in LogEntry:

Campo Tipo Descrizione
httpRequest oggetto Leggi HttpRequest
jsonPayload.host string L'indirizzo IP del client che richiama la richiesta HTTP
jsonPayload.level string Gravità della voce di log per il log di couchbase
jsonPayload.message string Messaggio di log
jsonPayload.user string Il nome dell'utente che effettua la richiesta HTTP se viene utilizzata l'autenticazione di base.
severity stringa (LogSeverity) Livello voce di log (tradotto).

I log couchbase_goxdcr contengono i seguenti campi in LogEntry:

Campo Tipo Descrizione
jsonPayload.level string Gravità della voce di log per il log di couchbase
jsonPayload.log_type string Il nome del componente che emette il log tra data center
jsonPayload.message string Messaggio di log
severity stringa (LogSeverity) Livello voce di log (tradotto).

Configurazione della raccolta di metriche

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

Campo Predefinita Descrizione
collection_interval 60s Un valore time.Duration, ad esempio 30s o 5m.
endpoint localhost:8091 L'URL del nodo da monitorare.
password La password utilizzata per connettersi al server di couchbase.
type Questo valore deve essere couchbase.
username Il nome utente utilizzato per connettersi al server di couchbase.

Che cosa viene monitorato

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

Tipo di metrica
Tipo, tipo
Risorse monitorate		 Etichette
workload.googleapis.com/couchbase.bucket.error.oom.count
CUMULATIVE, INT64
gce_instance 		bucket_name
error_type
workload.googleapis.com/couchbase.bucket.item.count
GAUGE, DOUBLE
gce_instance 		bucket_name
state
workload.googleapis.com/couchbase.bucket.item.ejection.count
CUMULATIVE, INT64
gce_instance 		bucket_name
workload.googleapis.com/couchbase.bucket.memory.high_water_mark.limit
GAUGE, DOUBLE
gce_instance 		bucket_name
workload.googleapis.com/couchbase.bucket.memory.low_water_mark.limit
GAUGE, DOUBLE
gce_instance 		bucket_name
workload.googleapis.com/couchbase.bucket.memory.usage
GAUGE, DOUBLE
gce_instance 		bucket_name
workload.googleapis.com/couchbase.bucket.operation.count
CUMULATIVE, INT64
gce_instance 		bucket_name
op
workload.googleapis.com/couchbase.bucket.vbucket.count
GAUGE, DOUBLE
gce_instance 		bucket_name
state

Verificare la configurazione

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

Per verificare che i log di Couchbase 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("couchbase_general") OR log_id("couchbase_http_access") OR log_id("couchbase_goxdcr"))

Per verificare che le metriche di Couchbase 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/couchbase.bucket.memory.usage'
| every 1m

Visualizza dashboard

Per visualizzare le metriche di Couchbase, devi aver configurato un grafico o una dashboard. L'integrazione di Couchbase 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 Couchbase 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 Couchbase 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 Couchbase 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.