Alibaba Cloud¶

Alibaba Cloud MongoDB replica set Metrics display, including CPU usage, memory usage, disk usage, data occupied disk space, log occupied disk space, statements executed per second, request count, connection count, network traffic, replication delay, QPS, etc.

Alibaba Cloud MongoDB sharding cluster Metrics display, including CPU usage, memory usage, disk usage, data occupied disk space, log occupied disk space, statements executed per second, request count, connection count, network traffic, replication delay, QPS, etc.

Alibaba Cloud MongoDB single-node instance Metrics display, including CPU usage, memory usage, disk usage, data occupied disk space, statements executed per second, request count, connection count, network traffic, QPS, etc.

Configuration¶

Install Func¶

It is recommended to enable the Guance integration - extension - DataFlux Func (Automata)

If you deploy Func yourself, refer to Self-deployed Func

Enable Script¶

Note: Please prepare an Alibaba Cloud AK that meets the requirements in advance (for simplicity, you can directly grant global read-only permission ReadOnlyAccess).

Managed Version Enable Script¶

1. Log in to the Guance console.
2. Click on the 【Manage】 menu and select 【Cloud Account Management】.
3. Click 【Add Cloud Account】, select 【Alibaba Cloud】, and fill in the required information on the interface. If you have already configured cloud account information, skip this step.
4. Click 【Test】, if the test is successful, click 【Save】. If the test fails, check whether the related configuration information is correct and retest.
5. In the 【Cloud Account Management】 list, you can see the added cloud account. Click the corresponding cloud account to enter the details page.
6. Click the 【Integration】 button on the cloud account details page. Under the Not Installed list, find Alibaba Cloud MongoDB, click the 【Install】 button, and install it in the pop-up installation interface.

Manual Enable Script¶

1. Log in to the Func console, click 【Script Market】, enter the official script market, and search for guance_aliyun_mongodb.
2. After clicking 【Install】, input the corresponding parameters: Alibaba Cloud AK ID, AK Secret, and account name.
3. Click 【Deploy Start Script】, the system will automatically create a Startup script set and automatically configure the corresponding start script.
4. After enabling, you can see the corresponding automatic trigger configuration in 「Management / Automatic Trigger Configuration」. Click 【Execute】 to immediately execute once without waiting for the scheduled time. Wait a moment, and you can view the execution task records and corresponding logs.

We default collect some configurations, see Metrics section for details.

Customize cloud object Metrics

Verification¶

1. In 「Management / Automatic Trigger Configuration」, confirm whether the corresponding tasks have been configured with automatic triggers. You can also check the corresponding task records and logs to ensure there are no abnormalities.
2. In Guance, 「Infrastructure / Custom」, check if asset information exists.
3. In Guance, 「Metrics」, check if corresponding monitoring data exists.

Metrics¶

After configuring Alibaba Cloud - Cloud Monitor, the default collected Metrics are as follows. More Metrics can be collected through configuration. For more Metrics, please refer to: Alibaba Cloud Cloud Monitor Metrics Details

Cloud Database MongoDB Edition - Replica Set¶

Cloud Database MongoDB Edition - Sharding Cluster¶

Cloud Database MongoDB Edition - Single Node Instance¶

Objects¶

Collected Alibaba Cloud MongoDB object data structure, which can be seen from 「Infrastructure - Custom」.

{
  "measurement": "aliyun_mongodb",
  "tags": {
    "name"                 : "dds-bpxxxxxxxx",
    "DBInstanceType"       : "replicate",
    "ChargeType"           : "PrePaid",
    "Engine"               : "MongoDB",
    "DBInstanceClass"      : "dds.xxxxxxxx",
    "DBInstanceId"         : "dds-bpxxxxxxx",
    "ZoneId"               : "cn-hangzhou",
    "RegionId"             : "cn-hangzhou-h",
    "VPCId"                : "vpc-bpxxxxxxxx",
    "EngineVersion"        : "4.2",
    "CurrentKernelVersion" : "mongodb_20210204_4.0.14",
    "StorageEngine"        : "WiredTiger",
    "DBInstanceDescription": "Business System",
    "LockMode"             : "Unlock",
  },
  "fields": {
    "ExpireTime"       : "2020-11-18T08:47:11Z",
    "DBInstanceStorage": "20",
    "ReplicaSets"      : "{Connection address JSON data}",
    "message"          : "{Instance JSON data}",
  }
}

Logs¶

Slow Query Logs¶

Prerequisites¶

Note: The code execution of this script depends on the collection of MongoDB instance objects. If MongoDB custom object collection has not been configured, the slow log script will not be able to collect slow log data.

Install the Slow Query Collection Script¶

On top of the previous setup, you need to install another script corresponding to MongoDB slow query collection.

In the 「Script Market - Official Script Market」, go to 「Details」, and click to install the corresponding script package:

• 「Guance Integration (Alibaba Cloud - MongoDB Slow Query Log Collection)」(ID: guance_aliyun_mongodb)

After the data synchronizes normally, you can view the data in the 「Logs」 section of Guance.

An example of the reported data is as follows:

{
  "measurement": "aliyun_mongodb_slowlog",
  "tags": {
    "name"                 : "dds-bpxxxxxxxx",
    "DBInstanceType"       : "replicate",
    "ChargeType"           : "PrePaid",
    "Engine"               : "MongoDB",
    "DBInstanceClass"      : "dds.xxxxxxxx",
    "DBInstanceId"         : "dds-bpxxxxxxx",
    "ZoneId"               : "cn-hangzhou",
    "RegionId"             : "cn-hangzhou-h",
    "VPCId"                : "vpc-bpxxxxxxxx",
    "EngineVersion"        : "4.2",
    "CurrentKernelVersion" : "mongodb_20210204_4.0.14",
    "StorageEngine"        : "WiredTiger",
    "DBInstanceDescription": "Business System",
    "DBName"               : "local",
    "AccountName"          : "AliCloud Account for Script Development",
    "HostAddress"          : "11.xxx.xxx.xx",
    "TableName"            : "oplog",
  },
  "fields": {
    "SQLText"           : "{SQL Statement}",
    "ExecutionStartTime": "1",
    "QueryTimes"        : "1",
    "ReturnRowCounts"   : "1",
    "KeysExamined"      : "1",
    "DocsExamined"      : "1",
  }
}

Descriptions of some parameters are as follows:

Note: Fields in tags and fields may change with subsequent updates.

Note: fields.message is a string after JSON serialization.