MongoDB

Stay organized with collections Save and categorize content based on your preferences.

The MongoDB integration primarily collects database metrics, such as the number of operations and objects, as well as resource usage. The integration also collects logs and parses them into a JSON payload. The result includes fields for context, component, level, and message.

For more information about MongoDB, see the MongoDB documentation.

Prerequisites

To collect MongoDB telemetry, you must install the Ops Agent:

  • For metrics, install version 2.19.0 or higher.
  • For logs, install version 2.10.0 or higher.

This integration supports MongoDB version 2.6, 3.x, 4.x, and 5.0.

Configure the Ops Agent for MongoDB

Following the guide for Configuring the Ops Agent, add the required elements to collect telemetry from MongoDB instances, and restart the agent.

Example configuration

The following command creates the configuration to collect and ingest telemetry for MongoDB and restarts the 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

Configure logs collection

To ingest logs from MongoDB, you must create receivers for the logs that MongoDB produces and then create a pipeline for the new receivers.

To configure a receiver for your mongodb logs, specify the following fields:

Field Default Description
exclude_paths A list of filesystem path patterns to exclude from the set matched by include_paths.
include_paths [/var/log/mongodb/mongod.log*] A list of filesystem paths to read by tailing each file. A wild card (*) can be used in the paths; for example, /var/log/mongodb/*.log.
record_log_file_path false If set to true, then the path to the specific file from which the log record was obtained appears in the output log entry as the value of the agent.googleapis.com/log_file_path label. When using a wildcard, only the path of the file from which the record was obtained is recorded.
type This value must be mongodb.
wildcard_refresh_interval 60s The interval at which wildcard file paths in include_paths are refreshed. Given as a time.ParseDuration, for example 30s or 2m. Must be a multiple of 1s. This property might be useful under high logging throughputs where log files are rotated faster than the default interval.

What is logged

The logName is derived from the receiver IDs specified in the configuration. Detailed fields inside the LogEntry are as follows.

The mongodb logs contain the following fields in the LogEntry:

Field Type Description
jsonPayload.component string Categorization of the log message. A full list can be found in the MongoDB documentation.
jsonPayload.ctx string The name of the thread issuing the log statement.
jsonPayload.id number Log ID.
jsonPayload.message string Log message.
jsonPayload.attributes object (optional) Object containing one or more key-value pairs for any additional attributes provided.
jsonPayload.context string
jsonPayload.severity string Log entry level.
severity string (LogSeverity) Log entry level (translated).

Configure metrics collection

To ingest metrics from MongoDB, you must create receivers for the metrics that MongoDB produces and then create a pipeline for the new receivers.

To configure a receiver for your mongodb metrics, specify the following fields:

Field Default Description
ca_file Path to the CA certificate. As a client, this verifies the server certificate. If empty, the receiver uses the system root CA.
cert_file Path to the TLS certificate to use for mTLS-required connections.
collection_interval 60s A time.Duration value, such as 30s or 5m.
endpoint http://localhost:27017 The hostname, IP address, or UNIX domain socket. A port can be specified like :. If no port is specified the default 27017 will be used.
insecure true Sets whether or not to use a secure TLS connection. If set to false, then TLS is enabled.
insecure_skip_verify false Sets whether or not to skip verifying the certificate. If insecure is set to true, then the insecure_skip_verify value is not used.
key_file Path to the TLS key to use for mTLS-required connections.
password Password for authentication with the MongoDB instance. Required if username is set.
type This value must be mongodb.
username Username for authentication with the MongoDB instance. Required if password is set.

What is monitored

The following table provides the list of metrics that the Ops Agent collects from the MongoDB instance.

Metric type 
Kind, Type
Monitored resources
Labels
workload.googleapis.com/mongodb.cache.operations
CUMULATIVEINT64
gce_instance
type
workload.googleapis.com/mongodb.collection.count
GAUGEINT64
gce_instance
database
workload.googleapis.com/mongodb.connection.count
GAUGEINT64
gce_instance
database
type
workload.googleapis.com/mongodb.cursor.count
GAUGEINT64
gce_instance
 
workload.googleapis.com/mongodb.cursor.timeout.count
GAUGEINT64
gce_instance
 
workload.googleapis.com/mongodb.data.size
GAUGEINT64
gce_instance
database
workload.googleapis.com/mongodb.database.count
GAUGEINT64
gce_instance
 
workload.googleapis.com/mongodb.document.operation.count
GAUGEINT64
gce_instance
database
operation
workload.googleapis.com/mongodb.global_lock.time
CUMULATIVEINT64
gce_instance
 
workload.googleapis.com/mongodb.index.access.count
GAUGEINT64
gce_instance
collection
database
workload.googleapis.com/mongodb.index.count
GAUGEINT64
gce_instance
database
workload.googleapis.com/mongodb.index.size
GAUGEINT64
gce_instance
database
workload.googleapis.com/mongodb.memory.usage
GAUGEINT64
gce_instance
database
type
workload.googleapis.com/mongodb.network.io.receive
GAUGEINT64
gce_instance
 
workload.googleapis.com/mongodb.network.io.transmit
GAUGEINT64
gce_instance
 
workload.googleapis.com/mongodb.network.request.count
GAUGEINT64
gce_instance
 
workload.googleapis.com/mongodb.object.count
GAUGEINT64
gce_instance
database
workload.googleapis.com/mongodb.operation.count
CUMULATIVEINT64
gce_instance
operation
workload.googleapis.com/mongodb.operation.time
CUMULATIVEINT64
gce_instance
operation
workload.googleapis.com/mongodb.session.count
GAUGEINT64
gce_instance
 
workload.googleapis.com/mongodb.storage.size
CUMULATIVEINT64
gce_instance
database

Sample dashboard

To view your MongoDB metrics, you must have a chart or dashboard configured. Cloud Monitoring provides a library of sample dashboards for integrations, which contain preconfigured charts. For information about installing these dashboards, see Installing sample dashboards.

Verify the configuration

This section describes how to verify that you correctly configured the MongoDB receiver. It might take one or two minutes for the Ops Agent to begin collecting telemetry.

To verify that the logs are ingested, go to the Logs Explorer and run the following query to view the MongoDB logs:

resource.type="gce_instance"
log_id("mongodb")

To verify that the metrics are ingested, go to Metrics Explorer and run the following query in the MQL tab:

fetch gce_instance
| metric 'workload.googleapis.com/mongodb.memory.usage'
| every 1m

What's next

For a walkthrough on how to use Ansible to install the Ops Agent, configure a third-party application, and install a sample dashboard, see the Install the Ops Agent to troubleshoot third-party applications video.