mcpField
O
otel-ruby

otel-ruby

github.com/ollygardenOther11939 installsUpdated 4d ago
Repository

About otel-ruby

otel-ruby is a reference skill for OpenTelemetry in Ruby applications, intended for developers who need task-specific guidance. Its self-contained references cover setup, telemetry APIs, instrumentation, performance, and upgrades, while distinguishing stable tracing from experimental metrics and logs.

Key features

  1. 01Task-specific, self-contained references
  2. 02Configure SDKs, OTLP exporters, and resources
  3. 03Create traces, metrics, and logs
  4. 04Choose and configure instrumentation libraries
  5. 05Review performance and compatibility guidance

Use cases

  1. 01Set up OpenTelemetry in a Ruby application
  2. 02Add manual telemetry and test emitted data
  3. 03Investigate sampling, batching, or process lifecycle issues

Install

Copy the command and run it in a terminal.

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

After installing, type/otel-rubyin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

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

Details

From the project README

OpenTelemetry in Ruby

Entry point for OpenTelemetry mechanics in Ruby applications. Load only the reference that matches the task; each reference is self-contained.

References

FileUse when
references/setup.mdInstalling gems, configuring OpenTelemetry::SDK.configure, selecting OTLP exporters, setting resources and environment variables, and handling process shutdown.
references/api.mdWriting manual traces, metrics, or logs; managing context and propagation; testing emitted telemetry.
references/instrumentation-libraries.mdSelecting and configuring contrib instrumentation for Rails, Rack, Sinatra, HTTP clients, databases, jobs, messaging, and other gems.
references/performance.mdTuning sampling, batching, cardinality, forked-process behavior, exporters, and lifecycle handling.
references/breaking-changes.mdReviewing Ruby/runtime compatibility, independently versioned gems, experimental signal changes, and core/contrib upgrades.

Signal stability matters

Tracing uses the stable opentelemetry-api and opentelemetry-sdk gems. Ruby metrics and logs are separate 0.x API, SDK, and exporter gems and remain experimental. Do not assume a tracing gem's version exists for metrics, logs, semantic conventions, exporters, or contrib instrumentation. Resolve each gem independently with Bundler, inspect its changelog, and keep the resulting Gemfile.lock change under review.

Released snapshot verified 2026-10-25: tracing API 1.11.1, tracing SDK 1.13.1, trace OTLP exporter 0.37.0; metrics API 0.10.0, SDK 0.22.0, OTLP exporter 0.15.0; logs API 0.7.0, SDK 0.8.1, OTLP exporter 0.7.0; experimental declarative-config gem opentelemetry-config 0.2.0 (targets schema v1.0.0-rc.3; owner: the otel-declarative-config parsers table). Treat this as an audit anchor, not a version-alignment rule; use the lookups below for newer releases.

Sources of truth

FactFetch
Latest core releases and per-gem tagsgh api repos/open-telemetry/opentelemetry-ruby/releases --paginate
Latest contrib instrumentation releasesgh api repos/open-telemetry/opentelemetry-ruby-contrib/releases --paginate
Released and locked gem dependenciesgem specification <gem> dependencies --remote --yaml; inspect Gemfile.lock for the locked dependency set
Core implementation and changelogsopen-telemetry/opentelemetry-ruby
Contrib catalog, compatibility, and per-gem optionsopen-telemetry/opentelemetry-ruby-contrib
Ruby language docsOpenTelemetry Ruby documentation

Cross-references

  • SDK version selection across languages: otel-sdk-versions skill.
  • Semantic convention names and stability: otel-semantic-conventions skill.
  • OTLP receiver/export validation: otel-collector and otel-telemetrygen skills.

Comments

Markdown supported