logstash-logger 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7f6fe8282858937026c5c9747835e68bd16390f
-  data.tar.gz: 8de048a5dab4c3a46e1f74fd7b192cc7e82ac58f
+  metadata.gz: 1de31545fcd13dd8e1d6a5c3bcd4d69b29e4579a
+  data.tar.gz: c45861aa001389601e4ef8f4352879d58d0758fb
 SHA512:
-  metadata.gz: c6e11150819e39e4ffb061160e332570a8d461974b88d6a933b6a9370c26bccde71a4f53942ddfc29b12e40f2f952df659c291a682dabd7a1a9f944430e02d37
-  data.tar.gz: 62077f3594cf26f2e92af9576bbd392e6059f7c141f5acc7d61e6ea850491f37eaaf642138d343c7b9d22436f8608ca3b9b3163941e9db0b7ce562dc4bae918a
+  metadata.gz: 308d6259229cc7aa957cdf5390ac3f7f244b61f6eb0c181498dce44eec7dad74326efb213561824e98349d120c5f39dbe4ef0a3a32919bea292b622a44643833
+  data.tar.gz: 8a746761ac4c20717bb73f21117569c038438433c6fab5200175e6d0e9b71a752e7f7cecf3e44148f7e1962e344948b97485ff6be53548bbc8bf6d3376bb1a8a

data/.travis.yml

@@ -29,7 +29,9 @@ matrix:
     - rvm: 2.3.1
       gemfile: gemfiles/rails_3.2.gemfile
   allow_failures:
-    -rvm: rbx-3.9
+    - rvm: rbx-3.9
 sudo: false
 cache: bundler
-
+addons:
+  code_climate:
+    repo_token: 4d712355fa2863c0f33f413eeede4e52cc221c4bc989a692d97574b1f6010b69

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.17.0
+- Support for logger silencing. [#87](https://github.com/dwbutler/logstash-logger/pull/87)
+- Fixes Rails 5 support. [#86](https://github.com/dwbutler/logstash-logger/issues/86)
+- Fixes support for tagged logging in MultiLogger.
+
 ## 0.16.0
 
 This release is focused on improving the reliability of LogStashLogger.

data/Gemfile

@@ -3,3 +3,4 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'codecov', require: false, group: :test
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -286,6 +286,18 @@ change the error logger by setting `LogStashLogger.configuration.default_error_l
 your own logger object in the `:error_logger` configuration key when
 instantiating a LogStashLogger.
 
+## Logger Silencing
+
+LogStashLogger provides support for Rails-style logger silencing. The
+implementation was extracted from Rails, but has no dependencies, so it can be
+used outside of a Rails app. The interface is the same as in Rails:
+
+```ruby
+logger.silence(temporary_level) do
+  ...
+end
+```
+
 ## Rails Integration
 
 Verified to work with both Rails 3, 4, and 5.
@@ -583,7 +595,7 @@ of the logstash listener. There is no known fix at this time. See [#43](https://
 for more information.
 
 ### Errno::EMSGSIZE - Message too long
-A known drawback of using UDP is its limit on total message size. To workaround
+A known drawback of using TCP or UDP is the 65535 byte limit on total message size. To workaround
 this issue, you will have to truncate the message by setting the max message size:
 
 ```ruby
@@ -592,6 +604,10 @@ LogStashLogger.configure do |config|
 end
 ```
 
+This will truncate only the `message` field of the LogStash Event. So make sure
+you set the max message size significantly less than 65535 bytes to make room
+for other fields.
+
 ## Breaking changes
 
 ### Version 0.5+

data/gemfiles/rails_3.2.gemfile

@@ -3,6 +3,7 @@
 source "https://rubygems.org"
 
 gem "codecov", :require => false, :group => :test
+gem "codeclimate-test-reporter", :group => :test, :require => nil
 gem "rails", "~> 3.2.18"
 
 gemspec :path => "../"

data/gemfiles/rails_4.0.gemfile

@@ -3,6 +3,7 @@
 source "https://rubygems.org"
 
 gem "codecov", :require => false, :group => :test
+gem "codeclimate-test-reporter", :group => :test, :require => nil
 gem "rails", "~> 4.0.0"
 
 gemspec :path => "../"

data/gemfiles/rails_4.1.gemfile

@@ -3,6 +3,7 @@
 source "https://rubygems.org"
 
 gem "codecov", :require => false, :group => :test
+gem "codeclimate-test-reporter", :group => :test, :require => nil
 gem "rails", "~> 4.1.1"
 
 gemspec :path => "../"

data/gemfiles/rails_4.2.gemfile

@@ -3,6 +3,7 @@
 source "https://rubygems.org"
 
 gem "codecov", :require => false, :group => :test
+gem "codeclimate-test-reporter", :group => :test, :require => nil
 gem "rails", "~> 4.2.0"
 
 gemspec :path => "../"

data/gemfiles/rails_5.0.gemfile

@@ -3,6 +3,7 @@
 source "https://rubygems.org"
 
 gem "codecov", :require => false, :group => :test
+gem "codeclimate-test-reporter", :group => :test, :require => nil
 gem "rails", "~> 5.0.0"
 
 gemspec :path => "../"

data/lib/logstash-logger/logger.rb

@@ -1,5 +1,6 @@
 require 'logger'
 require 'logstash-logger/tagged_logging'
+require 'logstash-logger/silenced_logging'
 
 module LogStashLogger
   autoload :MultiLogger, 'logstash-logger/multi_logger'
@@ -68,6 +69,7 @@ module LogStashLogger
       logger.instance_variable_set(:@device, device)
       logger.extend(self)
       logger.extend(TaggedLogging)
+      logger.extend(SilencedLogging)
     end
   end
 
@@ -87,5 +89,6 @@ module LogStashLogger
 
     logger.extend(self)
     logger.extend(TaggedLogging)
+    logger.extend(SilencedLogging)
   end
 end

data/lib/logstash-logger/multi_logger.rb

@@ -1,6 +1,9 @@
 # Adapted from https://github.com/ffmike/multilogger
 module LogStashLogger
   class MultiLogger < ::Logger
+    # Array of Loggers to be logged to. These can be anything that acts reasonably like a Logger.
+    attr_accessor :loggers
+
     def level=(value)
       super
       @loggers.each do |logger|
@@ -28,8 +31,39 @@ module LogStashLogger
       end
     end
 
-    # Array of Loggers to be logged to. These can be anything that acts reasonably like a Logger.
-    attr_accessor :loggers
+    def silence(temporary_level = ::Logger::ERROR, &block)
+      silenceable_loggers = @loggers.select do |logger|
+        logger.respond_to?(:silence)
+      end
+
+      silence_loggers(temporary_level, silenceable_loggers, &block)
+    end
+
+    def silence_loggers(temporary_level = ::Logger::ERROR, silenceable_loggers, &block)
+      return yield(self) if silenceable_loggers.empty?
+
+      silenceable_loggers.shift.silence(temporary_level) do
+        silence_loggers(temporary_level, silenceable_loggers, &block)
+      end
+    end
+    private :silence_loggers
+
+    def tagged(*tags, &block)
+      taggable_loggers = @loggers.select do |logger|
+        logger.respond_to?(:tagged)
+      end
+
+      tag_loggers(tags, taggable_loggers, &block)
+    end
+
+    def tag_loggers(tags, taggable_loggers, &block)
+      return yield(self) if taggable_loggers.empty?
+
+      taggable_loggers.shift.tagged(*tags) do
+        tag_loggers(tags, taggable_loggers, &block)
+      end
+    end
+    private :tag_loggers
 
     # Any method not defined on standard Logger class, just send it on to anyone who will listen
     def method_missing(name, *args, &block)

data/lib/logstash-logger/silenced_logging.rb

@@ -0,0 +1,83 @@
+# Adapted from:
+# https://github.com/rails/activerecord-session_store/blob/master/lib/active_record/session_store/extension/logger_silencer.rb
+# https://github.com/rails/rails/pull/16885
+
+require 'thread'
+
+# Add support for Rails-style logger silencing. Thread-safe and no dependencies.
+#
+# Setup:
+#   logger = Logger.new(STDOUT)
+#   logger.extend(LogStashLogger::SilencedLogging)
+#
+# Usage:
+#
+#   logger.silence do
+#     ...
+#   end
+#
+module LogStashLogger
+  module SilencedLogging
+    def self.extended(logger)
+      class << logger
+        attr_accessor :silencer
+        alias_method :level_without_threadsafety, :level
+        alias_method :level, :level_with_threadsafety
+        alias_method :add_without_threadsafety, :add
+        alias_method :add, :add_with_threadsafety
+
+        Logger::Severity.constants.each do |severity|
+          instance_eval <<-EOT, __FILE__, __LINE__ + 1
+            def #{severity.downcase}?                # def debug?
+              Logger::#{severity} >= level           #   DEBUG >= level
+            end                                      # end
+          EOT
+        end
+      end
+
+      logger.instance_eval do
+        self.silencer = true
+      end
+    end
+
+    def thread_level
+      Thread.current[thread_hash_level_key]
+    end
+
+    def thread_level=(level)
+      Thread.current[thread_hash_level_key] = level
+    end
+
+    def level_with_threadsafety
+      thread_level || level_without_threadsafety
+    end
+
+    def add_with_threadsafety(severity, message = nil, progname = nil, &block)
+      if (defined?(@logdev) && @logdev.nil?) || (severity || UNKNOWN) < level
+        true
+      else
+        add_without_threadsafety(severity, message, progname, &block)
+      end
+    end
+
+    # Silences the logger for the duration of the block.
+    def silence(temporary_level = Logger::ERROR)
+      if silencer
+        begin
+          self.thread_level = temporary_level
+          yield self
+        ensure
+          self.thread_level = nil
+        end
+      else
+        yield self
+      end
+    end
+
+    private
+
+    def thread_hash_level_key
+      @thread_hash_level_key ||= :"ThreadSafeLogger##{object_id}@level"
+    end
+  end
+end

data/lib/logstash-logger/version.rb

@@ -1,3 +1,3 @@
 module LogStashLogger
-  VERSION = "0.16.0"
+  VERSION = "0.17.0"
 end

data/spec/multi_logger_spec.rb

@@ -27,6 +27,33 @@ describe LogStashLogger::MultiLogger do
       expect(logger).to receive(:info).with("test")
     end
 
-    multi_logger.info("test")
+    subject.info("test")
+  end
+
+  it "supports silenced logging" do
+    subject.loggers.each do |logger|
+      expect(logger).to receive(:silence).and_call_original
+      expect(logger.device).to receive(:write).once
+    end
+
+    subject.silence(::Logger::WARN) do |logger|
+      expect(logger).to eq(subject)
+      logger.info 'info'
+      logger.warn 'warning'
+    end
+  end
+
+  it "supports tagged logging" do
+    subject.loggers.each do |logger|
+      expect(logger).to receive(:tagged).with('tag').and_call_original
+      expect(logger.device).to receive(:write) do |event_string|
+        event = JSON.parse(event_string)
+        expect(event['tags']).to match_array(['tag'])
+      end
+    end
+
+    subject.tagged('tag') do |logger|
+      logger.info 'test'
+    end
   end
 end

data/spec/silenced_logging_spec.rb

@@ -0,0 +1,31 @@
+require 'logstash-logger'
+
+describe LogStashLogger do
+  include_context 'logger'
+
+  describe "silenced logging" do
+
+    it "yields the logger" do
+      logger.silence do |yielded|
+        expect(yielded).to eq(logger)
+      end
+    end
+
+    it "silences any message below ERROR level by default" do
+      logger.silence do
+        expect(logger.device).to receive(:write).once
+        logger.info("info")
+        logger.warn("warning")
+        logger.error("error")
+      end
+    end
+
+    it "takes a custom log level to silence to" do
+      logger.silence(::Logger::WARN) do
+        expect(logger.device).to receive(:write).once
+        logger.info("info")
+        logger.warn("warning")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -7,6 +7,9 @@ if ENV['CI']=='true'
   SimpleCov.formatter = SimpleCov::Formatter::Codecov
 end
 
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 RSpec.configure do |config|
   config.order = "random"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-logger
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - David Butler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-13 00:00:00.000000000 Z
+date: 2016-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -198,6 +198,7 @@ files:
 - lib/logstash-logger/logger.rb
 - lib/logstash-logger/multi_logger.rb
 - lib/logstash-logger/railtie.rb
+- lib/logstash-logger/silenced_logging.rb
 - lib/logstash-logger/tagged_logging.rb
 - lib/logstash-logger/version.rb
 - logstash-logger.gemspec
@@ -235,6 +236,7 @@ files:
 - spec/logger_spec.rb
 - spec/multi_logger_spec.rb
 - spec/rails_spec.rb
+- spec/silenced_logging_spec.rb
 - spec/spec_helper.rb
 - spec/syslog_spec.rb
 - spec/tagged_logging_spec.rb
@@ -288,6 +290,7 @@ test_files:
 - spec/logger_spec.rb
 - spec/multi_logger_spec.rb
 - spec/rails_spec.rb
+- spec/silenced_logging_spec.rb
 - spec/spec_helper.rb
 - spec/syslog_spec.rb
 - spec/tagged_logging_spec.rb