Scout Ruby Application Monitoring Agent
Switch branches/tags
2.1.6 2.3.2 2.3.3 2.3.4 2.3.5 227-ability-to-disable-sending-remote-ip 233-add-compress-payload-to-coercion-list agent_memory_debug app_server_payload ar_settings auto_instruments automatic-instrument-api-and-metal codeclimate-coverage config-start-resque-server core_agent dead-code-removal debug delayed-job-active-job detailed-trace-ar-instrumentation detailed-traces dev_trace dont-install-frameworks-when-monitor-false extra-logging-layaway fix-help-url fix-null-desc fix_disabled_instrument grape_instrumentation heroku_demo howchoo ignore-requests-via-tracked-request ignore-requests log-failed-layaway-write master max-sql-length meperia_log mongoid-extra-logging mongoid_v6 parallel-walks prepend-view-instruments queue_time_debug_logging rack-instrumentation read-sha-from-config realhq resque-instrumentation rework-agent-start scoutprof-buckets scoutprof-detailed-traces scoutprof-extra-logging-layaway scoutprof-git_revision_tracking scoutprof-histograms-compression scoutprof-ignore-requests-via-tracked-request scoutprof-limited-layers scoutprof-rework-agent-start scoutprof-sql-desc scoutprof-trace-policy scoutprof_agent_memory_debug scoutprof_alrm_debug scoutprof_db_query_metrics scoutprof_extensions scoutprof_sql_begin_commit_naming scoutprof_statsd_context scoutprof_tracepoint scoutprof sidekiq-delayed-instance smarter-instrument-installation sneakers sql_begin_commit_naming statsd_context store-mutex tracev2 tracked-request-record-in-background travis-setup
Nothing to show
Clone or download

README.markdown

ScoutApm Ruby Agent

Build Status

A Ruby gem for detailed Rails application performance monitoring 📈. Metrics and transaction traces are reported to Scout, a hosted application monitoring service.

What's the special sauce? 🤔

The Scout agent is engineered to do some wonderful things:

Getting Started

Add the gem to your Gemfile

gem 'scout_apm'

Update your Gemfile

bundle install

Signup for a Scout account and put the provided config file at RAILS_ROOT/config/scout_apm.yml.

Your config file should look like:

common: &defaults
  name: YOUR_APPLICATION_NAME
  key: YOUR_APPLICATION_KEY
  monitor: true

production:
  <<: *defaults

DevTrace Quickstart

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

  1. Add the gem to your Gemfile:
# Gemfile
gem 'scout_apm'
  1. Start your Rails app with the SCOUT_DEV_TRACE environment variable:
SCOUT_DEV_TRACE=true rails server

How to test gem locally

  • 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

Docs

For the complete list of supported frameworks, Rubies, configuration options and more, see our help site.

Help

Email support@scoutapp.com if you need a hand.