OpenTelemetry Logger Instrumentation

The Logger instrumentation is a community-maintained bridge for the Ruby logger standard library.

How do I get started?

Install the gem using:

gem install opentelemetry-instrumentation-logger

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

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

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

Examples

Example usage can be found in the ./example/logger.rb file.

Development

The test suite leverages appraisal to verify the integration across multiple Rails versions. To run the tests with appraisal:

cd instrumentation/logger
bundle exec appraisal generate
bundle exec appraisal install
bundle exec appraisal rake test

How can I get involved?

The opentelemetry-instrumentation-logger gem source is on github, along with related gems including opentelemetry-logs-api and opentelemetry-logs-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-logger gem is distributed under the Apache 2.0 license. See LICENSE for more information.