Alibaba Cloud PolarDB MySQL¶

Alibaba Cloud PolarDB MySQL Metrics Display, including CPU usage, memory hit rate, network traffic, number of connections, QPS, TPS, read-only node latency, etc.

Configuration¶

Install Func¶

It is recommended to activate the Guance integration - extension - hosted Func

If you deploy Func on your own, refer to Self-deployed Func

Activation Script¶

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

Hosted Activation Script¶

1. Log in to Guance console
2. Click on the 【Integration】 menu and select 【Cloud Account Management】
3. Click 【Add Cloud Account】, choose 【Alibaba Cloud】, fill in the required information on the interface; if cloud account information has been configured before, skip this step
4. Click 【Test】, after a successful test 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 accounts, click on 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 PolarDB MYSQL, click the 【Install】 button, and install via the pop-up installation interface.

Manual Activation Script¶

1. Log in to the Func console, click 【Script Market】, enter the official script market, search for guance_aliyun_polardb

2. After clicking 【Install】, input the corresponding parameters: Alibaba Cloud AK ID, AK Secret, and account name.

3. Click 【Deploy Startup Script】, the system will automatically create a Startup script set and configure the corresponding startup script automatically.

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, then view the task execution records and corresponding logs. `, click the 【Install】 button, and install via the pop-up installation interface.

We default to collecting some configurations, see the metrics section for more details.

Customize Cloud Object Metrics Configuration

Verification¶

1. In 「Management/Automatic Trigger Configuration」, confirm whether the corresponding tasks have the corresponding automatic trigger configuration, while checking the task records and logs for any anomalies.
2. In Guance, 「Infrastructure / Custom」 check if asset information exists.
3. In Guance, 「Metrics」 check if there are corresponding monitoring data.

Metrics¶

After configuring Alibaba Cloud - Cloud Monitoring, the default metric set is as follows. You can collect more metrics through configuration. Alibaba Cloud Cloud Monitoring Metric Details

Objects¶

The collected Alibaba Cloud PolarDB MySQL object data structure can be viewed from 「Infrastructure - Custom」.

{
  "measurement": "aliyun_polardb",
  "tags": {
    "name"                : "pc-xxxx",
    "RegionId"            : "cn-hangzhou",
    "VpcId"               : "vpc-xxxx",
    "DBNodeNumber"        : "2",
    "PayType"             : "Postpaid",
    "DBType"              : "MySQL",
    "LockMode"            : "Unlock",
    "DBVersion"           : "8.0",
    "DBClusterId"         : "pc-xxxx",
    "DBClusterNetworkType": "VPC",
    "ZoneId"              : "cn-hangzhou-i",
    "Engine"              : "POLARDB",
    "Category"            : "Normal",
    "DBClusterDescription": "pc-xxxx",
    "DBNodeClass"         : "polar.mysql.x4.medium"
  },
  "fields": {
    "DBNodes"   : "{JSON data of node list}",
    "Database"  : "[JSON data of database details]",
    "ExpireTime": "",
    "CreateTime": "2022-06-17T06:07:19Z",
    "message"   : "{JSON data of instance}"
  }
}

Logs¶

Slow Query Statistics¶

Prerequisites¶

Note: The operation of this script depends on the collection of PolarDB instance objects. If the custom object collection for PolarDB is not configured, the slow log script cannot collect slow log data.

Installation Script¶

Based on the previous setup, you need to install a script for PolarDB Slow Query Statistics Log Collection

In 「Management / Script Market」, click and install the corresponding script package:

• 「Guance Integration (Alibaba Cloud - PolarDB Slow Query Statistics Log Collection)」(ID: guance_aliyun_polardb_slowlog)

After the data synchronization is normal, you can view the data in the 「Logs」 section of Guance.

An example of the reported data is as follows:

{
  "measurement": "aliyun_polardb_slowlog",
  "tags": {
    "DBName"  : "PolarDB_MySQL",
    "DBNodeId": "pi-***************"
  },
  "fields": {
    "CreateTime"          : "2023-05-22Z",
    "MaxExecutionTime"    : 60,
    "MaxLockTime"         : 1,
    "ParseMaxRowCount"    : 1,
    "ParseTotalRowCounts" : 2,
    "ReturnMaxRowCount"   : 3,
    "ReturnTotalRowCounts": 1,
    "SQLHASH"             : "U2FsdGVkxxxx",
    "SQLText"             : "select id,name from tb_table",
    "TotalExecutionCounts": 2,
    "TotalExecutionTimes" : 2,
    "TotalLockTimes"      : 1,
    "message"             : "{Log JSON data}"
  }
}

Some parameter descriptions are as follows:

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

Tip: fields.message is a JSON serialized string

Slow Query Details¶

Prerequisites¶

Note: The operation of this script depends on the collection of PolarDB instance objects. If the custom object collection for PolarDB is not configured, the slow log script cannot collect slow log data.

Installation Script¶

Based on the previous setup, you need to install a script for PolarDB Slow Query Details Log Collection

In 「Management / Script Market」, click and install the corresponding script package:

• 「Guance Integration (Alibaba Cloud - PolarDB Slow Query Details Log Collection)」(ID: guance_aliyun_polardb_slowlog_record)

After the data synchronization is normal, you can view the data in the 「Logs」 section of Guance.

Configuration Cloud Database PolarDB Slow Query Details

An example of the reported data is as follows:

{
  "measurement": "aliyun_polardb_slowlog_record",
  "tags": {
    "DBName"     : "PolarDB_MySQL",
    "DBNodeId"   : "pi-***************",
    "HostAddress": "testdb[testdb] @ [100.**.**.242]"
  },
  "fields": {
    "SQLText"           : "select id,name from tb_table",
    "ExecutionStartTime": "2021-04-07T03:47Z",
    "QueryTimes"        : 20,
    "ReturnRowCounts"   : 0,
    "ParseRowCounts"    : 0,
    "LockTimes"         : 0,
    "QueryTimeMS"       : 100,
    "message"           : "{Log JSON data}"
  }
}

Some parameter descriptions are as follows:

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

Tip: fields.message is a JSON serialized string