Skip to content

Configuration Manual for the "Alibaba Cloud-POLARDB" Collector

Before reading this, please refer to:

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

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. For example: 'cn-hangzhou'
Refer to the appendix for the full list

2. Configuration Examples

Specifying Regions

Collecting data from Hangzhou region

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

Configuring Filters (Optional)

This collector script supports user-defined filters that allow users to filter target resources based on object attributes. The filter function returns True or False. - True: The target resource needs to be collected. - False: The target resource does not need to be collected.

Supported object properties for filtering:

Property Description
DBClusterId Cluster ID
VpcId VPC ID
DBNodeNumber Number of nodes
PayType Payment type
DBType Database type
LockMode Cluster lock mode
DBVersion Database version
DBClusterNetworkType Cluster network type
ZoneId Availability zone ID
Engine Cluster engine
RegionId Region ID
Category Cluster series
DBClusterDescription Cluster description
DBNodeIds Node IDs
Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
# Example: Enable filters to filter by DBClusterId and DBType properties. Configuration format is 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 guance_integration__runner import Runner
import guance_aliyun_polardb__main as main

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

3. Data Reporting Format

After data synchronization is successful, you can view the data in the {{( brand_name )}} 'Infrastructure - Resource Catalog'.

Example of reported data:

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
  "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 for node list}",
    "Database"  : "[JSON data for database details]",
    "ExpireTime": "",
    "CreateTime": "2022-06-17T06:07:19Z",
    "message"   : "{JSON data for instance}"
  }
}

Explanation of some parameters:

tags.Category (Cluster Series) values and their meanings:

Value Description
Normal Cluster Edition
Basic Single-node
Archive Historical Database

Fields in tags and fields may change with subsequent updates

tags.DBClusterId represents the instance ID, used as a unique identifier

X. Appendix

Refer to the official Alibaba Cloud documentation: