OpenTelemetry Grape Instrumentation Ruby 2.6 Experimental

Note: This is a version of the opentelemetry-instrumentation-grape v0.1.4 gem modified to run on Ruby 2.6 and up. This has been given the version number v0.0.1.4.

This version of the gem requires the opentelemetry-instrumentation-rack v0.23.4 that was modified to run on Ruby 2.6, versioned v0.22.23.4. This modded gem can be found at https://github.com/LoyalSphere/opentelemetry-instrumentation-rack-ruby2.6-experimental

Both modded gems must be included in the gemfile in order for the gem dependencies to work.

The Grape instrumentation is a community-maintained instrumentation for Grape, a REST-like API framework for Ruby.

It relies on the Grape built-in support for ActiveSupport::Notifications (more info here) and the OpenTelemetry Rack instrumentation.

It currently supports the following events:

• endpoint_run.grape
• endpoint_render.grape
• endpoint_run_filters.grape
• format_response.grape

How do I get started?

Install the gem using:

gem install opentelemetry-instrumentation-grape

Or, if you use bundler, include opentelemetry-instrumentation-grape 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::Grape'
end

Grape is "designed to run on Rack or complement existing web application frameworks such as Rails and Sinatra". As a result, this instrumentation uses the Rack instrumentation and modifies the Rack spans, modifying the span name and adding Grape attributes and events. It is recommended to use it along with Rails and/or Sinatra instrumentations, if any of these frameworks are being used.

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

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

Configuration options

:ignored_events (array)

Indicate if any events should not produce spans.

• Accepted values: :endpoint_render, :endpoint_run_filters, :format_response.
• Defaults to [] (no ignored events).

Example:

OpenTelemetry::SDK.configure do |c|
  c.use 'OpenTelemetry::Instrumentation::Grape', { ignored_events: [:endpoint_run_filters] }
end

Note that the endpoint_run event cannot be ignored. If you need to disable the instrumentation, set :enabled to false:

OpenTelemetry::SDK.configure do |c|
  config = { 'OpenTelemetry::Instrumentation::Grape' => { enabled: false } }
  c.use_all(config)
end

Examples

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

How can I get involved?

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