Repository files navigation

A Ruby gem for detailed Rails application performance monitoring 📈. Metrics and transaction traces arereported toScout, a hosted application monitoringservice.

The Scout agent is engineered to do some wonderful things:

• A unique focus on identifying those hard-to-investigate outliers like memory bloat, N+1s, and user-specific problems.See an example workflow.
• Low-overhead
• View your performance metrics during development withDevTrace and in production viaserver_timing.
• Production-Safe profiling of custom code viaScoutProf (BETA).

Add the gem to your Gemfile

gem 'scout_apm'

Adda version of theparser gem that supports your version of Ruby. For example, if you're on Ruby 3.3.0:

gem 'parser', '~> 3.3.0.0'

Update your Gemfile

bundle install

Signup for aScout account and put the providedconfig file atRAILS_ROOT/config/scout_apm.yml.

Your config file should look like:

common: &defaults  name: YOUR_APPLICATION_NAME  key: YOUR_APPLICATION_KEY  monitor: truetest:  monitor: falseproduction:  <<: *defaults

To use DevTrace, our free, no-signup, in-browser development profiler:

1. Add the gem to your Gemfile:

# Gemfilegem'scout_apm'

2. Start your Rails app with the SCOUT_DEV_TRACE environment variable:

SCOUT_DEV_TRACE=true rails server

• Point your gemfile at your local checkout:gem 'scout_apm', path: '/path/to/scout_apm_ruby
• Compile native code:cd /path/to/scout_apm_ruby && bundle exec rake compile

For the complete list of supported frameworks, Rubies, configuration optionsand more, see ourhelp site.

Emailsupport@scoutapp.com if you need a hand.