MongoDB Atlas receiver

The MongoDB Atlas receiver allows the Splunk Distribution of OpenTelemetry Collector to collect metrics from MongoDB Atlas through its monitoring API.

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.

Deploy the collector

See Deploy the Splunk Distribution of the OpenTelemetry Collector.

Configure the receiver

Important:

New names for multi-word components

There is an ongoing effort upstream to rename all multi-word component names to use "snake casing" (in other words, underscores between words). The following table lists the renamed receivers that the Splunk Distribution of the OpenTelemetry Collector currently conforms to:

Old name New name
azureblob azure_blob
azureeventhub azure_event_hub
azuremonitor azure_monitor
filelog file_log
httpcheck http_check
mongodbatlas mongodb_atlas
prometheusremotewrite prometheus_remote_write
tcplog tcp_log
tlscheck tls_check
udplog udp_log
windowseventlog windows_event_log
yanggrpc yang_grpc

Edit your OpenTelemetry Collector configuration file as follows.

  1. Add mongodb_atlas to the receivers section:

    YAML 
    # In this example, both values are pulled from the environment.

receivers:
  mongodb_atlas:
    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:

    YAML 
    receivers:
    mongodb_atlas:
     logs:
       enabled: true
       projects:
         - name: "Your MongoDB project"
           collect_audit_logs: true
           collect_host_logs: true

  2. If you configured the receiver to collect metrics, include it in service.pipelines.metrics. If you configured the receiver to collect logs, include it in service.pipelines.logs:

    YAML 
    service:
  pipelines:
    metrics:
      receivers: [mongodb_atlas]
   logs:
      receivers: [mongodb_atlas]
Note: To access Audit and Host logs, the API key must have the Project Data Access Read Only or higher role.

Advanced configurations

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:

YAML 
receivers:
  samplereceiver:
    metrics:
      metric-one:
        enabled: true
      metric-two:
        enabled: false

The following is an example of host metrics receiver configuration with activated metrics:

YAML 
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).

Settings reference

The following table shows the configuration options for the MongoDB Atlas receiver:

included

https://raw.githubusercontent.com/splunk/collector-config-tools/main/cfg-metadata/receiver/mongodbatlas.yaml

Metrics reference

The following metrics, resource attributes, and attributes are available.

included

https://raw.githubusercontent.com/splunk/collector-config-tools/main/metric-metadata/mongodbatlasreceiver.yaml

Troubleshooting

See Troubleshoot the Splunk OpenTelemetry Collector.