OpenTelemetry ActiveSupport Instrumentation

The Active Support instrumentation is a community-maintained instrumentation for the Active Support portion of the Ruby on Rails web-application framework.

How do I get started?

Install the gem using:

gem install opentelemetry-instrumentation-active_support

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

Usage

To use the instrumentation, call use with the name of the instrumentation and subscribe to desired ActiveSupport notification:

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

tracer = OpenTelemetry.tracer_provider.tracer('my_app_or_gem', '0.1.0')
::OpenTelemetry::Instrumentation::ActiveSupport.subscribe(tracer, 'bar.foo')

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

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

Subscribe options

The subscribe method accepts optional payload-related arguments:

• notification_payload_transform: Custom proc used to extract span attributes from the notification payload. The proc receives the notification payload and must return a Hash. Use this to rename keys, extract nested values, or perform any other custom logic.
• disallowed_notification_payload_keys: Array of string notification payload keys that should not be recorded as span attributes. Keys are matched before the remaining payload keys are converted to strings.

::OpenTelemetry::Instrumentation::ActiveSupport.subscribe(
  tracer, # tracer
  'bar.foo', # pattern
  ->(payload) { payload.merge('tenant' => payload['account_id']) }, # notification_payload_transform
  ['account_id'] # disallowed_notification_payload_keys
)

Examples

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

How can I get involved?

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