kenny 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2740dfe3834c07d205a400e43ed53ffaa70b3eb6
-  data.tar.gz: cae861c957fb393d01fd56fa408d34f4d82ff725
+  metadata.gz: 6c2ee30aef4af126bb892a5a682a158524d9b4a9
+  data.tar.gz: 44854a85ae4e02a773594c6f5bb547aa86336ff4
 SHA512:
-  metadata.gz: 180faaefd1c6d219bf0dd5e854dd8b2a9870103d746b83c1ecc622570777bb78762026290cf145d5837b76fdb92013122c177cdbaab1498ddbf373b93cc308e5
-  data.tar.gz: 588c0abb9b75569892e9d51dcb1691725780e6d72d7e3efb931a7a50cb9d612719bbf2441fd36c4e427cb80b7a71ae1e2c2f2e8b5fef3ad1a24bbbc649a8d7ae
+  metadata.gz: c6972fc555f77201aca2c86bf855a43c287ed419b01ecdc5fc7482476133323d5a2cdd7d00514a5a24241dc06c4f5e8d3e0c9a2ea5fab964b382c5141567bb26
+  data.tar.gz: 689f0b1c8d4c8d74e871ebf99f66f43140c15aa264e0f7c42ef4edd426ae0ab54aeaa233eccbf6099bfa72f885dd7c6af9dc8a680edcbf768a969e96f4eedb76

data/README.md

@@ -12,7 +12,6 @@ It allows the user to decide:
 - which instrumentations to monitor
 - what to do when the specified instrumentation event occurs
 - where to log the data to (or no logging to file at all)
-- whether or not to unsubscribe from Rails' default instrumentations (although not recommended)
 
 Apart from that, it was also created with the idea of keeping all subscribed events in one place. So it will keep your code clean and provide a nice overview of all event-triggered actions.
 
@@ -50,8 +49,6 @@ Or command line:
     log_stash_formatter = Kenny::Formatters::LogStashFormatter.new
     request_logger.formatter = log_stash_formatter
 
-    config.kenny.unsubscribe_rails_defaults = false
-    config.kenny.suppress_rack_logger = true
     config.kenny.instrumentations = [
       { name: 'process_action.action_controller',
         block: lambda do |event|
@@ -125,33 +122,6 @@ Or command line:
   You might think that since no `:logger` option has been provided for 'sql.active_record' events, the default logger will be used..... But that is not true.
   Since `logger` is within scope at the time when the lambda was defined, this instance of ActiveSupport::Logger will be used to invoke `#info` when 'sql.active_record' occurs. So just avoid creating a local variable that have the same name as variables in your block.
 
-
-### `kenny.unsubscribe_rails_defaults` configuration
-  Kenny can also used to unsubscribe all Rails LogSubscribers from their subscribed instrumentation events.
-  You can do that by setting `:unsubscribe_rails_defaults` to true:
-
-  ``` Ruby
-  config.kenny.unsubscribe_rails_defaults = true
-  config.kenny.instrumentations = [{
-      # your stuff
-    }]
-  }
-  ```
-
-  By doing so, your `development|test|staging|production.log` will not have any of the default log messages. This is not an approach I would recommend, unless you are desperate to have all messages from your specified instrumentation events all logged into one `development|test|staging|production.log`.
-
-
-### `kenny.suppress_rack_logger` configuration
-  By default, your rails app logs messages like these to your environment's log:
-
-  ```
-  Started GET "/my_path" for 10.0.2.2 at 2016-07-12 10:06:48 +0000
-  Started GET "/assets/sh/my_styles.css?body=1" for 10.0.2.2 at 2016-07-12 10:06:49 +0000
-  ```
-
-  You can suppress these messages by setting kenny.suppress_rack_logger to true.
-  This setting will not have any effects on the log files that you create separately with the `:logger` option within your specified instrumentation.
-
 ## Open-to-Implementation approach
   As you might have seen from the example, the `:block` allows you to define your own implementation.
   The idea behind writing this gem is to free up users from the tedious task of defining LogSubscriber classes and to allow them to define whatever they wants to do with the event data, be it something like:

data/lib/kenny/railtie.rb

@@ -17,12 +17,6 @@ module Kenny
       # perform the user-defined actions when that instrumentation occurs.
       # If desired, user can define a specific logger for the specified instrumentation.
       Kenny.attach_to_instrumentations
-
-      # Unsubscribe all default Rails LogSubscribers if demanded
-      Kenny.unsubscribe_from_rails_defaults
-
-      # Suppress Rails::Rack::Logger's output
-      Kenny.suppress_rack_logger
     end
   end
 end

data/lib/kenny.rb

@@ -1,16 +1,11 @@
 ##
 
-# Kenny module does three things:
+# Kenny module does two things:
 # - Holds reference to the Rails application (set through Railtie)
-# - Unsubscribe all Rails' LogSubscribers from the default instrumentation channels
 # - Create LogSubscriber-classes which will be attached to the user-specified instrumentations
 module Kenny
   def self.configs
-    Struct.new(
-      :unsubscribe_rails_defaults,
-      :suppress_rack_logger,
-      :instrumentations
-    ).new
+    Struct.new(:instrumentations).new
   end
 
   def self.application=(app)
@@ -32,25 +27,6 @@ module Kenny
     end
   end
 
-  ##
-  # Unsubscribe all Rails' default LogSubscribers from the default Rails instrumentations,
-  # by delegating to Kenny::Unsubscriber.
-  # See http://edgeguides.rubyonrails.org/active_support_instrumentation.html
-  def self.unsubscribe_from_rails_defaults
-    if @application.config.kenny[:unsubscribe_rails_defaults]
-      Kenny::Unsubscriber.unsubscribe_from_rails_defaults
-    end
-  end
-
-  ##
-  # Suppress Rails::Rack::Logger's output like:
-  #   Started GET "/my_path" for 10.0.2.2 at 2016-07-12 10:06:48 +0000
-  def self.suppress_rack_logger
-    if @application.config.kenny[:suppress_rack_logger]
-      require 'kenny/rails_ext/rack/logger'
-    end
-  end
-
   ##
   # Create LogSubscriber-classes which will be attached to the user-specified instrumentations
   # These classes are anonymous, but inherit from Kenny::LogSubscriber to simplify testing
@@ -77,5 +53,4 @@ end
 require 'kenny/railtie'
 
 require 'kenny/formatters/log_stash_formatter'
-require 'kenny/unsubscriber'
 require 'kenny/log_subscriber'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kenny
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Mathias Rüdiger
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-20 00:00:00.000000000 Z
+date: 2016-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -181,9 +181,7 @@ files:
 - lib/kenny.rb
 - lib/kenny/formatters/log_stash_formatter.rb
 - lib/kenny/log_subscriber.rb
-- lib/kenny/rails_ext/rack/logger.rb
 - lib/kenny/railtie.rb
-- lib/kenny/unsubscriber.rb
 homepage: https://github.com/fromAtoB/kenny
 licenses:
 - MIT

data/lib/kenny/rails_ext/rack/logger.rb

@@ -1,25 +0,0 @@
-require 'active_support/concern'
-require 'rails/rack/logger'
-
-module Rails
-  module Rack
-    # Overwrites defaults of Rails::Rack::Logger that cause
-    # unnecessary logging.
-    # This effectively removes the log lines from the log
-    # that say:
-    # Started GET / for 192.168.2.1...
-    class Logger
-      # Overwrites Rails 3.2 code that logs new requests
-      def call_app(*args)
-        env = args.last
-        @app.call(env)
-      ensure
-        ActiveSupport::LogSubscriber.flush_all!
-      end
-
-      # Overwrites Rails 3.0/3.1 code that logs new requests
-      def before_dispatch(_env)
-      end
-    end
-  end
-end

data/lib/kenny/unsubscriber.rb

@@ -1,64 +0,0 @@
-##
-module Kenny
-  # Module to unsubscribe all Rails default LogSubscribers from their events.
-  module Unsubscriber
-    DEFAULT_RAILS_LOG_SUBSCRIBER_CLASSES = [
-      ActionView::LogSubscriber,
-      ActionController::LogSubscriber,
-      ActiveRecord::LogSubscriber,
-      ActionMailer::LogSubscriber
-    ].freeze
-
-    ##
-    # By default, a Rails app instantiates the LogSubscribers listed above and
-    # are actively listening to instrumentations listed in:
-    # http://edgeguides.rubyonrails.org/active_support_instrumentation.html
-    #
-    # Unsubscribing is not recommended, unless you want to modify the output
-    # to your standard rails logs (development|test|staging|production).log
-    #
-    # It would be safer to write your chosen instrumentation data to a separate file,
-    # setup by the [:logger] configuration (see Readme).
-
-    # In that case, the [:unsubscribe_rails_defaults]
-    # field in Kenny's config won't need to be set.
-    def self.unsubscribe_from_rails_defaults
-      default_rails_log_subscribers.each do |subscriber|
-        subscribed_events_for(subscriber).each do |event|
-          unsubscribe_listeners_for_event(subscriber, event)
-        end
-      end
-    end
-
-    def self.default_rails_log_subscribers
-      ActiveSupport::LogSubscriber.log_subscribers.select do |subscriber|
-        DEFAULT_RAILS_LOG_SUBSCRIBER_CLASSES.include? subscriber.class
-      end
-    end
-    private_class_method :default_rails_log_subscribers
-
-    def self.listeners_for(event, subscriber_namespace)
-      ActiveSupport::Notifications.notifier.listeners_for(
-        "#{event}.#{subscriber_namespace}"
-      )
-    end
-    private_class_method :listeners_for
-
-    def self.unsubscribe_listeners_for_event(subscriber, event)
-      subscriber_namespace = subscriber.class.send :namespace
-      listeners_for(event, subscriber_namespace).each do |listener|
-        if listener.instance_variable_get('@delegate') == subscriber
-          ActiveSupport::Notifications.unsubscribe listener
-        end
-      end
-    end
-    private_class_method :unsubscribe_listeners_for_event
-
-    def self.subscribed_events_for(subscriber)
-      error_msg = "Expected #{subscriber} to be inherited from ActiveSupport::LogSubscriber"
-      raise error_msg if subscriber.class.superclass != ActiveSupport::LogSubscriber
-      subscriber.public_methods(false).reject { |method| method.to_s == 'call' }
-    end
-    private_class_method :subscribed_events_for
-  end
-end