Skip to content

Collector Configuration Manual for "Tencent Cloud - SQL Server"

Before reading this article, please first read:

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

2. Configuration Example

Specify Region

Collect data from Shanghai region

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

Configure Filters (Optional)

This collector script supports user-defined filters that allow users to filter target resources by object properties. 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
DBInstanceId Instance ID
AppId User's AppId
DBCharset Database character set
DBEngine Database engine
DBInstanceClass Instance type
DBInstanceName Instance name
ProjectId Project ID
Region Project ID where the instance resides
Type Machine type
SubnetId Subnet ID
PayType Payment type
Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
# Example: Enable filter based on the InstanceId and ProjectId properties of an object, with the following configuration format:

def filter_instance(instance):
    '''
    return True｜False
    '''
    instance_id = instance['InstanceId']
    project_id = instance['ProjectId']
    if instance_id in ['xxx'] and project_id in ['xxx']:
        return True
    return False

###### Do not modify the following contents #####
from guance_integration__runner import Runner
import guance_tencentcloud_redis__main as main

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

3. Data Reporting Format

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

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
35
36
{
  "measurement": "tencentcloud_postgres",
    "tags": {
      "AppId"               : "13185",
      "DBCharset"           : "UTF8",
      "DBEngine"            : "mssql_cible",
      "DBEngineConfig"      : "{\"migrationMode\":\"single-db\",\"defaultLocale\":\"en_US\",\"serverCollationName\":\"sql_latin1_general_cp1_ci_as\"}",
      "DBInstanceClass"     : "cdb.pg.ts1.2g",
      "DBInstanceId"        : "postgres-cp2iic76",
      "DBInstanceName"      : "test",
      "DBInstanceStatus"    : "running",
      "DBInstanceType"      : "primary",
      "DBInstanceVersion"   : "standard",
      "DBVersion"           : "14.3",
      "PayType"             : "postpaid",
      "ProjectId"           : "0",
      "Region"              : "ap-shanghai",
      "SubnetId"            : "subnet-bpj",
      "Type"                : "TS85",
      "Uid"                 : "414933",
      "VpcId"               : "vpc-kty",
      "Zone"                : "ap-shanghai-2",
      "name"                : "postgres-cp"
    },
  "fields": {
      "CreateTime"          : "2023-07-20 15:54:54",
      "DBInstanceCpu"       : "1",
      "DBInstanceMemory"    : "2",
      "DBInstanceNetInfo"   : "{Network JSON data}",
      "DBInstanceStorage"   : "10",
      "ExpireTime"          : "0000-00-00 00:00:00",
      "IsolatedTime"        : "0000-00-00 00:00:00",
      "UpdateTime"          : "2023-07-20 15:57:37",
      "message"             : "{Instance JSON data}"
  }
}

Fields in tags and fields may change with subsequent updates

tags.name value is a unique identifier

fields.message and fields.InstanceNode are JSON serialized strings

X. Appendix

Refer to the official Tencent Cloud documentation: