MongoDB module

This module periodically fetches metrics from MongoDB servers.

When configuring the hosts option, you must use MongoDB URLs of the following format:

[mongodb://][user:pass@]host[:port][?options]

Or

mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]

The URL can be as simple as:

- module: mongodb
  hosts: ["localhost"]

Or more complex like:

- module: mongodb
  hosts: ["mongodb://myuser:mypass@localhost:40001", "otherhost:40001"]

Some more supported URLs are:

- module: mongodb
  hosts: ["mongodb://localhost:27017,localhost:27022,localhost:27023"]

- module: mongodb
  hosts: ["mongodb://localhost:27017/?directConnection=true"]

When the parameter directConnection=true is included in the connection URI, all operations are executed on the host specified in the URI. It’s important to note that directConnection=true must be explicitly specified in the URI, as it won’t be added automatically unless specified.

- module: mongodb
  hosts: ["mongodb://localhost:27017,localhost:27022,localhost:27023/?replicaSet=dbrs"]

The username and password can be included in the URL or they can be set using the respective configuration options. The credentials in the URL take precedence over the username and password configuration options.

- module: mongodb
  metricsets: ["status"]
  hosts: ["localhost:27017"]
  username: root
  password: test

The default metricsets are collstats, dbstats and status.

The MongoDB metricsets were tested with MongoDB 5.0 and are expected to work with all versions >= 5.0.

In order to use the metricsets, the MongoDB user specified in the module configuration needs to have certain privileges.

We recommend using the clusterMonitor role to cover all the necessary privileges.

You can use the following command in Mongo shell to create the privileged user (make sure you are using the admin db by using db command in Mongo shell).

db.createUser(
    {
        user: "beats",
        pwd: "pass",
        roles: ["clusterMonitor"]
    }
)

You can use the following command in Mongo shell to grant the role to an existing user (make sure you are using the admin db by using db command in Mongo shell).

db.grantRolesToUser("user", ["clusterMonitor"])

The MongoDB module supports the standard configuration options that are described in Modules. Here is an example configuration:

metricbeat.modules:
- module: mongodb
  metricsets: ["dbstats", "status", "collstats", "metrics", "replstatus"]
  period: 10s
  enabled: true

  # The hosts must be passed as MongoDB URLs in the format:
  # [mongodb://][user:pass@]host[:port].
  # The username and password can also be set using the respective configuration
  # options. The credentials in the URL take precedence over the username and
  # password configuration options.
  hosts: ["localhost:27017"]

  # Optional SSL. By default is off.
  #ssl.enabled: true

  # Mode of verification of server certificate ('none' or 'full')
  #ssl.verification_mode: 'full'

  # List of root certificates for TLS server verifications
  #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]

  # Certificate for SSL client authentication
  #ssl.certificate: "/etc/pki/client/cert.pem"

  # Client Certificate Key
  #ssl.key: "/etc/pki/client/cert.key"

  # Username to use when connecting to MongoDB. Empty by default.
  #username: user

  # Password to use when connecting to MongoDB. Empty by default.
  #password: pass

This module supports TLS connections when using ssl config field, as described in SSL.

The following metricsets are available:

• collstats
• dbstats
• metrics
• replstatus
• status