Ruby Agent

Requirements

Our Ruby agent supports Ruby on Rails 2.2+ and Ruby 1.8.7+. See a list of libraries we instrument.

Memory Bloat detection require Ruby 2.1+.

Scout APM 4.0.0+ requires Ruby 2.1+. If you’re using a Ruby version lower than 2.1, you can still use Scout APM 2.6.10.

For method-level tracing using our AutoInstruments feature, you will need a version of the parser gem that matches the Ruby version running your application.

Installation

See our setup page on how to get setup in under 3 minutes in your local, staging and/or production environment.

Updating

The latest version of scout_apm is

1. Ensure your Gemfile entry for Scout is: gem 'scout_apm'

2. Run bundle update scout_apm

3. Re-deploy your application.

The gem version changelog is available here.

Instrumented Libraries

The following libraries are currently instrumented:

• Datastores
  • ActiveRecord
  • ElasticSearch
  • Mongoid
  • Moped
  • Redis
• Rack frameworks
  • Rails
  • Sinatra
  • Grape
  • Middleware
• Rails libraries
  • ActionView
  • ActionController
• External HTTP calls
  • HTTPClient
  • Net::HTTP
  • Typhoeus
• Background Job Processing
  • DelayedJob
  • GoodJob
  • Resque
  • Shoryuken
  • Sidekiq
  • Sneakers
  • Solid Queue

Additionally, Scout can also instrument request queuing time.

You can instrument your own code or other libraries via custom instrumentation.