Skip to content

Collector Configuration Manual for "Tencent Cloud-TcaplusDB"

Before reading this article, please read the following first:

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: 'ap-shanghai'
Refer to the appendix for the full table

2. Configuration Example

Specified Regions

Collect data from Shanghai and Guangzhou regions

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

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
{
  "measurement": "tencentcloud_tcaplusdb",
  "tags": {
    "ClusterId"      : "xx",
    "ClusterName"    : "xx",
    "ClusterStatus"  : "0",
    "ClusterType"    : "0",
    "NetworkType"    : "xx",
    "Password"       : "xx",
    "PasswordStatus" : "xx",
    "Region"         : "xx",
    "RegionId"       : "ap-guangzhou",
    "name"           : "xx"
  },
  "fields": {
    "CreatedTime"       : "2020-09-22 00:00:00",
    "DiskVolume"        : 0,
    "ReadCapacityUnit"  : 0,
    "WriteCapacityUnit" : 0,
    "message"           : "{Instance JSON data}"
  }
}

Descriptions of some parameters are as follows:

Field Type Description
Password str Cluster password
DiskVolume Integer Disk capacity
ReadCapacityUnit str Read CU
Note: This field may return null, indicating that no valid value is available.
WriteCapacityUnit str Write CU
Note: This field may return null, indicating that no valid value is available.

Fields in tags and fields may change with subsequent updates

The value of tags.name is the instance ID, used as a unique identifier, and fields.message is a string serialized in JSON format

X. Appendix

Please refer to the official Tencent Cloud documentation: