采集器「火山引擎-容器服务」配置手册¶

阅读本文前，请先阅读：

云集成

Tip

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

1. 配置结构¶

本采集器配置结构如下：

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

2. 配置示例¶

指定地域¶

采集上海地域的数据

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

配置过滤器（可选项）¶

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

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

支持筛选的对象属性：

属性	描述
ClusterId	节点 ID
ClusterName	节点名称
ChargeType	支付类型
RegionId	地域ID
KubernetesVersion	版本号

# 示例：开启过滤器，根据对象的 Id 属性过滤，配置格式如下：
def filter_instance(instance):
    '''
    采集 instance_id 为 xxxxx 或者 instance_name 为 xxxxx 的实例
    '''
    # return True
    instance_id = instance['Id']
    if instance_id in ['xxx']:
        return True
    return False


###### Do not modify the following contents #####
from integration_core__runner import Runner
import integration_volcengine_vke__main as main


@DFF.API('Volcengine-VKE Collection', timeout=3600, fixed_crontab='* * * * *')
def run():
    collectors = [
        main.DataCollector(account, collector_configs),
        # main.DataCollector(account, collector_configs, filters=[filter_instance]),
    ]
    Runner(collectors).run()

3. 数据上报格式¶

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

上报的数据示例如下：

{
  "fields": {
    "ClusterConfig": "{集群控制面及部分节点的网络配置}",
    "CreateTime": "2024-04-07T06:13:08Z",
    "UpdateTime": "2024-04-07T06:13:08Z",
    "DeleteProtectionEnabled": "true",
    "Description": "xxx",
    "KubernetesConfig": "{k8s配置文件}",
    "PodsConfig": "{Pod 的网络配置}",
    "ServicesConfig": "{服务的网络配置}",
    "NodeStatistics": "{集群中各主状态下对应的节点数量统计}",
    "Tags": "[集群绑定的标签信息]",
    "LoggingConfig": "{集群的日志配置信息}",
    "message": "{实例 JSON 数据}"
  },
  "measurement": "volcengine_vke",
  "tags": {
    "ChargeType": "PostPaid",
    "ClusterId": "xxxx",
    "ClusterName": "xxxx",
    "KubernetesVersion": "v1.26.10-vke.14",
    "RegionId": "cn-shanghai",
    "ClusterStatus_Phase": "Running",
    "name": "xxx"
  }
}

Note

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

Tip

tags.name 值为实例 ID，作为唯一标识，fields.message、fields.PodsConfig、fields.KubernetesConfig、fields.ClusterConfig、fields.ServicesConfig、fields.NodeStatistics、fields.Tags、fields.LoggingConfig 均为 JSON 序列化后字符串

X. 附录¶

请参考火山引擎官方文档：

容器服务服务地址