Monitoring MongoDB

The sensor supports the same operating systems as the Instana host agents. For details, refer to the Supported Operating Systems section for each host agent, such as:

• Supported operating systems for Unix
• Supported operating systems for Windows
• Supported operating systems for Linux

The sensor supports the following MongoDB and MongoDB Atlas versions:

• MongoDB 3.2.x
• MongoDB 3.4.x
• MongoDB 3.6.x
• MongoDB 4.0.x
• MongoDB and MongoDB Atlas 4.2.x
• MongoDB and MongoDB Atlas 4.4.x
• MongoDB and MongoDB Atlas 5.0.x
• MongoDB and MongoDB Atlas 6.0.x
• MongoDB and MongoDB Atlas 7.0.x
• MongoDB and MongoDB Atlas 8.0.4

The following table shows the latest supported version and support policy:

For more information about the support policy, see Support strategy for sensors.

Instana supports client-side tracing for this technology in the following languages and runtimes:

• Java
• Go
• Node.js
• PHP
• Python
• .Net Framework
• .Net Core
• Ruby

No actions are required. Monitoring of MongoDB with disabled authentication happens automatically without providing any configurations in the configuration.yaml file.

To monitor MongoDB, you need to create a user with the following minimum roles:

• read - on admin database
• clusterMonitoer - on admin database
• read - on local database

In a mongo shell, create a user for the Instana Agent in the admin database:

1. Authenticate as the admin user:

   use admin
   db.auth("admin", "YOUR_MONGODB_ADMIN_PASSWORD")
    

2. For MongoDB 3.x and later versions, run the createUser command:

   db.createUser({
     "user":"stan",
     "pwd": "UNIQUEPASSWORD",
     "roles" : [
       {role: 'read', db: 'admin' },
       {role: 'clusterMonitor', db: 'admin'},
       {role: 'read', db: 'local' }
     ]
   })
    

   Note: If you use MongoDB Atlas, create the user with all assigned roles through the MongoDB Atlas management console only.

3. After the user is created, you can configure it in the agent configuration file:

   com.instana.plugin.mongodb:
     user: 'stan'
     source: 'admin'
     password: 'UNIQUEPASSWORD'
     poll_rate:
       general_metrics: 1 # general MongoDB metrics (connections, ops, etc.)
       replicaset_metrics: 30 # replica set state metrics
     host: '' # Optional: Explicit hostname or fully qualified domain name (FQDN) for MongoDB connection (for example, 'mongodb.example.com'). If not specified, the first hostname from the MongoDB bindIp configuration is used.

   Note: The default value for the general metrics interval is 1 second, and the replica set interval is 30 seconds.The source refers to the database or authentication source where the user is defined. For more information, see the MongoDB documentation .
   Note: When you monitor a MongoDB cluster or standalone instance with Instana, configure --bind_ip with specific IP addresses or leave it unset to use the default value 127.0.0.1. Do not use the bind_ip_all parameter.

The Instana agent supports remote monitoring of MongoDB Atlas clusters in different projects and organizations. For the Instana agent to be able to monitor your MongoDB Atlas organizations, it needs to be configured here <agent_install_dir>/etc/instana/configuration.yaml:

com.instana.plugin.mongodb:
  user: 'stan'
  source: 'admin'
  password: 'UNIQUEPASSWORD'
  poll_rate:
    general_metrics: 1 # general MongoDB metrics (connections, ops, etc.)
    replicaset_metrics: 30 # replica set state metrics
  atlas:
    - publicKey: 'your public key'
      privateKey: 'your private key'
    - publicKey: 'your public key'
      privateKey: 'your private key'