Ruby - The Instana Ruby gem

The Instana Ruby gem: Ruby Distributed Tracing & Metrics Sensor

Gem Version OpenTracing Badge

Ruby Supported Components

Usage

The instana gem is a zero configuration tool that will automatically collect key metrics and distributed traces from your Ruby processes. Just install and go.

Installation

The gem is available on Rubygems. To install, add this line to the end of your application’s Gemfile:

gem 'instana'

And then execute:

$ bundle

Or install it yourself as:

$ gem install instana

Notes

For container based deployments, the Instana Ruby gem requires an ip binary available (such as from the iproute2 OS package). This requirement will be removed in a future version.

Configuration

Although the gem has no configuration required for out of the box metrics and distributed tracing, individual components can be configured as needed. See the Ruby configuration page for more information.

Custom Tracing

If you wish to write your own instrumentation, this Ruby gem provides two options for custom tracing:

  1. Instana Ruby Tracing SDK
  2. OpenTracing

Want End User Monitoring?

Instana provides deep end user monitoring that links server side traces with browser events to give you a complete view from server to browser.

See the End User Monitoring page for more information.

Troubleshooting

Seeing something unexpected or having trouble trying to configure something? See the Ruby Troubleshooting page for help.

Releases

To see the Instana Ruby gem release history, which also details the changes made in the Instana gem, please see the Github Releases page.

See Also