SuperAPI AI 工具集

otel-ruby

部署与运维

查看项目

更新于 10-16 10:06

技能介绍

OpenTelemetry in Ruby 是面向 Ruby 应用的 OpenTelemetry 机制入口技能。它按任务组织参考文档,每份参考自包含,使用时只加载与当前任务匹配的那一份。

用途 该技能用于在 Ruby 应用中接入和配置 OpenTelemetry,覆盖 SDK 初始化、手动埋点、自动埋点库选择、性能调优以及版本升级与破坏性变更审查等场景。

主要能力与参考文档

  • references/setup.md:安装 gem、配置 OpenTelemetry::SDK.configure、选择 OTLP 导出器、设置资源与环境变量,以及处理进程关闭。
  • references/api.md:编写手动追踪、指标或日志;管理上下文与传播;测试发出的遥测数据。
  • references/instrumentation-libraries.md:为 Rails、Rack、Sinatra、HTTP 客户端、数据库、任务、消息等 gem 选择和配置 contrib 自动埋点。
  • references/performance.md:调优采样、批处理、基数、fork 进程行为、导出器和生命周期处理。
  • references/breaking-changes.md:审查 Ruby/运行时兼容性、独立版本化的 gem、实验性信号变更,以及 core/contrib 升级。

信号稳定性 追踪使用稳定的 opentelemetry-api 和 opentelemetry-sdk gem。Ruby 的指标和日志是独立的 0.x API、SDK 和导出器 gem,仍处于实验阶段。不要假设追踪 gem 的版本同样存在于指标、日志、语义约定、导出器或 contrib 自动埋点中。应使用 Bundler 独立解析每个 gem,检查其变更日志,并让生成的 Gemfile.lock 变更处于审查之下。

已发布快照(验证于 2026-10-03) 追踪 API 1.11.1、追踪 SDK 1.13.1、追踪 OTLP 导出器 0.37.0;指标 API 0.8.0、SDK 0.19.0、OTLP 导出器 0.13.0;日志 API 0.5.0、SDK 0.7.0、OTLP 导出器 0.6.0;实验性声明式配置 gem opentelemetry-config 0.1.0(仅追踪)。该快照应视为审计锚点,而非版本对齐规则;更新版本请使用下方查询方式。

事实来源

  • 最新核心版本与各 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 documentation

交叉引用

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

适用场景 适用于需要在 Ruby 项目中引入 OpenTelemetry 追踪、指标或日志的开发者,尤其是使用 Rails、Rack、Sinatra、Sidekiq 等框架并希望借助 contrib 自动埋点快速接入的场景。

限制 Ruby 的指标与日志信号仍为实验性 0.x 版本,API 与导出器可能变化;各 gem 独立版本化,需分别解析与审查。资料未提供具体收费、价格或平台信息。