Collector 'Alibaba Cloud-POLARDB' Configuration Manual¶

Before reading this document, please read:

Cloud Integration

Tip

Before using this collector, you must install the 'Integration Core Package' and its accompanying third-party dependencies.

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 appendix for full list

2. Configuration Examples¶

Specifying a Region¶

Collect data from the Hangzhou region

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

Configuring Filters (Optional)¶

This collector script supports custom filters, allowing users to filter target resources based on object attributes. The filter function returns True｜False - True: The target resource should be collected. - False: The target resource should not be collected.

Supported object attributes for filtering:

Attribute	Description
DBClusterId	Cluster ID
VpcId	VPC ID
DBNodeNumber	Number of nodes
PayType	Payment type
DBType	Database type
LockMode	Cluster lock status
DBVersion	Database version
DBClusterNetworkType	Cluster network type
ZoneId	Zone ID
Engine	Cluster engine
RegionId	Region ID
Category	Cluster series
DBClusterDescription	Cluster description
DBNodeIds	Node IDs

# Example: Enabling a filter to filter based on the DBClusterId and DBType attributes of the object, configuration format as follows:

def filter_cluster(cluster):
    cluster_id = cluster['DBClusterId']
    db_type = cluster['DBType']
    if cluster_id in ['xxx'] and db_type in ['MySQL']:
        return True
    return False

###### Do not modify the following contents #####
from integration_core__runner import Runner
import integration_alibabacloud_polardb__main as main

def run():
    Runner(main.DataCollector(account, collector_configs, filters=[filter_cluster])).run()

3. Data Reporting Format¶

After data is successfully synchronized, it can be viewed in the 'Infrastructure-Resource Catalog' of TrueWatch.

Example of reported data:

{
  "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"   : "{Node list JSON data}",
    "Database"  : "[Database details JSON data]",
    "ExpireTime": "",
    "CreateTime": "2022-06-17T06:07:19Z",
    "message"   : "{Instance JSON data}"
  }
}

Partial parameter explanations:

tags.Category (Cluster Series) values:

Value	Description
`Normal`	Cluster Edition
`Basic`	Single Node
`Archive`	Historical Library

Note

Fields in tags and fields may change with subsequent updates.

Tip

The value of tags.DBClusterId is the instance ID, used as a unique identifier.

X. Appendix¶

Please refer to the official Alibaba Cloud documentation: