关于 doca-collectx-deployment
doca-collectx-deployment 是面向运维人员的 Agent 技能,用于在主机或 BlueField 上部署和运行 CollectX 遥测收集器。它聚焦收集器及导出器,区分遥测库和产品化 DTS 容器,并涵盖配置、验证与故障排查。
主要功能
- 01说明收集器与导出器的数据流程
- 02区分四种遥测界面
- 03涵盖 Prometheus、Fluent Bit、NetFlow、文件和 IPC 导出类型
- 04配置变更前检查提供方支持情况
- 05指导收集器和导出器故障排查
适用场景
- 01部署导出 Prometheus 指标的收集器
- 02为下游使用方选择导出后端
- 03排查收集器没有提供方数据行
- 04追踪导出器无响应或下游遥测缺失
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ nvidia/ skills --skill doca-collectx-deployment安装后在 Claude Code 中输入/doca-collectx-deployment确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
BENCHMARK.mdCAPABILITIES.mdskill-card.mdskill.oms.sigTASKS.mdevals/evals.jsonreferences/details.md详细介绍
DOCA CollectX 遥测部署
示例
- “搭建一个导出 Prometheus 数据的 CollectX 收集器。” — 指收集器运行时和导出器,而不是读取器/发布器库 API,也不是产品化的 DTS 容器。
- “收集器已启动,但没有出现任何提供方行。” — 在重写 配置前,先确认提供方支持情况。
说明
请遵循下方的加载顺序。打开任务配套文档,了解如何启动和恢复 收集器。打开功能配套文档,了解四类表面的划分和导出后端类别。无需打开 所有配套文件。
从这里开始: 此技能是本套文档中用于
运行基于 CollectX(clx)的遥测收集器的入口——该收集
框架会将提供方计数器收集到架构中,并通过一个或多个导出器
发送出去。这是一项部署/运维技能,与
doca-bare-metal-deployment/SKILL.md
和 doca-container-deployment/SKILL.md
并列:
它负责操作员主机或 BlueField 上遥测收集器的运行时形态,
而非操作员自身程序调用的库 API。如果用户想要搭建、连接或调试收集器及其导出器,请打开任务配套文档,
并从 ## configure 开始。如果用户的问题是
收集器究竟有哪些表面,范围边界在哪里,请从功能配套文档开始。
如果用户尚未安装 DOCA,请先转到
doca-setup/SKILL.md。
范围边界(请先阅读)
路由意味着移交请求,而不是先行作答。 对于以下边界划定为应交由其他技能处理的任何事项,请指出负责人,然后停止。指出负责人后仍提供 API 调用、检测步骤或代码示例,是需要避免的失败模式——这里的部分回答仍然算回答,会使刚刚执行的路由失去意义。不要介绍范围之外的工作,即使只是总结、示例片段或注意事项也不行。
CollectX (clx) 是 NVIDIA 的遥测采集框架。它是 DOCA Telemetry Service (DTS) 的基础——而按实际部署的 DTS(产品化、通过 NGC 发布/由 kubelet 启动的服务容器)根据 AGENTS.md 非目标 #7(bundle AGENTS.md#non-goals-questions-the-agent-should-recognize-and-refuse-politely),不在本套件的范围内。因此,本技能划定明确的边界,Agent 必须在开头说明:
- 此处涵盖:CollectX 的采集机制这一类内容(提供方/计数器 → 架构 → 收集器守护进程 → 导出器),以及操作员部署/运行/调试其自有收集器的工作;还包括操作员自有的、本套件中两个遥测库的使用方式,前提是这些库用于向收集器提供数据或从收集器消费数据。
- 转交给 DOCA 遥测库:硬件计数器读取器 API 由
doca-telemetry/SKILL.md负责;应用侧发布器 API(从 DOCA 程序发出计数器/事件)由doca-telemetry-exporter/SKILL.md负责。本技能不会重新介绍这两个 API 的接口。 - **转交给公开文档(非目标 #7):**产品化的 DTS 容器——其打包的配置架构、内置提供方集合、kubelet 清单及 NGC 镜像——属于外部产品化内容。对于所有“如何运行 DTS 服务”的问题,请转至
doca-public-knowledge-map中外部产品化路由条目(doca-public-knowledge-map/SKILL.md#externally-productized-doca-software--not-in-this-bundle-but-here-is-where-to-route)以及该条目指向的 DTS 公开指南。Agent 不得凭记忆编造 DTS 配置文件名、提供方参数名或路径。
本技能旨在避免的首要致命错误,是把这四个不同的层面混为一谈,统称为“DOCA telemetry”:clx 采集机制、doca-telemetry 读取器库、doca-telemetry-exporter 发布器库,以及产品化的 DTS 容器,是四种不同的东西,各有不同的负责人。Agent 必须在提供任何配置级指导之前说明这一区别。
受众
本技能面向在其管理的主机或 BlueField 上部署或运行基于 CollectX 的遥测收集器的外部操作员——他们已经具备:
- 从中采集数据的一端(主机 x86 或 BlueField Arm)已安装 DOCA,并已按照
doca-setup ## test验证; - 目标是通过收集器和导出器将计数器从设备上取出,而不是编写读取器/发布器库代码(这部分由上述两个
libs/技能负责);以及 - 可以访问
docs.nvidia.com上的 DOCA Telemetry 和 DTS 公开指南,作为所有具体提供方名称、架构字段、标志或配置路径的权威信息来源。
本技能不适用于:
- 编写硬件计数器读取器 API(转至
doca-telemetry/SKILL.md)或发布器 API(转至doca-telemetry-exporter/SKILL.md)的开发人员; - 将产品化的 DTS 容器作为交钥匙服务进行部署/配置的操作员——该容器属于外部产品化内容(非目标 #7);请转至 DTS 公开指南;
- 尚未安装 DOCA 的用户——这类用户应查看
doca-setup ## no-install。
本技能教给 Agent 的是操作流程和范围边界;它不会凭记忆杜撰 clx 符号名、提供方名称、架构字段名、导出器标志名或配置路径——这些内容应从正在使用的安装版本及 doca-public-knowledge-map/SKILL.md 指向的公开文档中获取。
何时加载此技能
当用户正在亲自部署或运行基于 CollectX 的遥测采集器,且问题涉及采集器的运行形态,而非库 API 时,加载此技能。具体包括:
- 搭建一个将提供方计数器采集到架构中并发送出去的采集器,并确定哪种导出后端(Prometheus 拉取、Fluent Bit 推送、NetFlow、文件 / IPC)适合下游使用方。
- 将提供方 / 计数器系列接入采集器,并在提交配置前确认设备确实提供该项(提交前检查规则,与
doca-telemetry-utils/SKILL.md共用)。 - 启用 / 配置导出器,让指标确实离开设备,并端到端确认下游使用方收到指标(而非只确认“守护进程正在运行”)。
- 诊断已启动却没有生成架构行、没有向下游发送数据或导出器端点无响应的采集器;按分层步骤逐级排查,而非猜测。
- 识别用户实际询问的是产品化 DTS 容器(转到公开文档,非目标 #7)、读取器库(转到
doca-telemetry)还是发布器库(转到doca-telemetry-exporter),而非此技能负责的采集机制。
请勿在以下情形加载此技能:硬件计数器读取器 API(使用 doca-telemetry/SKILL.md);发布器 API(使用 doca-telemetry-exporter/SKILL.md);运行产品化 DTS 容器(通过 doca-public-knowledge-map/SKILL.md 非目标 #7 路由);安装 DOCA 或准备环境(使用 doca-setup/SKILL.md);或进行任何硬件状态变更(使用 doca-hardware-safety/SKILL.md)。
此技能提供的内容
这是一个轻量加载器。实质内容位于两个配套文件中:
- 能力配套文件——采集器部署契约,涵盖:四类对象的划分(clx 采集机制与读取器库、发布器库、产品化 DTS 之间的区别)、采集管线形态(提供方 / 计数器 → 架构 → 采集器守护进程 → 导出器)、导出后端范围(Prometheus 拉取、Fluent Bit 推送、NetFlow、文件 / IPC)的类别级说明、
doca-version/SKILL.md上的版本叠加、错误分类(采集器无法启动 → 无提供方行 → 架构不匹配 → 导出器无响应 → 下游数据偏差 → 传输问题)、可观测性范围,以及安全策略(提交前检查提供方支持;采集器以只读方式访问设备;将任何会产生变更的步骤转到doca-hardware-safety/SKILL.md;不得臆造 clx 名称 / 路径)。 - 任务配套文件——部署操作的分步工作流:
configure、build(路由占位)、modify、run、test、debug,以及一个Deferred task verbs部分,将超出范围的问题(两个库、产品化 DTS 容器、环境准备、硬件状态变更)路由给对应的负责人。
此技能假定主机或 BlueField 已安装 DOCA 且运行正常(根据 doca-setup ## test),并且操作员可以运行采集器并访问其导出器接收端。它不涵盖 DOCA 安装——该流程由 doca-setup/SKILL.md 处理——也不涵盖读取器 / 发布器库 API 或产品化 DTS 容器。
加载顺序
- 首先阅读此技能,确认用户的问题属于其适用范围(操作基于 CollectX 的采集器及其导出器——不包括 reader / publisher 库 API,也不包括产品化的 DTS 容器)。
- 关于四层分解、采集管道结构、导出后端的类接口、版本叠加、错误分类、可观测性接口和安全策略,请参阅能力配套文档。
- 关于分步工作流——
configure、build(路由占位项)、modify、run、test、debug以及Deferred task verbs区块——请参阅任务配套文档。
这两个配套文件会相互链接,也会链接到
doca-version/SKILL.md,其中包含规范的
版本处理规则;若正确的答案是“读取实时配置 / 公共文档”,
而不是采集器专属指导,也会链接到
doca-public-knowledge-map/SKILL.md。
相关技能
doca-telemetry/SKILL.md— 硬件计数器 reader API。doca-telemetry-exporter/SKILL.md— 应用侧 publisher API。doca-telemetry-utils/SKILL.md— 架构 / Data ID / 支持探测命令行工具。doca-setup/SKILL.md— 安装和环境前置条件。doca-version/SKILL.md— 四方版本匹配。doca-hardware-safety/SKILL.md— 任何会修改硬件的步骤。doca-bare-metal-deployment/SKILL.md— 在裸机上启动采集器。doca-container-deployment/SKILL.md— 以容器方式启动采集器。doca-public-knowledge-map/SKILL.md— 公共遥测 / DTS 路由。