MongoDB Atlas (deprecated) 🔗

Note

This monitor is deprecated in favor of the Otel native component mongodbatlas receiver. See MongoDB Atlas Receiver for more information.

The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the MongoDB Atlas monitor type to provide MongoDB as an on-demand fully managed service. Atlas exposes MongoDB cluster monitoring and logging data through its monitoring and logs REST API endpoints. These Atlas monitoring API resources are grouped into measurements for MongoDB processes, host disks, and MongoDB databases.

This integration repeatedly scrapes MongoDB monitoring data from Atlas at the configured time interval. It scrapes the process and disk measurements into metric groups called mongodb and hardware. The original measurement names are included in the metric descriptions.

A set of data points are fetched at the configured granularity and period for each measurement. Metric values are set to the latest non-empty data point value in the set. The finest granularity supported by Atlas is 1 minute. The configured period for the monitor type needs to be wider than the interval at which Atlas provides values for measurements, otherwise some of the sets of fetched data points will contain only empty values. The default configured period is 20 minutes, which works across all measurements and gives a reasonable response payload size.

Configuration settings 🔗

The following table shows the configuration options for the mongodb-atlas monitor type:

Option	Required	Type	Description
`projectID`	yes	`string`	ProjectID is the Atlas project ID
`publicKey`	yes	`string`	PublicKey is the Atlas public API key
`privateKey`	yes	`string`	PrivateKey is the Atlas private API key
`timeout`	no	`integer`	Timeout for HTTP requests to get MongoDB process measurements from Atlas. This should be a duration string that is accepted by `func ParseDuration` (default: `5s`)
`enableCache`	no	`bool`	Activates locally cached Atlas metric measurements to be used when true. The metric measurements that were supposed to be fetched are in fact always fetched asynchronously and cached. (default: `true`)
`granularity`	no	`string`	Granularity is the duration in ISO 8601 notation that specifies the interval between measurement data points from Atlas over the configured period. The default is shortest duration supported by Atlas of 1 minute. (default: `PT1M`)
`period`	no	`string`	Period the duration in ISO 8601 notation that specifies how far back in the past to retrieve measurements from Atlas. (default: `PT20M`)

Metrics 🔗

The following metrics are available for this integration:

Notes 🔗

Learn more about the available metric types in Observability Cloud.
Default metrics are those metrics included in host-based subscriptions in Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See more about metric categories.
To add additional metrics, see how to configure extraMetrics using the Collector.

Troubleshooting 🔗

If you are not able to see your data in Splunk Observability Cloud, try these tips:

Submit a case in the Splunk Support Portal
- Available to Splunk Observability Cloud customers
Call Splunk Customer Support
- Available to Splunk Observability Cloud customers
Ask a question and get answers through community support at Splunk Answers
- Available to Splunk Observability Cloud customers and free trial users
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide
- Available to Splunk Observability Cloud customers and free trial users
- To learn how to join, see Get Started with Splunk Community - Chat groups

To learn about even more support options, see Splunk Customer Success.

Related Topics