Skip to content

Collector Configuration Manual for "Tencent Cloud - SQL Server"

Before reading this, please first read:

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 be collected
regions[#] str Required Region ID. For example: 'ap-shanghai'
See appendix for full list

2. Configuration Example

Specified Region

Collect data from Shanghai region

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

Configuration Filters (Optional)

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

Supported object attributes for filtering:

Attribute Description
InstanceId Instance ID
BackupCycleType Backup cycle type
CrossBackupEnabled Cross-region backup status
InstanceType Product type
Model Instance high availability
PayMode Instance payment mode
ProjectId Instance ID
Region Instance project ID
RenewFlag Instance renewal flag
Type Physical machine code
Uid Instance unique UID
UniqSubnetId Unique string ID of the subnet where the instance resides
ProjectId Instance project ID
UniqVpcId Unique string ID of the VPC where the instance resides
Version Instance version
VersionName Instance version name
ZoneId Zone ID
Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
# Example: Enable filters, filter based on InstanceId and ProjectId properties of the object, configuration format as follows:

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 the data is synchronized normally, it can be viewed in the "Infrastructure - Resource Catalog" section of Guance, TrueWatch.

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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
{
  "measurement": "tencentcloud_sqlserver",
  "tags": {
      "BackupCycleType": "daily",
      "CrossBackupEnabled": "disable",
      "InstanceId"      : "mssql-nmquc",
      "InstanceType"    : "SI",
      "Model"           : "2",
      "PayMode"         : "0",
      "Pid"             : "10036",
      "ProjectId"       : "0",
      "Region"          : "ap-shanghai",
      "RegionId"        : "ap-shanghai",
      "RenewFlag"       : "0",
      "Status"          : "2",
      "SubnetId"        : "68021",
      "Type"            : "CLOUD_BSSD",
      "Uid"             : "gamedb.sh1000.cdb.db",
      "UniqSubnetId"    : "subnet-b",
      "UniqVpcId"       : "vpc-xxxxx",
      "Version"         : "2016SP1",
      "VersionName"     : "SQL Server 2016 Enterprise",
      "Vip"             : "xxxxx",
      "VpcId"           : "80484",
      "Vport"           : "14",
      "Zone"            : "ap-shanghai-2",
      "ZoneId"          : "200002",
      "account_name"    : "Tencent Cloud account used for script development",
      "cloud_provider"  : "tencentcloud",
      "name"            : "mssql-nmqu"
    },
  "fields": {
      "Cpu"             : "2",
      "CreateTime"      : "2023-07-20 14:07:05",
      "EndTime"         : "0000-00-00 00:00:00",
      "IsolateTime"     : "0000-00-00 00:00:00",
      "Memory"          : "4",
      "StartTime"       : "2023-07-20 14:07:05",
      "Storage"         : "20",
      "UpdateTime"      : "2023-07-20 14:14:13",
      "UsedStorage"     : "0",
      "message"         : "{Instance JSON data}"
  }
}

Fields in tags and fields may change with subsequent updates

Value of tags.name is the instance ID, used as a unique identifier

fields.message, fields.InstanceNode are strings serialized in JSON format

X. Appendix

Please refer to the official Tencent Cloud documentation: