Skip to content

Configuration Manual for Collector 「Tencent Cloud-KeeWiDB」

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 list

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 the data is synchronized normally, you can view it in the 「Infrastructure-Resource Catalog」 section of {{( brand_name )}}.

The reported data example 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
{
  "measurement": "tencentcloud_keewidb",
  "tags": {
    "name"          : "kee-xxxxx",
    "BillingMode"   : "0",
    "Engine"        : "TendisV2",
    "InstanceId"    : "kee-xxxxx",
    "InstanceName"  : "08-22-mh-test",
    "InstanceTitle" : "Running",
    "Port"          : "6379",
    "ProductType"   : "unknown",
    "ProjectId"     : "0",
    "RegionId"      : "ap-shanghai",
    "Status"        : "2",
    "WanIp"         : "172.xxxx.xxx.11",
    "ZoneId"        : "200004"
  },
  "fields": {
    "AutoRenewFlag"  : 0,
    "ClientLimitMax" : 10000,
    "ClientLimitMin" : 1000,
    "CloseTime"      : "0000-00-00 00:00:00",
    "Createtime"     : "2023-08-22 15:56:22",
    "DeadlineTime"   : "0000-00-00 00:00:00",
    "MachineMemory"  : 4,
    "NodeSet"        : "[]",
    "Size"           : 16384,
    "Type"           : 14,
    "message"        : "{JSON instance data}"
  }
}

Descriptions of some parameters are as follows:

Field Type Description
Status str Current status of the instance. 0: Pending initialization. 1: Instance in process. 2: Running. -2: Isolated. -3: Pending deletion.
ProductType str Product type.
standalone: Standard Edition.
cluster: Cluster Edition.
BillingMode str Billing mode.
0: Pay-as-you-go.
1: Monthly subscription.
ProjectId str Project ID
NodeSet str Detailed information about the instance nodes.
Note: This field may return null, indicating no valid value can be obtained.

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 JSON serialized string

X. Appendix

Please refer to the official Tencent Cloud documentation: