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 a receiver for the metrics that MongoDB produces and then create a pipeline for the new receiver.

This receiver does not support the use of multiple instances in the configuration, for example, to monitor multiple endpoints. All such instances write to the same time series, and Cloud Monitoring has no way to distinguish among them.

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

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

View dashboard

To view your MongoDB metrics, you must have a chart or dashboard configured. The MongoDB integration includes one or more dashboards for you. Any dashboards are automatically installed after you configure the integration and the Ops Agent has begun collecting metric data.

You can also view static previews of dashboards without installing the integration.

To view an installed dashboard, do the following:

  1. In the Google Cloud console, select Monitoring or click the following button:
    Go to Monitoring
  2. In the navigation pane, select  Dashboards.
  3. Select the Dashboard List tab.
  4. Choose the Integrations category.
  5. Click the name of the dashboard you want to view.

If you have configured an integration but the dashboard has not been installed, then check that the Ops Agent is running. When there is no metric data for a chart in the dashboard, installation of the dashboard fails. After the Ops Agent begins collecting metrics, the dashboard is installed for you.

To view a static preview of the dashboard, do the following:

  1. In the Google Cloud console, select Monitoring or click the following button:
    Go to Monitoring
  2. In the navigation pane, select  Integrations.
  3. Click the Compute Engine deployment-platform filter.
  4. Locate the entry for MongoDB and click View Details.
  5. Select the Dashboards tab to see a static preview. If the dashboard is installed, then you can navigate to it by clicking View dashboard.

For more information about dashboards in Cloud Monitoring, see Dashboards and charts.

For more information about using the Integrations page, see Manage integrations.

Install alerting policies

Alerting policies instruct Cloud Monitoring to notify you when specified conditions occur. The MongoDB integration includes one or more alerting policies for you to use. You can view and install these alerting policies from the Integrations page in Monitoring.

To view the descriptions of available alerting policies and install them, do the following:

  1. In the Google Cloud console, select Monitoring or click the following button:
    Go to Monitoring
  2. In the navigation pane, select  Integrations.
  3. Locate the entry for MongoDB and click View details.
  4. Select the Alerts tab. This tab provides descriptions of available alerting policies and provides an interface for installing them.
  5. Install alerting policies. Alerting policies need to know where to send notifications that the alert has been triggered, so they require information from you for installation. To install alerting policies, do the following:
    1. From the list of available alerting policies, select those that you want to install.

    2. In the Configure notifications section, select one or more notification channels. You have the option to disable the use of notification channels, but if you do, then your alerting policies fire silently. You can check their status in Monitoring, but you receive no notifications.

      For more information about notification channels, see Manage notification channels.

    3. Click Create Policies.

For more information about alerting policies in Cloud Monitoring, see Introduction to alerting.

For more information about using the Integrations page, see Manage integrations.

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.