Database Monitoring for MongoDB is in public beta. If you are interested in participating, reach out to your Datadog Customer Success Manager.
Database Monitoring offers comprehensive insights into your MongoDB databases by providing access to critical metrics, slow operations, operation samples, explain plans, and replication state changes. To take advantage of Database Monitoring for MongoDB, ensure that the Datadog Agent is installed and configured to connect to your MongoDB Atlas instances. This guide outlines the steps to set up Database Monitoring for MongoDB Atlas.
Beta features in version 7.58.0-dbm-mongo-1.6
The Database Monitoring feature for MongoDB is available in the beta version of the Datadog Agent. If you are not on version 7.58.0-dbm-mongo-1.6, upgrade to access the new features.
Slow operations
Database Monitoring for MongoDB captures slow operations from either MongoDB slow query logs or the system.profile collection. Slow operations are defined as those taking longer than the slowms threshold set in your MongoDB configuration. Monitoring slow operations is critical to identify and troubleshoot performance issues.
Explain plans
Database Monitoring for MongoDB collects explain plans for current running read operations and slow operations. Explain plans provide detailed insights into the query execution plans, helping you optimize query performance.
MongoDB Collection Schema and Index Analysis
Database Monitoring for MongoDB now offers schema and index analysis for your MongoDB collections. This feature provides insights into the structure and organization of your data by collecting inferred schema details and index information.
Using a document sampling approach with the $sample aggregation stage, Datadog analyzes your collection to identify common fields, their data types, and how often each field appears across the sampled documents (field prevalence). In addition to schema details, Database Monitoring for MongoDB also gathers information on the indexes present, giving you a comprehensive view of how data is structured and optimized for querying.
Before you begin
Supported MongoDB major versions
4.4, 5.0, 6.0, 7.0
Supported Agent versions
7.58.0-dbm-mongo-1.6
Performance impact
The default Agent configuration for Database Monitoring is conservative, but you can adjust settings such as the collection interval and operation sampling rate to better suit your needs. For most workloads, the Agent represents less than one percent of query execution time on the database and less than one percent of CPU.
Connection strings or SRV strings
Although MongoDB connection strings or SRV strings provide many benefits such as automatic failover and load balancing, the Datadog Agent must connect directly to the MongoDB instance being monitored. If the Agent connects to a different MongoDB instance while it is running (as in the case of failover, load balancing, and so on), the Agent calculates the difference in statistics between two hosts, producing inaccurate metrics.
Data security considerations
Read about how Database Management handles sensitive information for information about what data the Agent collects from your databases and how to ensure it is secure.
Grant the Agent access to your MongoDB Atlas Cluster
The Datadog Agent requires read-only access to the MongoDB Atlas Cluster to collect statistics and queries.
Create a custom monitoring role
In the MongoDB Atlas UI, navigate to the Database Access tab.
On the Custom Roles tab, click Add New Custom Role.
Enter a Custom Role Name, such as datadog.
Add the following permissions to the custom role:
read on the admin database
read on the local database
clusterMonitor on the admin database
read on the databases you want to monitor, or readAnyDatabase to monitor all databases
Click Add Custom Role.
Create a monitoring user with the custom monitoring role
In the MongoDB Atlas UI, navigate to the Database Access tab.
On the Database Users tab, click Add New Database User.
Under the Authentication Method, select Password.
Enter the username and password.
Under Database User Privileges, expand Custom Roles and select the custom monitoring role you created in the previous step.
Click Add User.
Note the username and password for the monitoring user, so you can configure the Agent.
Securely store your password
Store your password using secret management software such as Vault. You can then reference this password as ENC[<SECRET_NAME>] in your Agent configuration files: for example, ENC[datadog_user_database_password]. See Secrets Management for more information.
The examples on this page use datadog_user_database_password to refer to the name of the secret where your password is stored. It is possible to reference your password in plain text, but this is not recommended.
Install and configure the Agent
To monitor your MongoDB Atlas Cluster, you must install and configure the Datadog Agent on a host that can remotely access your MongoDB Atlas Cluster. This host can be a Linux host, a Docker container, or a Kubernetes pod.
Get the individual MongoDB instance hostname and port from the SRV connection string
Applications usually connect to MongoDB Atlas using an SRV connection string, but the Datadog Agent must connect directly to the individual MongoDB instance being monitored. If the Agent connects to different MongoDB instance while it is running (as in the case of failover, load balancing, and so on), the Agent calculates the difference in statistics between two hosts, producing inaccurate metrics.
To get the individual MongoDB instance hostname and port, you can use the dig command to resolve the SRV connection string:
Replica set members
For a non-sharded (replica set) cluster with the SRV connection string mongodb+srv://XXXXX.XXX.mongodb.net/:
In this example, the individual MongoDB instances for shard-0 are:
XXXXX-00-00.4zh9o.mongodb.net:27017
XXXXX-00-01.4zh9o.mongodb.net:27017
XXXXX-00-02.4zh9o.mongodb.net:27017
For shard-1, they are:
XXXXX-01-00.4zh9o.mongodb.net:27017
XXXXX-01-01.4zh9o.mongodb.net:27017
XXXXX-01-02.4zh9o.mongodb.net:27017
For the config server, they are:
XXXXX-00-00-config.4zh9o.mongodb.net:27017
XXXXX-00-01-config.4zh9o.mongodb.net:27017
XXXXX-00-02-config.4zh9o.mongodb.net:27017
You can use one of these hostnames to configure the Agent.
Install the beta version of the Datadog Agent
Database Monitoring for MongoDB is available in the beta version of the Datadog Agent. To install the beta version of the Datadog Agent, follow the instructions for your environment. A Datadog API key is required.
To install the beta version of the Datadog Agent on a Linux host, run the following command.
Replace <DD_API_KEY> with your Datadog API key and <DD_SITE> with your Datadog site.
# Override the following environment variablesexportDD_REPO_URL=datad0g.com
exportDD_AGENT_DIST_CHANNEL=beta
exportDD_AGENT_MAJOR_VERSION=7exportDD_AGENT_MINOR_VERSION="58.0~dbm~mongo~1.6"DD_API_KEY=<DD_API_KEY> DD_SITE=<DD_SITE> bash -c "$(curl -L https://install.datadoghq.com/scripts/install_script_agent7.sh)"
To install the beta version of the containerized Datadog Agent, run the following command.
Replace <DD_API_KEY> with your Datadog API key and <DD_SITE> with your Datadog site.
# Override the following environment variablesexportDD_API_KEY=<DD_API_KEY>
exportDD_SITE=<DD_SITE>
exportDD_AGENT_VERSION=7.58.0-dbm-mongo-1.6
docker pull "datadog/agent:${DD_AGENT_VERSION}"
To install the beta version of the Datadog Agent on Kubernetes, run the following command.
Replace <DD_API_KEY> with your Datadog API key and <DD_SITE> with your Datadog site.
To monitor a MongoDB replica set, the Agent needs to connect to all members (including the arbiter) of the replica set.
Use the following configuration block as an example to configure the Agent to connect to a replica set member:
init_config:instances:## @param hosts - required## Specify the hostname, IP address, or UNIX domain socket of## a mongod instance as listed in the replica set configuration.## If the port number is not specified, the default port 27017 is used.#- hosts:- <HOST>:<PORT> # Primary node## @param username - string - optional## The username to use for authentication.#username:datadog## @param password - string - optional## The password to use for authentication.#password:"ENC[datadog_user_database_password]"## @param options - mapping - optional## Connection options. For a complete list, see:## https://docs.mongodb.com/manual/reference/connection-string/#connections-connection-options#options:authSource:admin## @param tls - boolean - optional## Set to true to connect to the MongoDB instance using TLS.#tls:true## @param dbm - boolean - optional## Set to true to enable Database Monitoring.#dbm:true## @param cluster_name - string - optional## The unique name of the cluster to which the monitored MongoDB instance belongs.## Used to group MongoDB instances in a MongoDB cluster.## Required when `dbm` is enabled.#cluster_name:<MONGO_CLUSTER_NAME>## @param reported_database_hostname - string - optional## Set the reported database hostname for the connected MongoDB instance.## This value overrides the MongoDB hostname detected by the Agent## from the MongoDB admin command serverStatus.host.#reported_database_hostname:<DATABASE_HOSTNAME_OVERRIDE>## @param additional_metrics - list of strings - optional## List of additional metrics to collect. Available options are:## - metrics.commands: Use of database commands## - tcmalloc: TCMalloc memory allocator## - top: Usage statistics for each collection## - collection: Metrics of the specified collections#additional_metrics:["metrics.commands","tcmalloc","top","collection"]## @param collections_indexes_stats - boolean - optional## Set to true to collect index statistics for the specified collections.## Requires `collections` to be set.#collections_indexes_stats:true## @param database_autodiscovery - mapping - optional## Enable database autodiscovery to automatically collect metrics from all your MongoDB databases.#database_autodiscovery:## @param enabled - boolean - required## Enable database autodiscovery.#enabled:true## @param include - list of strings - optional## List of databases to include in the autodiscovery. Use regular expressions to match multiple databases.## For example, to include all databases starting with "mydb", use "^mydb.*".## By default, include is set to ".*" and all databases are included.#include:- "^mydb.*"## @param exclude - list of strings - optional## List of databases to exclude from the autodiscovery. Use regular expressions to match multiple databases.## For example, to exclude all databases starting with "mydb", use "^mydb.*".## When the exclude list conflicts with include list, the exclude list takes precedence.#exclude:- "^mydb2.*"- "admin$"## @param max_databases - integer - optional## Maximum number of databases to collect metrics from. The default value is 100.#max_databases:100## @param refresh_interval - integer - optional## Interval in seconds to refresh the list of databases. The default value is 600 seconds.#refresh_interval:600
An example configuration for a replica set with 1 primary and 2 secondaries is as follows:
To monitor a MongoDB sharded cluster, the Agent needs to connect to the mongos router(s) and all members of the shards. If you have multiple mongos routers, you can configure the Agent to connect to them for load balancing.
Use the following configuration block as an example to configure the Agent to connect to a Mongos router:
init_config:instances:## @param hosts - required## For a sharded cluster, you need one check instance for each mongod instance in## each shard (including the configsvr shard) as well as one additional check instance## that connects to at least one mongos node.## Specify the hostname, IP address, or UNIX domain socket of the mongod or mongos instance.## If the port number is not specified, the default port 27017 is used.- hosts:- <HOST>:<PORT>## @param username - string - optional## The username to use for authentication.#username:datadog## @param password - string - optional## The password to use for authentication.#password:"ENC[datadog_user_database_password]"## @param options - mapping - optional## Connection options. For a complete list, see:## https://docs.mongodb.com/manual/reference/connection-string/#connections-connection-options#options:authSource:admin## @param tls - boolean - optional## Set to true to connect to the MongoDB instance using TLS.#tls:true## @param dbm - boolean - optional## Set to true to enable Database Monitoring.#dbm:true## @param cluster_name - string - optional## The unique name of the cluster to which the monitored MongoDB instance belongs.## Used to group MongoDB instances in a MongoDB cluster.## Required when `dbm` is enabled.#cluster_name:<MONGO_CLUSTER_NAME>## @param reported_database_hostname - string - optional## Set the reported database hostname for the connected MongoDB instance.## This value overrides the MongoDB hostname detected by## the Agent from the MongoDB admin command serverStatus.host.#reported_database_hostname:<DATABASE_HOSTNAME_OVERRIDE>## @param database_autodiscovery - mapping - optional## Enable database autodiscovery to automatically collect metrics from all your MongoDB databases.#database_autodiscovery:## @param enabled - boolean - required## Enable database autodiscovery.#enabled:true## @param include - list of strings - optional## List of databases to include in the autodiscovery. Use regular expressions to match multiple databases.## For example, to include all databases starting with "mydb", use "^mydb.*".## By default, include is set to ".*" and all databases are included.#include:- "^mydb.*"## @param exclude - list of strings - optional## List of databases to exclude from the autodiscovery. Use regular expressions to match multiple databases.## For example, to exclude all databases starting with "mydb", use "^mydb.*".## When the exclude list conflicts with include list, the exclude list takes precedence.#exclude:- "^mydb2.*"- "admin$"## @param max_databases - integer - optional## Maximum number of databases to collect metrics from. The default value is 100.#max_databases:100## @param refresh_interval - integer - optional## Interval in seconds to refresh the list of databases. The default value is 600 seconds.#refresh_interval:600
Refer to the Replica Set configuration for an example configuration for connecting to members in each shard and the config server.
An example configuration for a sharded cluster with 1 mongos router and 2 shards is as follows:
Place the MongoDB Agent configuration file created in the previous step in /etc/datadog-agent/conf.d/mongo.d/conf.yaml. See the sample conf file for all available configuration options.
To configure the Database Monitoring Agent running in a Docker container, set the Autodiscovery Integration Templates as Docker labels on your Agent container.
The MongoDB check is included in the Datadog Agent. No additional installation is necessary.
Note: The Agent must have read permission on the Docker socket for autodiscovery of labels to work.
Add the configuration details for the MongoDB check from the previous step in the com.datadoghq.ad.checks label. See the sample conf file for all available configuration options.
If you have a Kubernetes cluster, use the Datadog Cluster Agent for Database Monitoring.
If cluster checks are not already enabled in your Kubernetes cluster, follow the instructions to enable cluster checks. You can configure the Cluster Agent either with static files mounted in the Cluster Agent container, or by using Kubernetes service annotations.
Command line with Helm
Execute the following Helm command to install the Datadog Cluster Agent on your Kubernetes cluster. Replace the values to match your account and environment:
To configure a cluster check with a mounted configuration file, mount the configuration file in the Cluster Agent container on the path: /conf.d/mongo.yaml:
cluster_check:true# Make sure to include this flaginit_config:instances:- hosts:- <HOST>:<PORT>username:datadogpassword:"ENC[datadog_user_database_password]"options:authSource:admindbm:truecluster_name:<MONGO_CLUSTER_NAME>reported_database_hostname:<DATABASE_HOSTNAME_OVERRIDE>database_autodiscovery:enabled:trueadditional_metrics:["metrics.commands","tcmalloc","top","collection"]collections_indexes_stats:true
Configure with Kubernetes service annotations
Rather than mounting a file, you can declare the instance configuration as a Kubernetes Service. To configure this check for an Agent running on Kubernetes, create a Service in the same namespace as the Datadog Cluster Agent:
The Cluster Agent automatically registers this configuration and begins running the MongoDB integration.
To avoid exposing the datadog user’s password in plain text, use the Agent’s secret management package and declare the password using the ENC[] syntax.
Database Monitoring for MongoDB captures slow operations from either MongoDB slow query logs or the system.profile collection. Slow operations are defined as those taking longer than the slowms threshold set in your MongoDB configuration.
With Database Profiling Enabled: When profiling is enabled at levels 1 or 2, Database Monitoring collects slow operations from the system.profile collection.
With Database Profiling Disabled: If profiling is disabled, Database Monitoring relies on MongoDB slow query logs to gather slow operations.
Operation Samples and Explain Plans
Database Monitoring for MongoDB gathers operation samples using the currentOp command. This command provides information about currently executing operations in the MongoDB instance. Additionally, Database Monitoring collects explain plans for the read operation samples using the explain command, offering detailed insights into the query execution plans.
Replication State Changes
Database Monitoring for MongoDB generates an event each time there is a change in the replication state within the MongoDB instance. This ensures that any changes in replication are promptly detected and reported.
Collection of Schemas and Indexes
Database Monitoring for MongoDB collects inferred schemas and indexes of MongoDB collections. This information is used to provide insights into the structure and organization of your collections.
When analyzing MongoDB collections, Datadog collects inferred schema information by sampling documents using the $sample aggregation stage. From this analysis, only metadata about the schema is gathered and sent to Datadog, including field names, field prevalence (how often each field appears), and their respective data types. Datadog does not collect or transmit the actual content of documents or any customer business data. This ensures that sensitive data remains protected while still providing valuable insights into the structure and organization of your collections.
