SuperAPI AI 工具集

weaver

通用与其它

查看项目

更新于 10-16 02:37

技能介绍

用途:帮助组织在上游 OpenTelemetry 语义约定之上定义自有语义约定,并从注册表生成各语言绑定,同时用 CI 强制校验。

主要能力:围绕三部分展开——注册表(YAML 目录,manifest.yaml 必需,声明 name、semconv_version、schema_url,其余文件声明 attributes、metrics、spans、events、entities);模板(Jinja2 文件加每语言 weaver.yaml,描述运行哪些模板、过滤器、application_mode 和输出文件名);策略(Rego 规则,内置 OTel 策略为基础,可叠加组织规则)。三者替代手写常量文件。

使用方式:安装 Weaver 须按 https://github.com/open-telemetry/weaver#install 提供的方式(发布二进制、otel/weaver:vX.Y.Z Docker 镜像或 setup-weaver GitHub Action),切勿使用 brew install weaver(会装成无关工具)。编写注册表后,用 weaver registry check -r ./telemetry/registry/ 快速校验,用 weaver registry generate --registry ./telemetry/registry/ --templates ./telemetry/templates/ <lang> <output-dir> 生成代码,并对输出运行语言格式化工具。写模板前先运行 weaver registry resolve -r <reg> -f json -o /tmp/r.json 确认解析后的 schema 形状。CI 设三道门:check、generate 加 git diff --exit-code、与基线分支 diff。

限制与注意:每条目必须有 stability,否则拒绝生成;组织本地属性/指标/span 需用域前缀;http、db、messaging、rpc、network、gen-ai 等边界域应引用上游而非本地重复声明;计数器名去掉 .total 后缀;时长直方图用秒;生成输出需格式化,否则 CI diff 误报;weaver registry check 在 0.22.1 会输出 definition/2 未稳定提示,属正常;--future 目前会因 definition/2 报错。发布注册表为版本化产物、声明上游依赖、live-check、自定义 Rego 策略、辅助函数代码生成均不在本技能范围内。部分配套技能不可用时不要停止,应查阅官方仓库与文档并说明所用回退方案。