Ruby OpenTelemetry APM

Complete these tasks to properly integrate OpenTelemetry APM in Ruby:

Install

  1. Review OpenTelemetry documentation Getting Started.

  2. Run the install command for the Ruby bundle:

bundle add opentelemetry-sdk opentelemetry-instrumentation-all

Set Up Instrumentation

To set up the instrumentation, follow these steps from the see OpenTelemetry’s documentation of Instrumentation.

For creating spans using the OpenTelemetry API for Ruby, use the following OpenTelemetry documentation: Traces.

Instrumentation Libraries

OpenTelemetry Ruby supports instrumentation from many libraries, which you can easily install using the instructions in Configuring all instrumentation libraries.

Examples

You can use a set of fully-functional, working examples of OpenTelemetry for Ruby from OpenTelemetry Ruby Examples on GitHub.