New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Memcached stats metricset MongoDB collstats metricset »
Elastic Docs ›Metricbeat Reference [6.4] ›Modules

MongoDB module

edit

MongoDB module

edit

This module periodically fetches metrics from MongoDB servers.

Module-specific configuration notes

edit

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

[mongodb://][user:pass@]host[:port][?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"]

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.

Compatibility

edit

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

Example configuration

edit

The MongoDB module supports the standard configuration options that are described in Specify which modules to run. Here is an example configuration:

metricbeat.modules:
- module: mongodb
  metricsets: ["dbstats", "status"]
  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 Specify SSL settings.

Metricsets

edit

The following metricsets are available:

« Memcached stats metricset MongoDB collstats metricset »

On this page

Was this helpful?
Feedback