rack_silence 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 64c30a9c95b5d1ff08eb57f4b7181b915a7f6c25
+  data.tar.gz: 585719b0de34aab4371503887eb7273a4b695e29
+SHA512:
+  metadata.gz: 2e03489bb4f19443fae7a3d7b2a625afbdef866b14c29022592cd88ddd9f7797f7e3d70b16148246fb4caa4edbaaeb6bfcbcdf38120534d62e0da257cb05dec7
+  data.tar.gz: b73bac4906311aa12a66bb31dcab4daa14358d9fdc4c4d776eed3bd52c61d3317772cfa219fce5a8c3e09199649a217b0216aa18df61b727a6ea5d83d82ccfbe

data/lib/rack_silence.rb

@@ -0,0 +1,93 @@
+require 'rack'
+
+# Rack middleware that allows silencing select requests
+# by path or header. Token can be set to prevent arbitrary
+# people from silencing logs.
+#
+# Example `config/initializers/rack_silence.rb` for Rails:
+#
+#     # inject rack logger in Application class:
+#     Rails.application.config
+#     .middleware.insert_before(Rails::Rack::Logger, RackSilence::Logger,
+#                               silenced: [RackSilence.token("decafbad"),
+#                                          '/noisy/action.json',
+#                                          %r{^/uninteresting/[0-9]+}])
+module RackSilence
+  # Impose silence on the app's logger
+  class Logger
+    # @param app Rack app
+    # @param logger set logger to control. Make it lazy in a `proc`
+    #   Defaults to a lazy `Rails.logger`
+    # @param header check header `X-SILENCE-LOGGER` before silencing
+    #   Can be true, false, or `:token`
+    # @param silenced array of criterias to silence
+    #   Can be `String` or `Regexp` to match a path, or `Token` objects
+    def initialize(app, opts = {})
+      @app = app
+      @opts = opts
+      @opts[:silenced] ||= []
+      @opts[:logger]   ||= -> { Rails.logger }
+      @opts[:level]    ||= ::Logger::ERROR
+    end
+
+    def call(env)
+      return @app.call(env) unless silence?(env)
+
+      silence_new_relic
+      silence(logger) { @app.call(env) }
+    end
+
+    protected
+
+    def silence_new_relic
+      NewRelic::Agent.ignore_transaction
+    rescue NameError
+      nil
+    end
+
+    def silence(logger, temporary_level = @opts[:level])
+      previous_level, logger.level = logger.level, temporary_level
+      yield
+    ensure
+      logger.level = previous_level
+    end
+
+    def logger
+      @opts[:logger].respond_to?(:call) ? @opts[:logger].call : @opts[:logger]
+    end
+
+    def silence?(env)
+      header_silence?(env) || path_silence?(env)
+    end
+
+    def header_silence?(env)
+      return unless @opts.key?(:header)
+
+      if @opts[:header] == :token
+        return @opts[:silenced].reduce(false) do |acc, rule|
+          acc || rule.is_a?(Token) && rule == env['HTTP_X_SILENCE_LOGGER']
+        end
+      end
+
+      env.key?('HTTP_X_SILENCE_LOGGER') if @opts[:header]
+    end
+
+    def path_silence?(env)
+      @opts[:silenced].reduce(false) do |acc, rule|
+        acc || case rule
+               when String then rule == env['PATH_INFO']
+               when Regexp then rule.match(env['PATH_INFO'])
+               else false
+               end
+      end
+    end
+  end
+
+  # Token value to match against in header
+  class Token < String; end
+
+  # Convenience function to create a token
+  def self.token(value)
+    Token.new(value)
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: rack_silence
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Loic Nageleisen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email: loic.nageleisen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rack_silence.rb
+homepage: 
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Silence logs per request from Rack
+test_files: []
+has_rdoc: