notification_tracer 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aaec82476ba796bf8332bbc1583742a0f9bbfd6c
+  data.tar.gz: 4f32399aa750ab13688c62227575ba3de7723709
+SHA512:
+  metadata.gz: 6ead73d748cdf8e7f2be2ebc0c0aff7fb2594283cd981683c2021758d4488c6de1ac86031b36e57d2c481950dd7b83f1146989a2e506b48eba19541028a21238
+  data.tar.gz: a1dc73b4e32448bc582543888a5aa14af4a4d7540e6895fbf90e0fe4f811396bee30efe372029f91894af63a18f65587c92746fa0094fce2302a440870c003b8

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-gemset
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in notification_tracer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 David Feldman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# NotificationTracer
+
+A convenient way to process ActiveSupport notifications together with the call stack.
+
+## Installation
+
+Add `gem 'notification_tracer'` to your Gemfile.
+
+## Usage
+
+The `ActiveSupport::Notifications` API allows a consumer to subscribe to specific notification events that match a provided pattern. The `NotificationTracer::Subscriber` wraps and streamlines this process, passing matching event data to a callback: 
+
+```ruby
+subscriber = NotificationTracer::Subscriber.new(
+   pattern: 'matches.notification',
+  callback: ->(**opts){ puts opts.inspect }
+)
+```
+**:pattern** can be either a `String` (exact matching) or a `Regexp` (pattern matching).
+
+**:callback** must respond to `.call` with the following options:
+ - **:stack** ==> the cleaned Ruby callstack 
+ - **:payload** ==> an event-specific data hash
+ - **:duration** ==> how long the event took
+ - **:event_id** ==> a unique id for this event
+ - **:event_name** ==> the full name of the event
+
+`Subscriber` initialization also takes an optional parameter, **:cleaner**, for scrubbing the callstack. It is recommended to use an instance of `ActiveSupport::BacktraceCleaner` but any object with a `clean :: Array -> Array` method is acceptable.
+
+You must explicitly call `.subscribe` on the `Subscriber` in order to start receiving events:
+```ruby
+:005 > subscriber.subscribed?
+=> false 
+:006 > subscriber.subscribe
+=> #<NotificationTracer::Subscriber:0x007fb03b8b8628 @pattern="matches.notification", @callback=#<Proc:0x007fb03b8b8740@(irb):3 (lambda)>, @real_subscriber=#<ActiveSupport::Notifications::Fanout::Subscribers::Timed:0x007fb03b8836a8 ...> 
+:007 > subscriber.subscribed?
+=> true 
+:008 > 10.times.each{ subscriber.subscribe } # no harm to recall subscribe
+=> 10 
+:009 > subscriber.subscribed?
+=> true 
+:010 > subscriber.unsubscribe
+=> #<NotificationTracer::Subscriber:0x007fb03b8b8628 @pattern="matches.notification", @callback=#<Proc:0x007fb03b8b8740@(irb):3 (lambda)>, @real_subscriber=nil, ...> 
+:011 > subscriber.subscribed?
+=> false 
+```
+
+### Rails Specific
+
+`NotificationTracer::RailsSql` provides out-of-the-box logging of `sql.active_record` events:
+```ruby
+tracer = NotificationTracer::RailsSql.new(
+  matcher: <a callable that takes a sql string and returns true or false>,
+  formatter: <a callable that merges :stack, :sql, :duration, and :uuid into a single output>,
+  logger: <a callable that records the output of the formatter>,
+  lines: <limits the stack trace to the first N lines, or nil for no limit>,
+  silence_rails_code: <true or false, includes framework code in the stack trace>
+)
+tracer.start # subscribes & enables logging
+tracer.pause # disables logging
+tracer.stop  # unsubscribes & disables logging
+```
+An example **:formatter** can be found in `NotificationTracer::SqlFormatter`. This implementation converts the SQL event data into a String suitable for a text logger. It takes an optional parameter, **:prefix**, which prepends a given String to all messages.
+
+For convenience, `NotificationTracer.rails_sql` creates a `RailsSql` instance with a `SqlFormatter` formatter:
+```ruby
+log_users_sql = NotificationTracer.rails_sql(
+  prefix: 'DEBUG 2847428',
+  logger: ->(msg){ Rails.logger.debug(msg) },
+  matcher: ->(sql){ sql =~ /users/ }
+); log_users_sql.start
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fledman/notification_tracer.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "notification_tracer"
+
+require "pry"
+require "irb"
+
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/notification_tracer/errors.rb

@@ -0,0 +1,3 @@
+module NotificationTracer
+  class SubscriptionError < StandardError; end
+end

data/lib/notification_tracer/rails_sql.rb

@@ -0,0 +1,69 @@
+module NotificationTracer
+  class RailsSql
+    attr_reader :enabled, :lines
+
+    def initialize(matcher:, logger:, formatter:,
+                   lines: nil, silence_rails_code: true)
+      @enabled    = false
+      @lines      = Integer(lines) if lines
+      @matcher    = matcher
+      @logger     = logger
+      @formatter  = formatter
+      @subscriber = make_subscriber(silence_rails_code: silence_rails_code)
+    end
+
+    def start
+      @enabled = true
+      subscriber.subscribe
+      self
+    end
+
+    def pause
+      @enabled = false
+      self
+    end
+
+    def stop
+      @enabled = false
+      subscriber.unsubscribe
+      self
+    end
+
+    def call(stack:, payload:, duration:, event_id:, event_name:)
+      return unless enabled
+      return unless matches?(payload)
+      stack = stack[0..(lines-1)] if lines
+      stack = stack.select{ |l| l && !l.empty? }
+      return if stack.empty?
+      data = formatter.call(stack: stack, sql: payload[:sql],
+                            duration: duration, uuid: event_id)
+      logger.call(data) if data
+    end
+
+    private
+
+    attr_reader :matcher, :logger, :subscriber, :formatter
+
+    def pattern
+      'sql.active_record'
+    end
+
+    def make_subscriber(silence_rails_code:)
+      cleaner = make_cleaner(silence_rails_code: silence_rails_code)
+      Subscriber.new(pattern: pattern, callback: self, cleaner: cleaner)
+    end
+
+    def make_cleaner(silence_rails_code:)
+      Rails::BacktraceCleaner.new.tap do |rbc|
+        rbc.remove_silencers! unless silence_rails_code
+      end
+    end
+
+    def matches?(payload)
+      return false if payload[:name] == 'SCHEMA'
+      return false if payload[:name] == 'CACHE'
+      matcher.call(payload[:sql])
+    end
+
+  end
+end

data/lib/notification_tracer/sql_formatter.rb

@@ -0,0 +1,28 @@
+module NotificationTracer
+  class SqlFormatter
+    attr_reader :prefix
+
+    def initialize(prefix: nil)
+      @prefix = ensure_non_empty_string(prefix) if prefix
+    end
+
+    def call(stack:, sql:, duration:, uuid:)
+      message  = "Matching Query"
+      message  = "#{prefix} | #{message}" if prefix
+      message += " | #{duration} ms | ##{uuid}"
+      message += "\n ** SQL: " + sql.gsub("\n",'\n')
+      ([message] + stack).join("\n  >>> ")
+    end
+
+    private
+
+    def ensure_non_empty_string(string)
+      if string.is_a?(String)
+        return string.freeze unless string.empty?
+        raise ArgumentError, "prefix should not be empty, use nil instead"
+      end
+      raise ArgumentError, "expected a String prefix, got: #{string.inspect}"
+    end
+
+  end
+end

data/lib/notification_tracer/subscriber.rb

@@ -0,0 +1,75 @@
+module NotificationTracer
+  class Subscriber
+    attr_reader :pattern, :cleaner
+
+    def initialize(pattern:, callback:, cleaner: nil)
+      @pattern  = pattern.freeze
+      @callback = callback
+      @cleaner  = setup_cleaner(cleaner)
+    end
+
+    def subscribed?
+      !!real_subscriber && listening?
+    end
+
+    def subscribe(silent: false)
+      @real_subscriber = nil if real_subscriber && !listening?
+      @real_subscriber ||= notifier.subscribe(pattern) do |*args|
+        event = ActiveSupport::Notifications::Event.new(*args)
+        trace(event: event, stack: caller)
+      end
+      subscription_error('subscribe') if !silent && !subscribed?
+      self
+    end
+
+    def unsubscribe(silent: false)
+      if real_subscriber
+        notifier.unsubscribe(real_subscriber)
+        if listening?
+          subscription_error('unsubscribe') if !silent
+        else
+          @real_subscriber = nil
+        end
+      end
+      self
+    end
+
+    private
+
+    attr_reader :real_subscriber, :callback
+
+    def notifier
+      ActiveSupport::Notifications
+    end
+
+    def subscription_error(type)
+      raise SubscriptionError, "#{type} failed for #{pattern}"
+    end
+
+    def setup_cleaner(input)
+      if input.nil?
+        ActiveSupport::BacktraceCleaner.new
+      elsif input.respond_to?(:clean)
+        input
+      else
+        raise ArgumentError, "cleaner must respond to clean: #{input.inspect}"
+      end
+    end
+
+    def listening?
+      name = pattern.is_a?(Regexp) ? pattern.source : pattern
+      notifier.notifier.listeners_for(name).include?(real_subscriber)
+    end
+
+    def trace(event:, stack:)
+      callback.call(
+             stack: cleaner.clean(stack),
+           payload: event.payload,
+          duration: event.duration,
+          event_id: event.transaction_id,
+        event_name: event.name
+      )
+    end
+
+  end
+end

data/lib/notification_tracer/version.rb

@@ -0,0 +1,3 @@
+module NotificationTracer
+  VERSION = "0.1.2"
+end

data/lib/notification_tracer.rb

@@ -0,0 +1,16 @@
+require "notification_tracer/version"
+require "notification_tracer/errors"
+require "active_support/notifications"
+require "active_support/backtrace_cleaner"
+require "notification_tracer/subscriber"
+require "notification_tracer/rails_sql"
+require "notification_tracer/sql_formatter"
+
+module NotificationTracer
+  extend self
+
+  def rails_sql(prefix: nil, **pass)
+    RailsSql.new(formatter: SqlFormatter.new(prefix: prefix), **pass)
+  end
+
+end

data/notification_tracer.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'notification_tracer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "notification_tracer"
+  spec.version       = NotificationTracer::VERSION
+  spec.authors       = ["David Feldman"]
+  spec.email         = ["dbfeldman@gmail.com"]
+
+  spec.summary       = "trace ActiveSupport notifications"
+  spec.description   = "A convenient way to process ActiveSupport notifications together with the call stack."
+  spec.homepage      = "https://github.com/fledman/notification_tracer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", ">= 4.0", "< 5.1"
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: notification_tracer
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- David Feldman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: A convenient way to process ActiveSupport notifications together with
+  the call stack.
+email:
+- dbfeldman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/notification_tracer.rb
+- lib/notification_tracer/errors.rb
+- lib/notification_tracer/rails_sql.rb
+- lib/notification_tracer/sql_formatter.rb
+- lib/notification_tracer/subscriber.rb
+- lib/notification_tracer/version.rb
+- notification_tracer.gemspec
+homepage: https://github.com/fledman/notification_tracer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: trace ActiveSupport notifications
+test_files: []