MongoDB Atlas receiver π
The MongoDB Atlas receiver allows the Splunk Distribution of the OpenTelemetry Collector to collect metrics and logs from MongoDB Atlas through its monitoring API. The supported pipeline types are metrics
and logs
. See Process your data with pipelines for more information.
Database metrics are dimensionalized by project and database attributes, for example, project_name
and
database_name
.
Note
Use the MongoDB Atlas receiver in place of the deprecated SignalFx Smart Agent mongodb-atlas
monitor type.
Get started π
Follow these steps to configure and activate the component:
Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:
Configure the MongoDB Atlas receiver as described in the next section.
Restart the Collector.
Sample configurations π
To activate the MongoDB Atlas receiver, add mongodbatlas
to the receivers
section of your
configuration file, as shown in the following example:
# In this example, both values are pulled from the environment.
receivers:
mongodbatlas:
public_key: ${MONGODB_ATLAS_PUBLIC_KEY}
# You can obtain the public key from the API Keys tab of the MongoDB Atlas Project Access Manager.
# This value is required.
private_key: ${MONGODB_ATLAS_PRIVATE_KEY}
# You can obtain the private key from the API Keys tab of the MongoDB Atlas Project Access Manager.
# This value is required.
The following example shows how to collect logs:
receivers:
mongodbatlas:
logs:
enabled: true
projects:
- name: "Your MongoDB project"
collect_audit_logs: true
collect_host_logs: true
To complete the configuration, include the receiver in the metrics
or logs
pipelines of the service
section of your configuration file. For example:
service:
pipelines:
metrics:
receivers: [mongodbatlas]
logs:
receivers: [mongodbatlas]
Note
To access Audit and Host logs, the API key must have the Project Data Access Read Only or higher role.
Settings π
The following table shows the configuration options for the MongoDB Atlas receiver:
Metrics π
The following metrics, resource attributes, and attributes are available.
Activate or deactivate specific metrics π
You can activate or deactivate specific metrics by setting the enabled
field in the metrics
section for each metric. For example:
receivers:
samplereceiver:
metrics:
metric-one:
enabled: true
metric-two:
enabled: false
The following is an example of host metrics receiver configuration with activated metrics:
receivers:
hostmetrics:
scrapers:
process:
metrics:
process.cpu.utilization:
enabled: true
Note
Deactivated metrics arenβt sent to Splunk Observability Cloud.
Billing π
If youβre in a MTS-based subscription, all metrics count towards metrics usage.
If youβre in a host-based plan, metrics listed as active (Active: Yes) on this document are considered default and are included free of charge.
Learn more at Infrastructure Monitoring subscription usage (Host and metric plans).
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 in the Get Started with Splunk Community manual.