MongoDB integration for Grafana Cloud

Before you begin

We strongly recommend that you configure a separate user for Grafana Alloy and give it only the strictly mandatory security privileges necessary for monitoring your node.

Install MongoDB integration for Grafana Cloud

1. In your Grafana Cloud stack, click Connections in the left-hand menu.
2. Find MongoDB and click its tile to open the integration.
3. Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send MongoDB metrics to your Grafana Cloud instance.
4. Click Install to add this integration’s pre-built dashboards and alerts to your Grafana Cloud instance, and you can start monitoring your MongoDB setup.

Configuration snippets for Grafana Alloy

Advanced mode

To instruct Grafana Alloy to scrape your MongoDB nodes, go though the subsequent instructions.

The snippets provide examples to guide you through the configuration process.

First, manually place the following snippets into your Grafana Alloy configuration file.

Then follow the instructions below to modify the necessary variables.

Advanced integrations snippets

river Copy

prometheus.exporter.mongodb "integrations_mongodb_exporter" {
    mongodb_uri    = "mongodb://username:password:<hostname>:27017"
    direct_connect = true
}
discovery.relabel "integrations_mongodb_exporter" {
    targets = prometheus.exporter.mongodb.integrations_mongodb_exporter.targets

    rule {
        target_label = "service_name"
        replacement  = "<your-service-name>"
    }

    rule {
        target_label = "mongodb_cluster"
        replacement  = "<your-cluster-name>"
    }

    rule {
        target_label = "instance"
        replacement  = "<your-instance-name>"
    }
}
prometheus.scrape "integrations_mongodb_exporter" {
    targets    = discovery.relabel.integrations_mongodb_exporter.output
    forward_to = [prometheus.remote_write.integrations.receiver]
    job_name   = "integrations/mongodb_exporter"
}

Add a pair of prometheus.exporter.mongodb and discovery.relabel to your Grafana Alloy configuration file for each MongoDB node you monitor, to avoid instance label conflicts.

Configure the following property within the prometheus.exporter.mongodb component:

• mongodb_uri: The URI to connect to your MongoDB node.

Refer to prometheus.exporter.mongod in Grafana Alloy reference documentation for a complete description of the configuration options.

Configure the following properties within the discovery.relabel component:

• <your-instance-name>: The instance label for all metrics from this MongoDB node.
• <your-cluster-name>: The mongodb_cluster label to group your Kafka nodes within a cluster. Set the same value for all nodes within your cluster.
• <your-service-name>: The label used to group your nodes by type, for example, “Mongos”, “ConfigServer”, “Shard”. This will be used to filter by node type on your dashboards.

Finally, reference each discovery.relabel component within the targets property of the prometheus.scrape component.

Before you begin

This integration relies on a running MongoDB instance, with a configured user and password.

We strongly recommend that you configure a separate user for the Agent, and give it only the strictly mandatory security privileges necessary for monitoring your node, as per the official documentation.

Install MongoDB integration for Grafana Cloud

1. In your Grafana Cloud stack, click Connections in the left-hand menu.
2. Find MongoDB and click its tile to open the integration.
3. Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send MongoDB metrics to your Grafana Cloud instance.
4. Click Install to add this integration’s pre-built dashboards and alerts to your Grafana Cloud instance, and you can start monitoring your MongoDB setup.

Post-install configuration for the MongoDB integration

This integration is configured to work with the mongodb_exporter, which is embedded in Grafana Agent.

Enable the integration by manually adding the provided snippet to your agent configuration file.

You must configure two custom labels for this integration:

• service_name, which is how you identify this node in your cluster (example: mongodb).
• mongodb_cluster, which is the name of your mongodb cluster, and must be set the same value for all nodes composing the cluster (example: mongodb-cluster).

The config snippet already places the necessary relabel_configs, just replace the values according to your environment and needs.

Make sure that you change the mongodb_uri according to your environment.

For a full description of configuration options see how to configure the mongodb_exporter_config block in the agent documentation.

Configuration snippets for Grafana Agent

Below integrations, insert the following lines and change the URLs according to your environment:

yaml Copy

  mongodb_exporter:
    enabled: true
    mongodb_uri: 'mongodb://username:password:<hostname>:27017' # replace with your connection string
    relabel_configs:
    - target_label: service_name
      replacement: 'mongodb'
    - target_label: mongodb_cluster
      replacement: 'your-cluster-name'
    - target_label: instance
      replacement: '<your-instance-name>'

Full example configuration for Grafana Agent

Refer to the following Grafana Agent configuration for a complete example that contains all the snippets used for the MongoDB integration. This example also includes metrics that are sent to monitor your Grafana Agent instance.

yaml Copy

integrations:
  prometheus_remote_write:
  - basic_auth:
      password: <your_prom_pass>
      username: <your_prom_user>
    url: <your_prom_url>
  agent:
    enabled: true
    relabel_configs:
    - action: replace
      source_labels:
      - agent_hostname
      target_label: instance
    - action: replace
      target_label: job
      replacement: "integrations/agent-check"
    metric_relabel_configs:
    - action: keep
      regex: (prometheus_target_sync_length_seconds_sum|prometheus_target_scrapes_.*|prometheus_target_interval.*|prometheus_sd_discovered_targets|agent_build.*|agent_wal_samples_appended_total|process_start_time_seconds)
      source_labels:
      - __name__
  # Add here any snippet that belongs to the `integrations` section.
  # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
  mongodb_exporter:
    enabled: true
    mongodb_uri: 'mongodb://username:password:<hostname>:27017' # replace with your connection string
    relabel_configs:
    - target_label: service_name
      replacement: 'mongodb'
    - target_label: mongodb_cluster
      replacement: 'your-cluster-name'
    - target_label: instance
      replacement: '<your-instance-name>'
logs:
  configs:
  - clients:
    - basic_auth:
        password: <your_loki_pass>
        username: <your_loki_user>
      url: <your_loki_url>
    name: integrations
    positions:
      filename: /tmp/positions.yaml
    scrape_configs:
      # Add here any snippet that belongs to the `logs.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
metrics:
  configs:
  - name: integrations
    remote_write:
    - basic_auth:
        password: <your_prom_pass>
        username: <your_prom_user>
      url: <your_prom_url>
    scrape_configs:
      # Add here any snippet that belongs to the `metrics.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
  global:
    scrape_interval: 60s
  wal_directory: /tmp/grafana-agent-wal