Integrate a MongoDB instance

Requirements

The following table lists the MongoDB versions, deployment types, and connection behavior that the MongoDB integration component supports.

Prerequisites

• Managed Service for Prometheus is activated.

• For CS environments: The target ACK cluster is connected to Cloud Monitor 2.0 and is running. The target MongoDB service is accessible from within the cluster network.

• For ECS (VPC) environments: The ECS instance that hosts the target MongoDB is selected, and the vSwitch CIDR block for the managed agent can access this ECS instance.

Billing

• Billing is based solely on the volume of metric data generated in Billing overview.

Integration methods

Step 1: Create a monitoring account (if needed)

If access authentication (auth) is enabled for your instance, create a monitoring account with the clusterMonitor role. You can skip this step if authentication is not enabled.

use admin
db.createUser({
  user: "exporter",
  pwd: "<password>",
  roles: [ { role: "clusterMonitor", db: "admin" } ]
})

Step 2: Select an integration environment

This plugin supports two access environments: CS and ECS(VPC). These environments work differently. Select an environment based on where your MongoDB instance is deployed.

CS

• The Exporter is installed in a specified ACK cluster, and the existing data collector in that cluster is reused to collect metrics.

• The monitored object is the ACK cluster.

• Network requirements: The target MongoDB service must be accessible from the cluster network. For example, the service can be located within the cluster or have a private IP address in a VPC that the cluster can access.

ECS (VPC)

• A fully managed data collector is deployed based on the VPC information of the ECS instance where the target MongoDB service is deployed.

• No processes are installed on the ECS instance.

• The monitored object is the ECS instance.

• Network requirements: The vSwitch CIDR block where the managed data collector resides must allow access to the target ECS instance. Security groups, Access Control Lists (ACLs), and other network rules must be configured to allow this access.

Step 3: Configure the integration

1. Log on to the Cloud Monitor console. Select a workspace, and in the navigation pane on the left, click Integration Center. On the Integration Center page, click MongoDB.

2. Select an access environment, either CS or ECS (VPC), and then select an Observation object from the drop-down list.

3. Configure the integration parameters and click OK.

   Parameter	Required	Description
   MongoDB service endpoint	Yes	The primary connection address. In a ReplicaSet scenario, this address is used as the first seed.
   MongoDB service port	Yes	Default: 27017. This port is used for extra seeds if no port is specified for them.
   Extra seed nodes (ReplicaSet)	No	Other members of the ReplicaSet, separated by commas. Use the host or host:port format.
   ReplicaSet name	No	If specified, replicaSet= is added to the URI, and direct connection mode is disabled.
   Authentication DB	No	Default: admin.
   Direct connection mode	No	Recommended for single-node deployments. This setting is ignored and automatically disabled if a ReplicaSet name or extra seeds are configured.
   Cloud vendor / Deployment source	No	Writes to the provider label. For self-hosted deployments, the value is self-hosted/mongodb.
   MongoDB username/password	No	Required if authentication is enabled. The account needs the clusterMonitor role.
   Metric collection interval (seconds)	Yes	Default: 15.
   Custom tags	No	Extra labels to inject into metrics.
   Use public image repository address	No	Disabled by default. Enable this option if the internal image repository is inaccessible.

4. After the integration is successful, you can find the integrated entities and their observable data in Entity Explorer.

Data usage

Entities

After integration, Cloud Monitor periodically discovers MongoDB instances from the labels of metrics such as mongodb_up and creates middleware entities.

Entity fields are derived from collected labels and are independent of the number of installations.

You can retrieve instances using these fields in the Entity Explorer or Middleware Insight application.

Built-in dashboards

Core metrics

The following list contains all 30 metrics from the middleware.metric.mongodb entity dataset. You can use these metrics directly in entity details, dashboards, and alerts.

Common query examples

# Up
mongodb_up

# Current connections
mongodb_connections{state="current"}

# Operation rate (by type)
rate(mongodb_op_counters_total[5m])

Alert templates

This integration component does not have built-in alert rules. You can configure alerts in the Alert Center based on the metrics. For example, you can set an alert for scenarios where the mongodb_up metric is not 1, or when the number of connections or message accumulation exceeds a threshold.

Storage policies

After you integrate MongoDB, Cloud Monitor creates a corresponding storage instance to store observable data.

Manage or remove the integration

To modify or cancel the integration, go to the Integration Management page of Integration Center, find the corresponding integration policy, and then click Edit or Delete. When you delete the integration policy, the Exporter and the collection configuration are removed together. Historical metrics that have already been written are retained based on the lifecycle policy of the storage.