​

Mongodb Receiver

​

Supported Telemetry

​

Overview

​

Purpose

​

Prerequisites

• 4.0+
• 5.0
• 6.0
• 7.0

​

Configuration

• hosts (default: [localhost:27017]): list of host:port or unix domain socket endpoints.The transport option is no longer available.
  • For standalone MongoDB deployments this is the hostname and port of the mongod instance
  • For replica sets specify the hostnames and ports of the mongod instances that are in the replica set configuration. If the replica_set field is specified, nodes will be autodiscovered.
  • For a sharded MongoDB deployment, please specify a list of the mongos hosts.
• scheme (default: mongodb): connection scheme. Use mongodb+srv for clusters that use SRV DNS records (e.g. MongoDB Atlas). When using mongodb+srv, exactly one host must be specified.
• username: If authentication is required, the user can with clusterMonitor permissions can be provided here.
• password: If authentication is required, the password can be provided here.
• auth_mechanism: (optional) The authentication mechanism to use. Common values include SCRAM-SHA-1, SCRAM-SHA-256, MONGODB-X509, GSSAPI, MONGODB-AWS, etc. If not specified, MongoDB will use the default mechanism.
• auth_source: (optional) The database name to use for authentication. If not specified, MongoDB will use the default authentication database (usually admin).
• auth_mechanism_properties: (optional) A map of key-value pairs specifying additional properties for the authentication mechanism. For example, when using GSSAPI (Kerberos), you may need to set SERVICE_NAME. For MONGODB-AWS, you may need to set AWS_SESSION_TOKEN when using temporary AWS credentials.
• collection_interval: (default = 1m): This receiver collects metrics on an interval. This value must be a string readable by Golang’s time.ParseDuration. Valid time units are ns, us (or µs), ms, s, m, h.
• initial_delay (default = 1s): defines how long this receiver waits before starting.
• replica_set: If the deployment of MongoDB is a replica set then this allows users to specify the replica set name which allows for autodiscovery of other nodes in the replica set.
• timeout: (default = 1m) The timeout of running commands against mongo.
• tls: TLS control. By default, insecure settings are rejected and certificate verification is on.
• direct_connection: If true, then the driver will not try to autodiscover other nodes, and perform instead a direct connection o the host.

​

Example Configuration

receivers:
  mongodb:
    hosts:
      - endpoint: localhost:27017
    username: otel
    password: ${env:MONGODB_PASSWORD}
    collection_interval: 60s
    initial_delay: 1s
    tls:
      insecure: true
      insecure_skip_verify: true

​

Example Configuration (MongoDB Atlas / SRV)

receivers:
  mongodb:
    hosts:
      - endpoint: cluster0.example.mongodb.net
    scheme: mongodb+srv
    username: otel
    password: ${env:MONGODB_PASSWORD}
    collection_interval: 60s

​

Authentication

​

SCRAM (Default)

receivers:
  mongodb:
    hosts:
      - endpoint: localhost:27017
    username: otel
    password: ${env:MONGODB_PASSWORD}
    collection_interval: 60s
    initial_delay: 1s
    tls:
      insecure: true

receivers:
  mongodb:
    hosts:
      - endpoint: localhost:27017
    username: otel
    password: ${env:MONGODB_PASSWORD}
    auth_mechanism: SCRAM-SHA-256
    auth_source: admin
    collection_interval: 60s
    initial_delay: 1s
    tls:
      insecure: true

​

X.509 Certificate Authentication

receivers:
  mongodb:
    hosts:
      - endpoint: localhost:27018
    auth_mechanism: MONGODB-X509
    auth_source: $external
    collection_interval: 60s
    initial_delay: 1s
    tls:
      ca_file: /path/to/ca.pem
      cert_file: /path/to/client-cert.pem
      key_file: /path/to/client-key.pem

openssl x509 -in client.pem -out client-cert.pem

# Extract the private key
openssl pkey -in client.pem -out client-key.pem

​

MONGODB-AWS (IAM Authentication)

receivers:
  mongodb:
    hosts:
      - endpoint: mongodb-host:27017
    username: ${env:AWS_ACCESS_KEY_ID}
    password: ${env:AWS_SECRET_ACCESS_KEY}
    auth_mechanism: MONGODB-AWS
    auth_source: $external
    auth_mechanism_properties:
      AWS_SESSION_TOKEN: ${env:AWS_SESSION_TOKEN}
    collection_interval: 60s
    initial_delay: 1s
    tls:
      insecure: true

receivers:
  mongodb:
    hosts:
      - endpoint: mongodb-host:27017
    auth_mechanism: MONGODB-AWS
    auth_source: $external
    collection_interval: 60s
    initial_delay: 1s

​

GSSAPI (Kerberos)

• The collector to be compiled with the gssapi build tag and cgo support (CGO_ENABLED=1).
• On Linux, the libkrb5 library must be installed.

Note: The default otelcontribcol binary is built without the gssapi build tag and with CGO_ENABLED=0, so GSSAPI authentication will not work out of the box. You will need to build a custom collector with CGO_ENABLED=1 and the gssapi build tag to use this mechanism.

receivers:
  mongodb:
    hosts:
      - endpoint: mongodb-host:27017
    username: [email protected]
    auth_mechanism: GSSAPI
    auth_source: $external
    auth_mechanism_properties:
      SERVICE_NAME: mongodb
    collection_interval: 60s
    initial_delay: 1s

​

Metrics

• mongodb.extent.count < 4.4 with mmapv1 storage engine

​

Feature gate configurations

​

Metrics

​

Attributes

​

Resource Attributes

​

Configuration

​

Example Configuration

mongodb:
  hosts:
    - endpoint: localhost:27017
  username: otel
  password: ${env:MONGO_PASSWORD}
  auth_mechanism: SCRAM-SHA-256
  auth_source: admin
  auth_mechanism_properties:
    SERVICE_NAME: mongodb
  collection_interval: 60s

mongodb/srv:
  hosts:
    - endpoint: cluster0.example.mongodb.net
  scheme: mongodb+srv
  username: otel
  password: ${env:MONGO_PASSWORD}
  collection_interval: 60s