MongoDB

L'integrazione di MongoDB raccoglie principalmente metriche del database, come il numero di operazioni e oggetti, nonché sull'utilizzo delle risorse. L'integrazione raccoglie inoltre i log e li analizza in un payload JSON. Il risultato include campi per contesto, componente, livello e messaggio.

Per saperne di più su MongoDB, consulta la documentazione di MongoDB.

Prerequisiti

Per raccogliere la telemetria MongoDB, devi installa Ops Agent:

  • Per le metriche, installa la versione 2.19.0 o successive.
  • Per i log, installa la versione 2.10.0 o successiva.

Questa integrazione supporta le versioni di MongoDB 2.6, 3.x, 4.x, 5.0 e 6.0.

Configurare Ops Agent per MongoDB

Seguendo la guida alla configurazione delle operazioni Agent, aggiungi gli elementi richiesti per raccogliere dati di telemetria dalle istanze MongoDB riavvia l'agente.

Configurazione di esempio

I comandi seguenti creano la configurazione per raccogliere e importare dati di telemetria per MongoDB 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:
    mongodb:
      type: mongodb
      insecure: true
  service:
    pipelines:
      mongo:
        receivers: [mongodb]
logging:
  receivers:
    mongodb:
      type: mongodb
  service:
    pipelines:
      mongo:
        receivers: [mongodb]
EOF

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

Configura la raccolta dei log

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

Per configurare un ricevitore per i log di mongodb, 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/mongodb/mongod.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/mongodb/*.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 mongodb.
wildcard_refresh_interval 60s L'intervallo di aggiornamento dei percorsi dei 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 logging 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. I campi dettagliati all'interno di LogEntry sono i seguenti.

I log mongodb contengono i seguenti campi in LogEntry:

Campo Tipo Descrizione
jsonPayload.attributes oggetto (facoltativo) Oggetto contenente una o più coppie chiave-valore per eventuali attributi aggiuntivi forniti
jsonPayload.component string Categorizzazione del messaggio di log. Un elenco completo è disponibile nella documentazione di MongoDB.
jsonPayload.context string
jsonPayload.ctx string Il nome del thread che emette l'istruzione di log
jsonPayload.id numero ID log
jsonPayload.message string Messaggio di log
jsonPayload.severity string Livello voce di log
severity stringa (LogSeverity) Livello voce di log (tradotto).

Configurazione della raccolta di metriche

Per importare le metriche da MongoDB, devi creare un destinatario per le metriche prodotte da MongoDB e poi una pipeline per il nuovo destinatario.

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 mongodb, specifica quanto segue campi:

Campo Predefinito Descrizione
ca_file Percorso del certificato CA. In qualità di client, viene verificato il certificato del server. Se vuoto, il destinatario utilizza la CA radice di sistema.
cert_file Percorso del certificato TLS da utilizzare per le connessioni richieste per mTLS.
collection_interval 60s Un valore di durata, ad esempio 30s o 5m.
endpoint localhost:27017 Il nome host, l'indirizzo IP o il socket di dominio UNIX. Una porta può essere specificata come <hostname>:<port>. Se non viene specificata alcuna porta, verrà utilizzata la porta predefinita 27017.
insecure true Consente di impostare se utilizzare o meno una connessione TLS sicura. Se impostato su false, TLS è attivato.
insecure_skip_verify false Consente di scegliere se saltare o meno la verifica del certificato. Se insecure è impostato su true, il valore insecure_skip_verify non viene utilizzato.
key_file Percorso della chiave TLS da utilizzare per le connessioni richieste da mTLS, ad esempio la chiave utilizzata in --tlsCertificateKeyFile.
password Password per l'autenticazione con l'istanza MongoDB. Obbligatorio se username è impostato.
type Questo valore deve essere mongodb.
username Nome utente per l'autenticazione con l'istanza MongoDB. Obbligatorio se password è impostato.

Che cosa viene monitorato

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

Tipo di metrica
Tipo, Tipo
Risorse monitorate		 Etichette
workload.googleapis.com/mongodb.cache.operations
CUMULATIVE, INT64
gce_instance 		type
workload.googleapis.com/mongodb.collection.count
GAUGE, INT64
gce_instance 		database
workload.googleapis.com/mongodb.connection.count
GAUGE, INT64
gce_instance 		database
type
workload.googleapis.com/mongodb.cursor.count
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/mongodb.cursor.timeout.count
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/mongodb.data.size
GAUGE, INT64
gce_instance 		database
workload.googleapis.com/mongodb.database.count
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/mongodb.document.operation.count
GAUGE, INT64
gce_instance 		database
operation
workload.googleapis.com/mongodb.global_lock.time
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/mongodb.index.access.count
GAUGE, INT64
gce_instance 		collection
database
workload.googleapis.com/mongodb.index.count
GAUGE, INT64
gce_instance 		database
workload.googleapis.com/mongodb.index.size
GAUGE, INT64
gce_instance 		database
workload.googleapis.com/mongodb.memory.usage
GAUGE, INT64
gce_instance 		database
type
workload.googleapis.com/mongodb.network.io.receive
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/mongodb.network.io.transmit
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/mongodb.network.request.count
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/mongodb.object.count
GAUGE, INT64
gce_instance 		database
workload.googleapis.com/mongodb.operation.count
CUMULATIVE, INT64
gce_instance 		operation
workload.googleapis.com/mongodb.operation.time
CUMULATIVE, INT64
gce_instance 		operation
workload.googleapis.com/mongodb.session.count
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/mongodb.storage.size
CUMULATIVE, INT64
gce_instance 		database

Verificare la configurazione

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

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

  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("mongodb")

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

Visualizza dashboard

Per visualizzare le metriche di MongoDB, devi avere configurato un grafico o una dashboard. L'integrazione di MongoDB 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 installando 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, controlla che l'agente operativo 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:

  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 Compute Engine.
  3. Individua la voce per MongoDB e fai clic su Visualizza dettagli.
  4. Seleziona la scheda Dashboard per visualizzare un'anteprima statica. Se sia installata, quindi puoi accedervi facendo clic Visualizza dashboard.

Per ulteriori informazioni sulle dashboard in Cloud Monitoring, consulta Dashboard e grafici.

Per saperne di più sull'utilizzo della pagina Integrazioni, vedi Gestisci le integrazioni.

Installa i criteri di avviso

I criteri di avviso indicano a Cloud Monitoring di avvisarti quando che si verifichino determinate condizioni. L'integrazione di MongoDB 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:

  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 MongoDB e fai clic su Visualizza dettagli.
  3. Seleziona la scheda Avvisi. Questa scheda fornisce le descrizioni criteri di avviso disponibili e fornisce un'interfaccia per l'installazione che li rappresentano.
  4. 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:
    1. Dall'elenco dei criteri di avviso disponibili, seleziona quelli da installare.

    2. 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 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 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.