Notable

:star2: Extraordinary insight into your users and background jobs

Wouldn’t it be great to see when one of your users encounters an error, timeout, or validation failure? Now you can - directly in your admin pages.

Introducing Notable

Notable tracks notable requests and background jobs and stores them in your database. What makes a request or job notable? There are a number of default situations, but ultimately you decide what interests you.

By default, Notable tracks:

  • errors
  • 404s
  • slow requests and jobs
  • timeouts
  • validation failures
  • CSRF failures
  • unpermitted parameters
  • blocked and throttled requests

You can track custom notes as well.

:tangerine: Battle-tested at Instacart

Installation

Add this line to your application’s Gemfile:

gem 'notable'

And run:

rails generate notable:requests
rails generate notable:jobs # optional
rake db:migrate

For a web interface, check out Notable Web.

Requests

A Notable::Request is created for:

  • errors
  • 404s
  • slow requests
  • timeouts
  • validation failures
  • CSRF failures
  • unpermitted parameters
  • blocked and throttled requests

For timeouts, use Slowpoke.

For blocked and throttled requests, use Rack Attack.

Jobs

Wouldn’t it be great to have a record of exact jobs that fail?

A Notable::Job is created for:

  • errors
  • slow jobs
  • validation failures

Currently works with Delayed Job and Sidekiq.

Manual Tracking

Notable.track(note_type, note)

Like

Notable.track("Auth Event", "Signed In")

Customize

Disable tracking in certain environments

Notable.enabled = Rails.env.production?

Requests

Set slow threshold

Notable.slow_request_threshold = 5 # seconds (default)

Custom user method

Notable.user_method = proc do |env|
  env["warden"].try(:user) || env["action_controller.instance"].try(:current_visit)
end

Custom track method

Notable.track_request_method = proc do |data, env|
  Notable::Request.create!(data)
end

Jobs

Set slow threshold

Notable.slow_job_threshold = 60 # seconds (default)

Custom track method

Notable.track_job_method = proc do |data|
  Notable::Job.create!(data)
end

TODO

  • ability to disable features
  • add indexes

Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help: