跳转至

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

阅读本文前,请先阅读:

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

1. 配置结构

本采集器配置结构如下:

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

2. 配置示例

指定地域

采集上海地域的数据

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

配置过滤器(可选项)

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

  • True:目标资源需要被采集。

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

支持筛选的对象属性:

属性 描述
ClusterId 集群 ID
ClusterName 集群名称
Status 集群状态
Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
# 示例:开启过滤器,根据对象的 ClusterId 和 Status 属性过滤,配置格式如下:
def filter_instance(instance):
    '''
    采集 ClusterId 为 xxx 并且 Status 为 xxx 的实例
    '''
    # return True
    cluster_id = instance['ClusterId']
    status = instance['Status']
    if cluster_id in ['xxx'] and status in ['xxx']:
        return True
    return False

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

@DFF.API('TencentCloud-Pulsar Collection', timeout=3600, fixed_crontab='* * * * *')
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
{
  "measurement": "tencentcloud_pulasar",
  "tags": {
    "ClusterId"         : "pulsar-xxxx",
    "ClusterName"       : "test1",
    "EndPointNum"       : "0",
    "Healthy"           : "1",
    "MaxNamespaceNum"   : "50",
    "MaxQps"            : "10000",
    "MaxStorageCapacity": "102400",
    "MaxTopicNum"       : "1000",
    "PayMode"           : "0",
    "RegionId"          : "ap-shanghai",
    "Status"            : "1",
    "Version"           : "2.9.2",
    "name"              : "pulsar-xxxx"
  },
  "fields": {
    "CreateTime"          : "2023-08-21 13:46:47",
    "HealthyInfo"         : "",
    "MessageRetentionTime": 1296000,
    "Remark"              : "",
    "message"             : "{实例 JSON 数据}"
  }
}

部分参数说明如下

字段 类型 说明
Healthy str 集群是否健康,1表示健康,0表示异常

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

tags.name 值为实例 ID,作为唯一标识,fields.message 为 JSON 序列化后字符串

X. 附录

请参考腾讯云官方文档: