sapience 2.5.4 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 082583db334e5fff1d6de299a25848c22faa69dd
-  data.tar.gz: 8ea9117a75c74bcc52c8e4339576e2fc56d87ffa
+  metadata.gz: 8a5f9dd9f371b22ec6c89aa5ab0beac69ab71895
+  data.tar.gz: fe5782b862c1ae8c97566e20923f916b50cc6548
 SHA512:
-  metadata.gz: ecf26ed2e95a788a328c40492ef61f0fa81cdb133ae6ba4e5fa2007820f4b574fb687ddc9f173f7eec33055de7877b853e9f6341e5504eadae356da91616745b
-  data.tar.gz: 6a085768d78deeb6495d70a0602c22f1ed8e9f6da7ae6f70539cbd35c6761e54db1de7f46ade23892ad2bfa3c2bd1c2f43952aca3daf919e34a45a37e2dbdc18
+  metadata.gz: bd78b0f6ac4f5c8fbd92420fad1ca86fcf8924f67d1efbffad75b6ed1eda634d1b2bcdfa8796f5fa69e01f117b5a784154050947e73f4320dc5d4e66d043175a
+  data.tar.gz: 65a30edca0fb6441e28349e9d14c1ab9caae09052e8da191a194612e0f7d99a23329c122d5ab228ee16f64111e1bea111a0e1edb46732f2716139ff25a186a40

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v2.6.0
+
+- Add ability to reduce noise from default rails log subscribers with config option `silent_rails`
+
 ## v2.5.4
 
 - Add compatibility fix for concurrent-ruby library logger which expect `call` method to be defined

data/README.md

@@ -115,6 +115,8 @@ how to configure the library according to your needs.
 
 The sapience configuration can be controlled by either a "sapience.yml" file, or a block of ruby code. Note that if you provide both, the block of ruby code will take precedence.
 
+For a list of available configuration options look at class `Sapience::Configuration`
+
 #### Configuration by sapience.yml file
 
 Add a `config/sapience.yml` file to your application. The config file contains sections for different environments.
@@ -163,6 +165,7 @@ staging:
         
 production:
   log_level: info
+  silent_rails: true # make rails logging less noisy
   error_handler:
     sentry:
       dsn: <%= ENV['SENTRY_DSN'] %>
@@ -182,6 +185,7 @@ Sapience.configure(force: true) do |config|
   config.app_name = "My Application"
   config.default_level   = :info
   config.backtrace_level = :error
+  config.silent_rails = true # make rails logging less noisy
   config.filter_parameters = %w(password password_confirmation)
   config.appenders       = [
       { stream: { io: STDOUT, formatter: :color } },

data/lib/sapience/appender/stream.rb

@@ -60,9 +60,7 @@ module Sapience
       #    logger =  Sapience['test']
       #    logger.info 'Hello World'
       def initialize(options = {}, &block)
-        unless options[:io] || options[:file_name]
-          fail ArgumentError, "missing mandatory argument :file_name or :io"
-        end
+        fail ArgumentError, "missing mandatory argument :file_name or :io" unless options[:io] || options[:file_name]
 
         opts = options.dup
         if (io = opts.delete(:io))
@@ -75,7 +73,6 @@ module Sapience
         # Set the log level and formatter if supplied
         super(opts, &block)
       end
-      # rubocop:enable AbcSize, CyclomaticComplexity, PerceivedComplexity
 
       # After forking an active process call #reopen to re-open
       # open the file handles etc to resources
@@ -87,7 +84,7 @@ module Sapience
         return unless @file_name
         ensure_folder_exist
 
-        @log      = open(@file_name, (::File::WRONLY | ::File::APPEND | ::File::CREAT))
+        @log      = File.open(@file_name, (::File::WRONLY | ::File::APPEND | ::File::CREAT))
         # Force all log entries to write immediately without buffering
         # Allows multiple processes to write to the same log file simultaneously
         @log.sync = true

data/lib/sapience/base.rb

@@ -237,7 +237,7 @@ module Sapience
           message = message.nil? ? result : "#{message} -- #{result}"
         elsif message.nil? && result.is_a?(Hash)
           message = result
-        elsif payload && payload.respond_to?(:merge)
+        elsif payload && payload.respond_to?(:merge) # rubocop: disable Style/SafeNavigation
           payload.merge(result)
         else
           payload = result

data/lib/sapience/config_loader.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require "yaml"
@@ -62,9 +61,7 @@ module Sapience
 
         hash = yaml_safe_load(yaml_code, absolute_path) || {}
 
-        unless hash.is_a?(Hash)
-          fail(TypeError, "Malformed configuration in #{absolute_path}")
-        end
+        fail(TypeError, "Malformed configuration in #{absolute_path}") unless hash.is_a?(Hash)
 
         hash
       end

data/lib/sapience/configuration.rb

@@ -7,7 +7,8 @@ module Sapience
   class Configuration
     attr_reader :default_level, :backtrace_level, :backtrace_level_index
     attr_writer :host
-    attr_accessor :app_name, :ap_options, :appenders, :log_executor, :filter_parameters, :metrics, :error_handler
+    attr_accessor :app_name, :ap_options, :appenders, :log_executor, :filter_parameters,
+      :metrics, :error_handler, :silent_rails
 
     SUPPORTED_EXECUTORS = %i(single_thread_executor immediate_executor).freeze
     DEFAULT = {
@@ -19,6 +20,7 @@ module Sapience
       metrics:           { datadog: { url: Sapience::DEFAULT_STATSD_URL } },
       error_handler:     { silent: {} },
       filter_parameters: %w(password password_confirmation),
+      silent_rails:      false,
     }.freeze
 
     # Initial default Level for all new instances of Sapience::Logger
@@ -37,6 +39,7 @@ module Sapience
       self.filter_parameters = @options[:filter_parameters]
       self.metrics           = @options[:metrics]
       self.error_handler     = @options[:error_handler]
+      self.silent_rails      = @options[:silent_rails]
     end
 
     # Sets the global default log level
@@ -118,4 +121,5 @@ module Sapience
       fail InvalidLogExecutor, "#{log_executor} is unsupported. Use (#{SUPPORTED_EXECUTORS.join(", ")})"
     end
   end
+  # rubocop:enable ClassVars
 end

data/lib/sapience/core_ext/thread.rb

@@ -1,6 +1,4 @@
 # frozen_string_literal: true
-require "thread"
-
 class Thread
   # Returns the name of the current thread
   # Default:

data/lib/sapience/extensions/action_controller/notifications.rb

@@ -38,9 +38,7 @@ module Sapience
           metrics.batch do
             metrics.increment metric_name, tags: tags
             metrics.timing("#{metric_name}.time", event.duration, tags: tags)
-            if payload[:db_runtime]
-              metrics.timing("#{metric_name}.time.db", payload[:db_runtime].round(10), tags: tags)
-            end
+            metrics.timing("#{metric_name}.time.db", payload[:db_runtime].round(10), tags: tags) if payload[:db_runtime]
 
 
 

data/lib/sapience/extensions/grape/middleware/logging.rb

@@ -29,7 +29,7 @@ module Sapience
             error = catch(:error) do
               begin
                 @app_response = @app.call(@env)
-              rescue => e
+              rescue StandardError => e
                 after_exception(e)
                 raise e
               end
@@ -55,8 +55,8 @@ module Sapience
             @logger.info(parameters)
           end
 
-          def after_exception(e)
-            Sapience.push_tags(e.class.name, e.message)
+          def after_exception(exc)
+            Sapience.push_tags(exc.class.name, exc.message)
             @status = 500
             after
           end

data/lib/sapience/log.rb

@@ -125,7 +125,7 @@ module Sapience
     # Returns [String, String] the file_name and line_number from the backtrace supplied
     # in either the backtrace or exception
     def file_name_and_line(short_name = false) # rubocop:disable CyclomaticComplexity
-      return unless backtrace || (exception && exception.backtrace)
+      return unless backtrace || (exception && exception.backtrace) # rubocop: disable Style/SafeNavigation
       stack = backtrace || exception.backtrace
       extract_file_and_line(stack, short_name) if stack && !stack.empty?
     end
@@ -168,7 +168,7 @@ module Sapience
     # Ruby MRI supports micro seconds
     # DEPRECATED
     def formatted_time
-      format("#{time.strftime("%Y-%m-%d %H:%M:%S")}.%06d", time.usec)
+      format("#{time.strftime("%Y-%m-%d %H:%M:%S")}.%06d", time.usec) # rubocop: disable Style/FormatStringToken
     end
 
     # Returns [Hash] representation of this log entry

data/lib/sapience/loggable.rb

@@ -27,5 +27,5 @@ module Sapience
       end
     end
   end
-  # rubocop:enable TrivialAccessors
+
 end

data/lib/sapience/logger.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require "concurrent"
 
-# rubocop:disable ClassVars
+# rubocop:disable ClassVars, Style/SafeNavigation
 module Sapience
   # Logger stores the class name to be used for all log messages so that every
   # log message written by this instance will include the class name
@@ -86,7 +86,6 @@ module Sapience
 
     # Separate appender thread responsible for reading log messages and
     # calling the appenders in it's thread
-    # rubocop:disable LineLength
     def self.appender_thread
       @@appender_thread
     end
@@ -146,10 +145,10 @@ module Sapience
         end
       end
     end
-    # rubocop:enable BlockNesting, AssignmentInCondition, PerceivedComplexity, CyclomaticComplexity, AbcSize, LineLength, RescueException
 
     def flush
       self.class.flush
     end
   end
 end
+# rubocop:enable ClassVars, Style/SafeNavigation

data/lib/sapience/metrics/datadog.rb

@@ -28,7 +28,6 @@ module Sapience
       #   tags: [String]
       #     Example:
       #       tag1:true
-      # rubocop:disable CyclomaticComplexity, PerceivedComplexity
 
       def initialize(opts = {})
         options = opts.dup
@@ -39,7 +38,7 @@ module Sapience
       end
 
       def provider
-        @_provider ||= ::Datadog::Statsd.new(@uri.host, @uri.port, dog_options)
+        @provider ||= ::Datadog::Statsd.new(@uri.host, @uri.port, dog_options)
       end
 
       def valid?
@@ -119,6 +118,8 @@ module Sapience
       # @example Create an Event with a custom aggregation_key
       #   Sapience.metrics.event('article-published', "article #123", {aggregation_key: 'custom_aggregation_key')
 
+
+      # rubocop:disable CyclomaticComplexity, PerceivedComplexity
       def event(title, text = "", opts = {})
         return false unless valid?
         fail ArgumentError "Title must be provided" unless title
@@ -135,6 +136,7 @@ module Sapience
         title = "#{namespace_prefix}.#{title}" if namespaced_keys.include?(:title)
         provider.event(title, text, opts)
       end
+      # rubocop:enable CyclomaticComplexity, PerceivedComplexity
 
       def success(module_name, action, opts = {})
         increment("success", add_tags(module_name, action, opts))

data/lib/sapience/rails/engine.rb

@@ -72,6 +72,10 @@ module Sapience
         require "sapience/extensions/active_job/logging" if defined?(ActiveJob)
         # Replace the Bugsnag logger
         Bugsnag.configure { |config| config.logger = Sapience[Bugsnag] } if defined?(Bugsnag)
+
+        # Make rails less noisy
+        Silencer.remove_log_subscriptions if Sapience.config.silent_rails
+
         Sapience::Extensions::ActionController::LogSubscriber.attach_to :action_controller
         # Sapience::Extensions::ActiveSupport::MailerLogSubscriber.attach_to :action_mailer
         Sapience::Extensions::ActiveRecord::Notifications.use if defined?(ActiveRecord)

data/lib/sapience/rails/silencer.rb

@@ -0,0 +1,30 @@
+module Sapience
+  module Rails
+    module Silencer
+
+      # remove all rails log subscribers. Copied from project https://github.com/roidrage/lograge
+      def self.remove_log_subscriptions
+        ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
+          case subscriber
+          when ActionView::LogSubscriber
+            unsubscribe(:action_view, subscriber)
+          when ActionController::LogSubscriber
+            unsubscribe(:action_controller, subscriber)
+          end
+        end
+      end
+
+      def self.unsubscribe(component, subscriber)
+        events = subscriber.public_methods(false).reject { |method| method.to_s == "call" }
+        events.each do |event|
+          ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{component}").each do |listener|
+            if listener.instance_variable_get("@delegate") == subscriber
+              ActiveSupport::Notifications.unsubscribe listener
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/sapience/rails.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require "sapience/rails/railtie"
 require "sapience/rails/engine"
+require "sapience/rails/silencer"
 
 module Sapience
   module Rails

data/lib/sapience/sapience.rb

@@ -69,9 +69,7 @@ module Sapience
   end
 
   def self.default_options(options = {})
-    unless environment =~ /default|rspec/
-      warn "No configuration for environment #{environment}. Using 'default'"
-    end
+    warn "No configuration for environment #{environment}. Using 'default'" unless environment =~ /default|rspec/
     options[DEFAULT_ENV]
   end
 
@@ -236,7 +234,7 @@ module Sapience
   end
 
   def self.known_appenders
-    @_known_appenders ||= Sapience::Subscriber.descendants
+    @known_appenders ||= Sapience::Subscriber.descendants
   end
 
   # Examples:
@@ -466,7 +464,7 @@ module Sapience
   end
 
   def self.root
-    @_root ||= Gem::Specification.find_by_name("sapience").gem_dir
+    @root ||= Gem::Specification.find_by_name("sapience").gem_dir
   end
 
   def self.app_name_builder
@@ -475,3 +473,4 @@ module Sapience
       ENV[APP_NAME]
   end
 end
+# rubocop:enable ClassVars

data/lib/sapience/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Sapience
-  VERSION = "2.5.4"
+  VERSION = "2.6.0"
 end

data/sapience.gemspec

@@ -1,6 +1,5 @@
-# coding: utf-8
 # frozen_string_literal: true
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "sapience/version"
 
@@ -27,23 +26,23 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "concurrent-ruby", "~> 1.0"
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "reevoocop"
-  spec.add_development_dependency "fuubar"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "simplecov-json"
-  spec.add_development_dependency "rspec-its"
-  spec.add_development_dependency "pry-nav"
-  spec.add_development_dependency "sentry-raven"
-  spec.add_development_dependency "dogstatsd-ruby", "~> 2.0"
-  spec.add_development_dependency "rails", "~> 5.0.0.1"
-  spec.add_development_dependency "grape"
   spec.add_development_dependency "active_model_serializers", "~> 0.10.0"
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "dogstatsd-ruby", "~> 2.0"
+  spec.add_development_dependency "fuubar"
   spec.add_development_dependency "gem-release"
+  spec.add_development_dependency "grape"
   spec.add_development_dependency "memory_profiler"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "rails", "~> 5.0.0.1"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "reevoocop"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its"
   spec.add_development_dependency "rspec-prof"
-  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "sentry-raven"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov-json"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sapience
 version: !ruby/object:Gem::Version
-  version: 2.5.4
+  version: 2.6.0
 platform: ruby
 authors:
 - Mikael Henriksson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-24 00:00:00.000000000 Z
+date: 2018-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -26,49 +26,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: 0.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
-  name: reevoocop
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,21 +82,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fuubar
+  name: dogstatsd-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -110,7 +110,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov-json
+  name: gem-release
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -124,7 +124,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-its
+  name: grape
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -138,7 +138,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-nav
+  name: memory_profiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -152,7 +152,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sentry-raven
+  name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -166,35 +166,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dogstatsd-ruby
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 5.0.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 5.0.0.1
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.1
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.1
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: grape
+  name: reevoocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -208,21 +208,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: active_model_serializers
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -236,7 +236,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: gem-release
+  name: rspec-prof
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -250,7 +250,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: memory_profiler
+  name: sentry-raven
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -264,7 +264,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-prof
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -278,7 +278,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: simplecov-json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -374,6 +374,7 @@ files:
 - lib/sapience/rails.rb
 - lib/sapience/rails/engine.rb
 - lib/sapience/rails/railtie.rb
+- lib/sapience/rails/silencer.rb
 - lib/sapience/sapience.rb
 - lib/sapience/sneakers.rb
 - lib/sapience/subscriber.rb