MongoDB

L'integrazione di MongoDB raccoglie principalmente metriche del database, come il numero di operazioni e oggetti, nonché l'utilizzo delle risorse. L'integrazione raccoglie anche 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 le versioni 2.6, 3.x, 4.x, 5.0 e 6.0 di MongoDB.

Configura Ops Agent per MongoDB

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

Configurazione di esempio

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

# 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:
    mongodb:
      type: mongodb
      insecure: true
  service:
    pipelines:
      mongo:
        receivers: [mongodb]
logging:
  receivers:
    mongodb:
      type: mongodb
  service:
    pipelines:
      mongo:
        receivers: [mongodb]
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*

Configura la raccolta dei log

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

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

Campo Predefinito Descrizione
exclude_paths Un elenco di pattern di percorso del file system da escludere dal set corrispondente a include_paths.
include_paths [/var/log/mongodb/mongod.log*] Un elenco di percorsi del file system da leggere seguendo ogni file. Nei percorsi è possibile utilizzare un carattere jolly (*), ad esempio /var/log/mongodb/*.log.
record_log_file_path false Se è 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 si utilizza 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. Indicato come durata di tempo, ad esempio 30s o 2m. Questa proprietà potrebbe essere utile in caso di velocità effettiva di logging elevata, in cui i file di log vengono ruotati più rapidamente dell'intervallo predefinito.

Che cosa viene registrato

logName deriva dagli 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 object (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 della voce di log
severity stringa (LogSeverity) Livello della voce di log (tradotto).

Configurazione della raccolta di metriche

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

Campo Predefinito Descrizione
ca_file Percorso del certificato CA. In qualità di client, verifica il certificato del server. Se è vuoto, il destinatario utilizza la CA radice del sistema.
cert_file Percorso del certificato TLS da utilizzare per le connessioni che richiedono mTLS reciproco.
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 Imposta se utilizzare o meno una connessione TLS sicura. Se impostato su false, TLS è abilitato.
insecure_skip_verify false Imposta se ignorare o meno la verifica del certificato. Se insecure è impostato su true, il valore di insecure_skip_verify non viene utilizzato.
key_file Percorso della chiave TLS da utilizzare per le connessioni che richiedono 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. Potrebbero essere necessari uno o due minuti prima che Ops Agent inizi a raccogliere i dati di telemetria.

Per verificare che i log di MongoDB vengano inviati a Cloud Logging, procedi nel seguente modo:

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

Per verificare che le metriche MongoDB 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/mongodb.memory.usage", monitored_resource="gce_instance"}

Visualizza dashboard

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