Configuration Manual for Collector 「Alibaba Cloud - PolarDB Slow Query Detail Logs」

Before reading this, please first read:

TrueWatch Integration

Before using this collector, you must install the 'Integration Core Package' and its associated third-party dependency packages

This script's code execution depends on PolarDB instance object collection. If custom object collection for PolarDB is not configured, the slow log script will not be able to collect slow log data.

1. Configuration Structure

The configuration structure of this collector is as follows:

Field	Type	Required	Description
`regions`	list	Required	List of regions to collect data from
`regions[#]`	str	Required	Region ID. Example: `'cn-hangzhou'` See full table in appendix

2. Configuration Example

Specify Region

Collect data from Hangzhou region.

Python
collector_configs = {
    'regions': [ 'cn-hangzhou' ]
}

3. Data Reporting Format

After data is synchronized successfully, it can be viewed in the 'LOGs' section of TrueWatch.

Example of reported data:

JSON
{
  "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"           : "{JSON log data}"
  }
}

Descriptions of some parameters are as follows:

Field	Type	Description
`QueryTimes`	Long	SQL execution duration, unit in seconds
`QueryTimeMS`	Long	Query time, unit in milliseconds
`ReturnRowCounts`	Long	Number of returned rows
`ParseRowCounts`	Long	Number of parsed rows
`ExecutionStartTime`	String	Time when SQL execution started. Format YYYY-MM-DDThh:mmZ (UTC time)
`LockTimes`	Long	SQL lock duration, unit in seconds

Fields in tags and fields may change with subsequent updates

fields.message is a JSON serialized string

X. Appendix

Please refer to the official Alibaba Cloud documentation: