Skip to content

Configuration Manual for Collector 「Tencent Cloud-TDSQL-C PostgreSQL」

Before reading this article, please read the following first:

Before using this collector, you must install the 「Integration Core Package」 and its corresponding 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: 'ap-shanghai'
Refer to the appendix for the full table

2. Configuration Example

Specifying Regions

Collect data from Shanghai and Guangzhou regions.

Python
1
2
3
collector_configs = {
    'regions': [ 'ap-shanghai', 'ap-guangzhou' ]
}

Configuring Filters (Optional)

This collector script supports user-defined filters, allowing 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 attributes for filtering:

Attribute Description
RegionId Instance region ID
Region Instance region
Zone Instance availability zone
ClusterId Cluster ID
ClusterName Cluster name
InstanceId Instance ID
InstanceName Instance name
InstanceType Instance type
InstanceRole Instance role
Status Instance status
StatusDesc Instance status description
DbType Database type
DbMode Database mode
DbVersion Database version
WanIP Public IP address
WanPort Public port number
WanStatus Public connection status
Python
 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
# Example: Enable filters, filter based on the InstanceId and name properties of the object, with the following configuration format:
def filter_instance(instance):
    '''
    return True｜False
    '''
    # return True
    instance_id = instance['InstanceId']
    if instance_id in ['cdb-xxxx']:
        return True
    return False


###### Do not modify the following contents #####
from guance_integration__runner import Runner
import guance_tencentcloud_tdsql_c_postgresql__main as tdsql_c_postgresql_main
import guance_tencentcloud_monitor__main as monitor_main


@DFF.API('TencentCloud-TDSQL-C-PostgreSQL Collection', timeout=3600, fixed_crontab='* * * * *')
def run():
    collectors = [
        tdsql_c_postgresql_main.DataCollector(account, collector_configs, filter_instance=filter_instance),
        monitor_main.DataCollector(account, monitor_configs),
    ]
    Runner(collectors).run()

3. Data Reporting Format

After data synchronization, you can view the data in the {{( brand_name )}} 「Infrastructure - Resource Catalog」.

An example of the reported data is as follows:

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
28
29
30
31
32
33
34
{
  "measurement": "tencentcloud_tdsql_c_postgresql",
  "tags": {
    "ClusterId"    : "cynosdbmysql-xxxx",
    "ClusterName"  : "cynosdbmysql-xxxx",
    "DbMode"       : "NORMAL",
    "DbType"       : "POSTGRESQL",
    "DbVersion"    : "8.0",
    "InstanceId"   : "cynosdbmysql-ins-xxxx",
    "InstanceName" : "cynosdbmysql-ins-xxxx",
    "InstanceRole" : "ro",
    "InstanceType" : "ro",
    "Region"       : "ap-shanghai",
    "RegionId"     : "ap-shanghai",
    "Status"       : "isolated",
    "StatusDesc"   : "Isolated",
    "WanIP"        : "",
    "WanPort"      : "0",
    "WanStatus"    : "init",
    "Zone"         : "ap-shanghai-2",
    "name"         : "cynosdbmysql-xxxx"
  },
  "fields": {
    "Cpu"           : 1,
    "CreateTime"    : "2023-08-21 11:00:50",
    "IsolateTime"   : "2023-08-21 11:34:55",
    "Memory"        : 1,
    "PayMode"       : 0,
    "PeriodEndTime" : "0001-01-01 00:00:00",
    "Storage"       : 3000,
    "UpdateTime"    : "2023-08-21 11:34:55",
    "message"       : "{Instance JSON data}"
  }
}

Descriptions of some parameters are as follows:

Field Type Description
PayMode str Payment mode.
0-Pay-as-you-go,
1-Subscription
Note: This field may return null, indicating no valid value was obtained.
CreateTime str Cluster creation time
Note: This field may return null, indicating no valid value was obtained.
PeriodEndTime str End time
Note: This field may return null, indicating no valid value was obtained.
UpdateTime str Update time

Fields in tags and fields may change with subsequent updates

The value of tags.name is the instance ID, serving as a unique identifier, and fields.message is a string after JSON serialization.

Some fields may not be collected because the Tencent Cloud interface may not return all fields. Please refer to the official Tencent Cloud documentation for more details.

X. Appendix

Please refer to the official Tencent Cloud documentation: