采集器「腾讯云-SQL Server」配置手册¶

阅读本文前，请先阅读：

云集成

Tip

使用本采集器前，必须安装「集成 Core 核心包」及其配套的第三方依赖包

1. 配置结构¶

本采集器配置结构如下：

字段	类型	是否必须	说明
`regions`	list	必须	所需采集的地域列表
`regions[#]`	str	必须	地域 ID。如：`'ap-shanghai'` 总表见附录

2. 配置示例¶

指定地域¶

采集上海地域的数据

collector_configs = {
    'regions': [ 'ap-shanghai' ]
}

配置过滤器（可选项）¶

本采集器脚本支持用户自定义过滤器，让用户通过对象属性筛选出目标资源。过滤器函数返回值为 True｜False - True：目标资源需要被采集。 - False 目标资源不需要被采集

支持筛选的对象属性：

属性	描述
InstanceId	实例 ID
BackupCycleType	备份周期类型
CrossBackupEnabled	跨地域备份状态
InstanceType	产品类型
Model	实例高可用
PayMode	实例付费模式
ProjectId	实例 ID
Region	实例所在项目 ID
RenewFlag	实例续费标记
Type	物理机代号
Uid	实例唯一UID
UniqSubnetId	实例所属子网的唯一字符串ID
ProjectId	实例所在项目 ID
UniqVpcId	实例所属VPC的唯一字符串ID
Version	实例版本
VersionName	实例版本
ZoneId	区域 ID

# 示例：开启过滤器，根据对象的 InstanceId 和 ProjectId 属性过滤，配置格式如下：

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 integration_core__runner import Runner
import integration_tencentcloud_redis__main as main

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

3. 数据上报格式¶

数据正常同步后，可以在观测云的「基础设施-资源目录」中查看数据。

上报的数据示例如下：

{
  "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"    : "脚本开发用腾讯云账号",
      "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"         : "{实例 JSON 数据}"
  }
}

Note

tags、fields 中的字段可能会随后续更新有所变动

Tip

tags.name 值为实例 ID，作为唯一标识

Tip

fields.message、fields.InstanceNode 为 JSON 序列化后字符串

X. 附录¶

请参考腾讯云官方文档：