Skip to content

rage-rb/opentelemetry-instrumentation

Repository files navigation

OpenTelemetry Rage Instrumentation

The OpenTelemetry Rage instrumentation provides automatic observability for Rage, a fiber-based framework with Rails-compatible syntax.

This instrumentation enables comprehensive tracing and logging for Rage applications:

  • Creates spans for HTTP requests, WebSocket messages, event subscribers, and deferred tasks
  • Propagates OpenTelemetry context across fibers created via Fiber.schedule and deferred tasks
  • Enriches logs with trace and span IDs for correlated observability

How do I get started?

Install the gem using:

gem install opentelemetry-instrumentation-rage

Or, if you use bundler, include opentelemetry-instrumentation-rage in your Gemfile.

Usage

To use the instrumentation, call use with the name of the instrumentation:

OpenTelemetry::SDK.configure do |c|
  c.use 'OpenTelemetry::Instrumentation::Rage'
end

Alternatively, you can also call use_all to install all the available instrumentation.

OpenTelemetry::SDK.configure do |c|
  c.use_all
end

Examples

Example usage can be seen in the ./example/trace_demonstration.ru file

How can I get involved?

The opentelemetry-instrumentation-rage gem source is on github, along with related gems including opentelemetry-api and opentelemetry-sdk.

The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby special interest group (SIG). You can get involved by joining us on our GitHub Discussions, Slack Channel or attending our weekly meeting. See the meeting calendar for dates and times. For more information on this and other language SIGs, see the OpenTelemetry community page.

License

The opentelemetry-instrumentation-rage gem is distributed under the Apache 2.0 license. See LICENSE for more information.

About

OpenTelemetry instrumentation for the Rage framework

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published