mcpField
O
otel-ruby

otel-ruby

github.com/ollygarden其他11939 次安装4 天前更新
代码仓库

关于 otel-ruby

otel-ruby 是面向 Ruby 应用的 OpenTelemetry 参考技能，供开发者按任务查阅独立文档。内容涵盖配置、遥测 API、各类库的埋点、性能调优和版本变更，并区分稳定的 tracing 与实验性的 metrics、logs。

主要功能

  1. 01按任务查阅独立参考文档
  2. 02配置 SDK、OTLP 导出器与资源
  3. 03编写 traces、metrics 和 logs
  4. 04选择并配置埋点库
  5. 05参考性能与版本兼容信息

适用场景

  1. 01为 Ruby 应用配置 OpenTelemetry
  2. 02添加手动遥测并测试输出
  3. 03排查采样、批处理或进程生命周期问题

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/ollygarden/opentelemetry-agent-skills --skill otel-ruby

安装后在 Claude Code 中输入/otel-ruby确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
api.md
breaking-changes.md
instrumentation-libraries.md
performance.md
setup.md

详细介绍

Ruby 中的 OpenTelemetry

Ruby 应用中 OpenTelemetry 机制的入口。仅加载与任务匹配的参考资料；每份参考资料均可独立使用。

参考资料

文件适用场景
references/setup.md安装 gem、配置 OpenTelemetry::SDK.configure、选择 OTLP 导出器、设置资源和环境变量，以及处理进程关闭。
references/api.md编写手动追踪、指标或日志；管理上下文和传播；测试已发出的遥测数据。
references/instrumentation-libraries.md为 Rails、Rack、Sinatra、HTTP 客户端、数据库、作业、消息传递及其他 gem 选择并配置 contrib 检测库。
references/performance.md调整采样、批处理、基数、派生进程行为、导出器和生命周期处理。
references/breaking-changes.md查看 Ruby/运行时兼容性、独立版本控制的 gem、实验性信号变更，以及核心/contrib 升级。

信号稳定性很重要

追踪使用稳定的 opentelemetry-api 和 opentelemetry-sdk gem。Ruby 指标和日志使用独立的 0.x API、SDK 和导出器 gem，且仍处于实验阶段。不要假设某个追踪 gem 的版本也适用于指标、日志、语义约定、导出器或 contrib 检测库。使用 Bundler 分别解析每个 gem，检查其变更日志，并在审核中跟踪由此产生的 Gemfile.lock 变更。

已发布版本快照（2026-10-25 验证）：追踪 API 1.11.1、追踪 SDK 1.13.1、追踪 OTLP 导出器 0.37.0；指标 API 0.10.0、SDK 0.22.0、OTLP 导出器 0.15.0；日志 API 0.7.0、SDK 0.8.1、OTLP 导出器 0.7.0；实验性声明式配置 gem opentelemetry-config 0.2.0（目标 schema v1.0.0-rc.3；所有者：otel-declarative-config 解析器表）。将此快照视为审计基准，而非版本对齐规则；如需更新版本，请使用下方的查询方式。

信息来源

事实获取方式
最新核心版本和各 gem 的标签gh api repos/open-telemetry/opentelemetry-ruby/releases --paginate
最新 contrib 检测库版本gh api repos/open-telemetry/opentelemetry-ruby-contrib/releases --paginate
已发布及锁定的 gem 依赖项gem specification <gem> dependencies --remote --yaml；检查 Gemfile.lock 中锁定的依赖项集合
核心实现和变更日志open-telemetry/opentelemetry-ruby
Contrib 目录、兼容性和各 gem 的选项open-telemetry/opentelemetry-ruby-contrib
Ruby 语言文档OpenTelemetry Ruby 文档

交叉引用

  • 跨语言的 SDK 版本选择：otel-sdk-versions 技能。
  • 语义约定名称和稳定性：otel-semantic-conventions 技能。
  • OTLP 接收器/导出验证：otel-collector 和 otel-telemetrygen 技能。

评论

支持 Markdown