ScoutApm Ruby Logging

A Ruby gem for detailed, easy to navigate, managed log monitoring. Supports Ruby 2.6+.

Sign up for an account at https://www.scoutapm.com to start monitoring your logs and application performance in minutes.

Add the gem to your Gemfile:

gem 'scout_apm_logging'

Update your Gemfile:

bundle install

Update your RAILS_ROOT/config/scout_apm.yml and add the following:

  # ... Previous &defaults or environment defined configurations

  # ENV equivalent: SCOUT_LOGS_MONITOR=true
  # ENV equivalent: SCOUT_LOGS_INGEST_KEY=...

  logs_monitor: true
  logs_ingest_key: ...

Deploy 🚀

We currently maintain two versions: 2.x (Ruby 3.1+) and 1.x (2.6-3.3). These versions/branches have feature parity and a similar release cadence.

The main branch contains the 2.x version, while the 1.x branch contains the 1.x version.

To run the entire test suite:

bundle exec rake test

To run an individual test file within the suite:

bundle exec rake test file=/path/to/spec/_spec.rb

To run test(s) against a specific Ruby version:

DOCKER_RUBY_VERSION=3.4 bundle exec rake test

Point your Gemfile at your local checkout:

gem 'scout_apm_logging', path: '/path/to/scout_apm_ruby_logging'

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