跳转至

采集器「腾讯云-CKafka」配置手册

阅读本文前，请先阅读：

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

1. 配置结构

本采集器配置结构如下：

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

2. 配置示例

指定地域

采集上海地域的数据

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

配置过滤器（可选项）

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

  • True：目标资源需要被采集。
  • False 目标资源不需要被采集

支持筛选的对象属性：

属性 描述
RegionId 地域
InstanceId 实例 ID
Status 实例的状态
SubnetId 子网 ID
Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
# 示例：开启过滤器，根据对象的 InstanceId，OsName 属性过滤，配置格式如下：

def filter_instance(instance):
    '''
    采集 InstanceId 为 ckafka-xxxx1, ckafka-xxxx2 且 Status 为 1 的指标
    '''
    instance_id = instance['InstanceId']
    status = instance['Status']
    if instance_id in ['ckafka-xxxx1', 'ckafka-xxxx2'] and status == 1:
        return True
    return False

from guance_integration__runner import Runner
import guance_tencentcloud_cvm__main as main

@DFF.API('TencentCloud-CKafka Collection', timeout=3600, fixed_crontab='*/15 * * * *')
def run():
    Runner(main.DataCollector(account, collector_configs, filters=[filter_instance])).run()

3. 数据上报格式

数据正常同步后，可以在观测云的「基础设施-自定义对象」中查看数据。

上报的数据示例如下：

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
{
  "measurement": "tencentcloud_ckafka",
  "tags": {
      "Cvm"         : "1",
      "DiskSize"    : "200",
      "DiskType"    : "CLOUD_BASIC",
      "Healthy"     : "1",
      "InstanceName": "未命名",
      "InstanceType": "profession",
      "IsInternal"  : "0",
      "RegionId"    : "ap-shanghai",
      "RenewFlag"   : "0",
      "Status"      : "1",
      "SubnetId"    : "subnet-xxxx",
      "TopicNum"    : "1",
      "Version"     : "2.4.1",
      "VpcId"       : "vpc-kcphyzty",
      "Vport"       : "9092",
      "ZoneId"      : "200002",
      "instanceId"  : "ckafka-xxx",
      "name"        : "ckafka-xxxx"
  },
  "fields": {
      "Bandwidth"     : 160,
      "CreateTime"    : 1691731708,
      "ExpireTime"    : -62170009580,
      "HealthyMessage": "",
      "Vip"           : "172.xx.xx.xx",
      "VipList"       : "[{\"Vip\": \"172.xx.xx.xx\", \"Vport\": \"xxxx\"}]",
      "message"       : "{实例 JSON 数据}"
  }
}

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

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

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

X. 附录

请参考腾讯云官方文档：