OpenTelemetry Faraday Instrumentation

The OpenTelemetry Faraday Ruby gem is a community maintained instrumentation for Faraday. This is an HTTP client library that provides a common interface over many adaptors, such as Net::HTTP.

How do I get started?

Install the gem using:

gem install opentelemetry-instrumentation-faraday

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

Usage

To install the instrumentation, call use with the name of the instrumentation.

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

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

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

Examples

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

How can I get involved?

The opentelemetry-instrumentation-faraday 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

Apache 2.0 license. See LICENSE for more information.