Couchbase

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

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

Prerequisiti

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

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

Questa integrazione supporta le versioni 6.5, 6.6 e 7.0 di Couchbase.

Configura Ops Agent per Couchbase

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

Configurazione di esempio

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

# 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:
    couchbase:
      type: couchbase
      username: admin 
      password: password 
      # 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>}
      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

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

Linux

  1. Per riavviare l'agente, esegui il seguente comando sull'istanza: 
    sudo systemctl restart google-cloud-ops-agent
  2. Per verificare che l'agente sia stato riavviato, esegui il seguente comando e verifica che i componenti "Agente Metriche" e "Agente Logging" siano stati avviati: 
    sudo systemctl status "google-cloud-ops-agent*"

Windows

  1. Connettiti all'istanza utilizzando RDP o uno strumento simile e accedi a Windows.
  2. Apri un terminale PowerShell con privilegi di amministratore facendo clic con il tasto destro del mouse sull'icona di PowerShell e selezionando Esegui come amministratore.
  3. Per riavviare l'agente, esegui il seguente comando PowerShell: 
    Restart-Service google-cloud-ops-agent -Force
  4. Per verificare che l'agente sia stato riavviato, esegui il seguente comando e verifica che i componenti "Agente Metriche" e "Agente Logging" siano stati avviati: 
    Get-Service google-cloud-ops-agent*

Che cosa viene registrato

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

I log couchbase_general contengono i seguenti campi in LogEntry:

Campo Tipo Descrizione
jsonPayload.level string Gravità della voce di log per il log 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 emette il messaggio di log
jsonPayload.source string L'origine del log
jsonPayload.type string Il tipo di log
severity stringa (LogSeverity) Livello della 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 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 della 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 Couchbase
jsonPayload.log_type string Il nome del componente che emette il log cross-datacenter
jsonPayload.message string Messaggio di log
severity stringa (LogSeverity) Livello della 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 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 couchbase, specifica i seguenti campi:

Campo Predefinito 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 Couchbase.
type Questo valore deve essere couchbase.
username Il nome utente utilizzato per connettersi al server Couchbase.

Che cosa viene monitorato

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

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

Per verificare che i log di Couchbase 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("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, procedi nel seguente modo:

  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 il cui nome è  MQL o  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/couchbase.bucket.memory.usage", monitored_resource="gce_instance"}

Visualizza dashboard

Per visualizzare le metriche di Couchbase, devi configurare un grafico o una dashboard. L'integrazione di Couchbase include una 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 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, 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 Couchbase include uno o più criteri 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 Couchbase 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.