MongoDB

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

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

Prerequisiti

Per raccogliere la telemetria di MongoDB, devi installare Ops Agent:

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

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

Configura Ops Agent per MongoDB

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

Configurazione di esempio

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

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

Campo Predefinito Descrizione
exclude_paths Un elenco di pattern di percorsi del file system da escludere dal set corrispondente da include_paths.
include_paths [/var/log/mongodb/mongod.log*] Un elenco di percorsi di file system da leggere mediante il tailing di ogni file. È possibile utilizzare un carattere jolly (*) nei percorsi, ad esempio /var/log/mongodb/*.log.
record_log_file_path false Se il criterio è 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 con cui vengono aggiornati i percorsi dei file con caratteri jolly in include_paths. Dati come time.ParseDuration, ad esempio 30s o 2m. Deve essere un multiplo di 1s. Questa proprietà potrebbe essere utile con velocità effettiva di logging elevate, in cui i file di log vengono ruotati più velocemente rispetto all'intervallo predefinito.

Cosa viene registrato

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

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 number ID log.
jsonPayload.message string Messaggio di log.
jsonPayload.severity string Livello di voce di log.
severity stringa (LogSeverity) Livello di voce di log (tradotto).

Configurazione della raccolta di metriche

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

Campo Predefinito Descrizione
ca_file Percorso del certificato CA. In qualità di client, questa operazione verifica 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 da mTLS.
collection_interval 60s Un valore time.Duration, ad esempio 30s o 5m.
endpoint localhost:27017 Il nome host, l'indirizzo IP o il socket del dominio UNIX. È possibile specificare una porta, ad esempio :. Se non viene specificata alcuna porta, viene utilizzato il valore predefinito 27017.
insecure true Consente di specificare se utilizzare o meno una connessione TLS sicura. Se il criterio viene impostato su false, il protocollo TLS è abilitato.
insecure_skip_verify false Consente di scegliere se saltare o meno la verifica del certificato. Se il criterio non è sicuro impostato su true, il valore insecure_skip_verify non viene utilizzato.
key_file Percorso della chiave TLS da utilizzare per le connessioni mTLS richieste, ad esempio la chiave utilizzata nel file tlsCertificateKeyFile.
password Password per l'autenticazione con l'istanza MongoDB. Obbligatorio se è impostato un nome utente.
type Questo valore deve essere mongodb.
username Nome utente per l'autenticazione con l'istanza MongoDB. Obbligatorio se è stata impostata una password.

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. Ops Agent potrebbe impiegare uno o due minuti per iniziare a raccogliere i dati di telemetria.

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

  1. Nel pannello di navigazione della console Google Cloud, seleziona Logging, quindi Esplora log:

    Vai a Esplora log

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

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

  1. Nella console Google Cloud, vai alla pagina Metrics Explorer :

    Vai a Metrics Explorer

    Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato il cui sottotitolo è Monitoring.

  2. Nella barra degli strumenti del riquadro del generatore di query, seleziona il pulsante il cui nome è  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 che consente di formattare la query.
  4. Inserisci la seguente query nell'editor e fai clic su Esegui query: 
    fetch gce_instance
| metric 'workload.googleapis.com/mongodb.memory.usage'
| every 1m

Visualizza dashboard

Per visualizzare le metriche MongoDB, è necessario che un grafico o una dashboard siano configurati. L'integrazione di MongoDB include una o più dashboard per te. Tutte le dashboard vengono installate automaticamente dopo la configurazione dell'integrazione e dopo che 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, segui questi passaggi:

  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 il cui sottotitolo è Monitoring.

  2. Seleziona la scheda Elenco dashboard, quindi scegli la categoria Integrazioni.
  3. Fai clic sul nome della dashboard da visualizzare.

Se hai configurato un'integrazione, ma la dashboard non è stata installata, verifica che Ops Agent sia in esecuzione. Se nella dashboard non sono disponibili dati delle metriche per un grafico, l'installazione della dashboard non riesce. Dopo che Ops Agent ha iniziato 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 il cui sottotitolo è Monitoring.

  2. Fai clic sul filtro piattaforma di deployment di Compute Engine.
  3. Individua la voce relativa a MongoDB 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 ulteriori informazioni sull'utilizzo della pagina Integrazioni, consulta Gestire le integrazioni.

Installa criteri di avviso

I criteri di avviso indicano a Cloud Monitoring di inviarti una notifica quando si verificano condizioni specificate. L'integrazione di MongoDB 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:

  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 il cui sottotitolo è Monitoring.

  2. Individua la voce per MongoDB 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 i criteri di avviso. I criteri di avviso devono sapere dove inviare le notifiche relative all'attivazione dell'avviso, per cui richiedono informazioni da parte tua 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. Puoi disattivare l'utilizzo dei canali di notifica. Tuttavia, in questo caso i criteri di avviso si attivano in modo invisibile. Puoi verificarne lo stato in Monitoring, ma non ricevi notifiche.

      Per maggiori informazioni 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 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, configurare un'applicazione di terze parti e installare una dashboard di esempio, consulta il video Installare Ops Agent per la risoluzione dei problemi delle applicazioni di terze parti.