README.md in opentelemetry-instrumentation-active_support-0.5.3 vs README.md in opentelemetry-instrumentation-active_support-0.6.0
- old
+ new
@@ -1,38 +1,44 @@
# OpenTelemetry ActiveSupport Instrumentation
+
The Active Support instrumentation is a community-maintained instrumentation for the Active Support portion of the [Ruby on Rails][rails-home] web-application framework.
## How do I get started?
Install the gem using:
-```
+```console
+
gem install opentelemetry-instrumentation-active_support
+
```
Or, if you use [bundler][bundler-home], 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:
```ruby
+
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.
```ruby
+
OpenTelemetry::SDK.configure do |c|
c.use_all
end
+
```
## Examples
Example usage can be seen in the `./example/trace_demonstration.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/active_support/example/trace_demonstration.rb)