Extraordinary insight into your users and background jobs
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app/models/notable Updated belongs_to relation May 1, 2017
lib Fixed linter errors [skip ci] Aug 8, 2018
.gitignore First commit Dec 22, 2014
CHANGELOG.md Version bump to 0.2.2 [skip ci] May 18, 2018
Gemfile Rubocop fixes Feb 21, 2016
LICENSE.txt First commit Dec 22, 2014
README.md Version bump to 0.2.2 [skip ci] May 18, 2018
Rakefile Rubocop fixes Feb 21, 2016
notable.gemspec Use safely and cleaner logic Jan 16, 2017

README.md

Notable

🌟 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.

🍊 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
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

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 = -> (env) {
  env["warden"].try(:user) || env["action_controller.instance"].try(:current_visit)
}

Custom track method

Notable.track_request_method = -> (data, env) {
  Notable::Request.create!(data)
}

Skip tracking CSRF failures

skip_before_action :track_unverified_request

Anonymize IP addresses

Notable.mask_ips = true

Jobs

Set slow threshold

Notable.slow_job_threshold = 60 # seconds (default)

Custom track method

Notable.track_job_method = -> (data) {
  Notable::Job.create!(data)
}

TODO

  • ability to disable features
  • add indexes

Contributing

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