OpenTelemetry ActionView Instrumentation
The ActionView instrumentation is a community-maintained instrumentation for the ActionView portion of the Ruby on Rails web-application framework.
How do I get started?
Install the gem using:
gem install opentelemetry-instrumentation-action_view gem install opentelemetry-instrumentation-rails
Or, if you use bundler, include
opentelemetry-instrumentation-action_view in your
To use the instrumentation, call
use with the name of the instrumentation:
OpenTelemetry::SDK.configure do |c| c.use 'OpenTelemetry::Instrumentation::Rails' c.use 'OpenTelemetry::Instrumentation::ActionView' end
Alternatively, you can also call
use_all to install all the available instrumentation.
OpenTelemetry::SDK.configure do |c| c.use_all end
Example usage can be seen in the
./example/trace_request_demonstration.ru file here
ActionView instrumentation uses ActiveSupport notifications and in the case when a subscriber raises in start method an unclosed span would break successive spans ends. Example:
class CrashingEndSubscriber def start(name, id, payload) raise 'boom' end def finish(name, id, payload) end end ::ActiveSupport::Notifications.subscribe('render_template.action_view', CrashingStartSubscriber.new)
How can I get involved?
opentelemetry-instrumentation-action_view gem source is on github, along with related gems including
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.
opentelemetry-instrumentation-action_view gem is distributed under the Apache 2.0 license. See LICENSE for more information.