otel-ruby について
otel-rubyは、RubyアプリケーションでのOpenTelemetry利用を案内するリファレンススキルです。セットアップ、テレメトリーAPI、計装、性能調整、アップグレードを個別に参照でき、安定版のトレースと実験段階のメトリクス・ログを区別しています。
主な機能
- 01用途別の独立したリファレンス
- 02SDK、OTLPエクスポーター、リソースの設定
- 03トレース、メトリクス、ログの作成
- 04計装ライブラリの選定と設定
- 05性能と互換性の確認
活用シーン
- 01RubyアプリにOpenTelemetryを設定
- 02手動テレメトリーの追加と出力テスト
- 03サンプリング、バッチ処理、プロセス終了処理の調査
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ ollygarden/ opentelemetry-agent-skills --skill otel-rubyインストール後、Claude Code で/otel-rubyを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
references/api.mdbreaking-changes.mdinstrumentation-libraries.mdperformance.mdsetup.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、実験的なシグナルの変更、core/contrib のアップグレードを確認する場合。 |
シグナルの安定性は重要です
トレースには、安定版の opentelemetry-api および opentelemetry-sdk gem を使用します。Ruby のメトリクスとログは、別個の 0.x API、SDK、エクスポーター gem で提供され、実験的な状態が続いています。トレース用 gem のバージョンが、メトリクス、ログ、セマンティック規約、エクスポーター、contrib 計装にも存在すると想定しないでください。各 gem を Bundler で個別に解決し、変更履歴を確認したうえで、生成された 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(スキーマ v1.0.0-rc.3 が対象。オーナー:otel-declarative-config のパーサーテーブル)。これは監査の基準点として扱い、バージョンを揃えるルールとはみなさないでください。より新しいリリースについては、以下の検索方法を使用してください。
信頼できる情報源
| 情報 | 取得方法 |
|---|---|
| 最新の core リリースと 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 を確認してください。 |
| core の実装と変更履歴 | 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スキル。