Instana

The instana gem provides Ruby metrics and traces (request, queue & cross-host) for Instana.

This gem supports Ruby versions 2.7 or greater.

Any and all feedback is welcome. Happy Ruby visibility.

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

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.

Supported Frameworks

• Cuba
• gRPC
• Padrino
• Roda
• Ruby on Rails
• Rack
• Sinatra

Configuration

Although the gem has no configuration required for out of the box metrics and tracing, components can be configured if needed. See our Configuration page.

Tracing

This Ruby gem provides a simple API for tracing and also supports OpenTracing. See the Ruby Tracing SDK and OpenTracing pages for details.

Documentation

You can find more documentation covering supported components and minimum versions in the Instana documentation portal.

Want End User Monitoring (EUM)?

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.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bundle exec rake console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in lib/instana/version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/instana/ruby-sensor.

More

Want to instrument other languages? See our Node.js, Go, Python repositories or many other supported technologies.