SweetNotifications

Syntactic sugar for ActiveSupport::LogSubscriber for easy instrumentation and logging from third-party libraries.

This gem requires Ruby 2.0 or newer. Compatible versions of JRuby and Rubinius are also supported.

Installation

Add this line to your Rails application's Gemfile:

gem 'sweet_notifications'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sweet_notifications

Usage

This library helps with creating ActiveSupport::Notifications subscribers for logging purposes. First, there should be a source of notifications:

class CandiesController < ApplicationController
  def index
    candies = %w{M&M's Gummibears Pez Salmiakki}
    ActiveSupport::Notifications.instrument 'list.candies', list: candies do
      sleep 0.5
      render json: candies
    end
  end
end

Then, subscribe to these notifications using SweetNotifications in an initializer:

SweetNotifications.subscribe :candies do
  color ActiveSupport::LogSubscriber::GREEN
  event :list, runtime: true do |event|
    next unless logger.debug? # Use next in blocks
    debug message(event, 'Candy', "listing candies: #{event.payload[:candies]}")
  end
end

SweetNotifications.subscribe will subscribe to the namespace given as argument and, if necessary, create a Rails initializer that will be run when the application is initialized.

If this functionality is too much, use SweetNotification::LogSubscriber to create LogSusbcribers and SweetNotification.controller_runtime to bind this to the Rails controller logging runtime logging functionality.

class AwesomeLogSubscriber < SweetNotifications::LogSubscriber
  color ActiveSupport::LogSubscriber::CYAN, ActiveSupport::LogSubscriber::MAGENTA
  event :cool, runtime: true do |event|
    info "Cool stuff"
  end

  event :insanely_great, runtime: false do |event|
    debug "Insanely greate"
  end
end

AwesomeLogSubscriber.attach_to :namespace
ControllerRuntime = SweetNotifications.controller_runtime(:namespace, AwesomeLogSubscriber)

ActionController::Base.send(:include, ControllerRuntime)

Contributing

See CONTRIBUTING.md.