MongoDB (deprecated)

Use this Splunk Observability Cloud integration for the MongoDB monitor. See benefits, install, configuration, and metrics.

Note: The MongoDB monitor is deprecated and will reach end of support on January 15, 2025. During this period, only critical security and bug fixes are provided. When the monitor reaches end of support, you won’t be able to use it to send data to Splunk Observability Cloud. To monitor your MongoDB databases, you can instead use the native OpenTelemetry MongoDB receiver. See MongoDB receiver to learn more.

The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the MongoDB monitor type to capture the following metrics about MongoDB:

Memory
Network input/output bytes count
Heap usage
DB connections
Operations count
Active client connections
Queued operations

The plugin also captures the following DB-specific metrics:

DB size
DB counters

Prerequisites

The following applies:

This integration is only available on Kubernetes and Linux.
This integration requires MongoDB 2.6 or higher.
This integration is not supported for Splunk OTel Collector versions 0.99.0 or higher. Use the MongoDB receiver instead.

Benefits

After you configure the integration, you can access these features:

View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Splunk Observability Cloud.
View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Use navigators in Splunk Infrastructure Monitoring.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Search the Metric Finder and Metadata Catalog.

Installation

Follow these steps to deploy this integration:

Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
- Install on Kubernetes
- Install on Linux
Configure the monitor, as described in the Configuration section.
Restart the Splunk Distribution of OpenTelemetry Collector.

Authentication

If you’re monitoring a secured MongoDB deployment, create a MongoDB user with minimal read-only roles, as follows:

db.createUser( {
  user: "<username>",
  pwd: "<password>",
  roles: [ { role: "readAnyDatabase", db: "admin" }, { role: "clusterMonitor", db: "admin" } ]
});

Note: Only SCRAM-SHA-1 authentication is supported.

Configuration

To use this integration of a Smart Agent monitor with the Collector:

Include the Smart Agent receiver in your configuration file.
Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.
- See how to Use Smart Agent monitors with the Collector.
- See how to set up the Smart Agent receiver.
- For a list of common configuration options, refer to Common configuration settings for monitors.
- Learn more about the Collector at Get started: Understand and use the Collector.

Example

To activate this integration, add the following to your Collector configuration:

receivers:
  smartagent/mongodb:
    type: collectd/mongodb
    ...  # Additional config

Next, add the monitor to the service.pipelines.metrics.receivers section of your configuration file:

service:
  pipelines:
    metrics:
      receivers: [smartagent/mongodb]

Configuration settings

The following table shows the configuration options for the MongoDB monitor:


Option	Required	Type	Description
`pythonBinary`	No	`string`	Path to the Python binary. If not set, a built-in runtime is used. This setting can include arguments to the binary.
`host`	Yes	`string`	Hostname or IP address of the MongoDB instance.
`port`	Yes	`integer`	Port of the MongoDB instance. The default value is `27017`.
`databases`	Yes	`list of strings`	Name of the databases you want to monitor. The first database in this list must be `admin`, as it’s used to perform a `serverStatus()` call.
`username`	No	`string`	MongoDB user.
`password`	No	`string`	Password of the user defined in `username`.
`useTLS`	No	`bool`	If `true`, the monitor connects to MongoDB using TLS. The default value is `false`.
`caCerts`	No	`string`	Path to a CA cert used to verify the certificate that MongoDB presents. Not needed if not using TLS or if MongoDB certificate is signed by a globally trusted issuer already installed in the default location on your system.
`tlsClientCert`	No	`string`	Path to a client certificate. Not needed unless your MongoDB instance requires x509 client verification.
`tlsClientKey`	No	`string`	Path to a client certificate key. Not needed unless your MongoDB instance requires x509 client verification, or if your client certificate defined in `tlsClientCert` includes the key.
`tlsClientKeyPassPhrase`	No	`string`	Passphrase for the TLS client key defined in `tlsClientKey`.
`sendCollectionMetrics`	No	`bool`	Whether to send collection level metrics or not. The default value is `false`.
`sendCollectionTopMetrics`	No	`bool`	Whether to send collection level top timing metrics or not. The default value is `false`.

Note: When using TLS authentication, SCRAM-SHA-256 is not supported. Use SCRAM-SHA-1 authentication.

Troubleshooting

If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.

Available to Splunk Observability Cloud customers

Submit a case in the Splunk Support Portal.
Contact Splunk Support.

Available to prospective customers and free trial users

Ask a question and get answers through community support at Splunk Answers.
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups.

Documentation