Sinatra Instrumentation

The Sinatra instrumentation is a community-maintained instrumentation for the Sinatra Web Framework.

How do I get started?

Install the gem using:

gem install opentelemetry-instrumentation-sinatra

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

Version Compatibility

Older versions of Sinatra depend on older version of Rack, which are not supported by the latest version of Rack instrumentation. If you are using an older version of Sinatra and need an earlier version of Rack instrumentation, then consider installing and pinning the compatible gem version, e.g.:

gem opentelemetry-instrumentation-rack, "<version>"

Sinatra Version	Rack Instrumentation Version
< 2.0	= 0.22.1
>= 2.0	~> 0.22

Usage

To install the instrumentation, add the gem to your Gemfile:

gem 'opentelemetry-instrumentation-sinatra'

Then call use with the name of the instrumentation:

require 'rubygems'
require 'bundler/setup'

Bundler.require

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

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

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

How can I get involved?

The opentelemetry-instrumentation-sinatra 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-sinatra gem is distributed under the Apache 2.0 license. See LICENSE for more information.

HTTP semantic convention stability

Sinatra instrumentation installs Rack middleware which by default emits the stable HTTP semantic conventions. The OTEL_SEMCONV_STABILITY_OPT_IN environment variable can be used to opt-in to the old or duplicate (both old and stable) semantic conventions.

When setting the value for OTEL_SEMCONV_STABILITY_OPT_IN, you can specify which conventions you wish to adopt:

• http - Emits the stable HTTP and networking conventions.
• http/dup - DEPRECATED: Will be removed on April 15, 2026. Emits both the old and stable HTTP and networking conventions.
• old - DEPRECATED: Will be removed on April 15, 2026. Emits the old HTTP and networking conventions.

For additional information on migration, please refer to our documentation.