logstash-logger 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 028f82a7160982a2b3d5d7fea16a87b408f28f19
-  data.tar.gz: 31e13e392d3315844dfeb73e7f8b61a764575d60
+  metadata.gz: 226fca630b4975188d705c7a09a96f48d8fe7f3b
+  data.tar.gz: f898f4f314c038719ce689f1e9a63c4f4679bbd9
 SHA512:
-  metadata.gz: 5c97296f106d4c66323026861e587dc98b2dd00bb53a09fa2de273cbd4bcb2dd8270ffee84e2003fbb0309343a42485d08b104108da512a45f59ba39a312b711
-  data.tar.gz: dec18c3ff5a7d76da22ab9cdb8e62bca254742013b2f12b09298a1753bd8c3f288d35ebd18eb51b7b5eee8afd4545abedcd40a694d48b7d6d621092be3d9a884
+  metadata.gz: ef10037612a82b594afbd20b6349daf16d2803dc519a199be08dc499d264e5106f162e8668b0d689d11bc9b8e5a8d4256fc7ace7a9a176975c8459d508bb5317
+  data.tar.gz: b55942ec2be01e35b92c557472b772ca08504ad11460ff204c49c26491567a1b29b8acf50bc1c52cd2cadd30775024a01db88b90325480913c59560aacad5a14

data/.gitignore

@@ -17,3 +17,4 @@ test/tmp
 test/version_tmp
 tmp
 .idea/
+log/

data/.travis.yml

@@ -6,9 +6,11 @@ rvm:
   - 2.1.1
   - 2.1.2
   - 2.1.3
+  - 2.2.0
   - jruby-19mode
   - rbx-2
 gemfile:
   - gemfiles/rails_3.2.gemfile
   - gemfiles/rails_4.0.gemfile
   - gemfiles/rails_4.1.gemfile
+  - gemfiles/rails_4.2.gemfile

data/Appraisals

@@ -8,4 +8,8 @@ end
 
 appraise "rails-4.1" do
   gem "rails", "~> 4.1.1"
-end
+end
+
+appraise "rails-4.2" do
+  gem "rails", "~> 4.2.0"
+end

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.8.0
+- Support for logging to stderr. Fixes [#24](https://github.com/dwbutler/logstash-logger/pull/25).
+Thanks [Jan Schulte](https://github.com/schultyy)!
+- Support multiple log outputs. Fixes [#28](https://github.com/dwbutler/logstash-logger/pull/28).
+Thanks [Kurt Preston](https://github.com/KurtPreston)!
+
 ## 0.7.0
 - Support for logging to a generic IO object.
 - Support for overriding IO in stdout logger. Fixes [#20](https://github.com/dwbutler/logstash-logger/pull/20).

data/README.md

@@ -8,7 +8,7 @@ writing to a file or syslog since logstash can receive the structured data direc
 ## Features
 
 * Can write directly to logstash over a UDP or TCP/SSL connection.
-* Can write to a file, Redis, a unix socket, or stdout.
+* Can write to a file, Redis, a unix socket, stdout or stderr.
 * Always writes in logstash JSON format.
 * Logger can take a string message, a hash, a `LogStash::Event`, an object, or a JSON string as input.
 * Events are automatically populated with message, timestamp, host, and severity.
@@ -45,8 +45,12 @@ file_logger = LogStashLogger.new(type: :file, path: 'log/development.log', sync:
 unix_logger = LogStashLogger.new(type: :unix, path: '/tmp/sock')
 redis_logger = LogStashLogger.new(type: :redis)
 stdout_logger = LogStashLogger.new(type: :stdout)
+stderr_logger = LogStashLogger.new(type: :stderr)
 io_logger = LogStashLogger.new(type: :io, io: io)
 
+# Multiple Outputs
+multi_logger = LogStashLogger.new([{type: :file, path: 'log/development.log'}, {type: :udp, host: 'localhost', port: 5228}])
+
 # The following messages are written to UDP port 5228:
 
 logger.info 'test'
@@ -78,6 +82,7 @@ unix:///tmp/socket
 file:///path/to/file        
 redis://localhost:6379     
 stdout:/
+stderr:/
 ```
 
 Pass the URI into your logstash logger like so:
@@ -248,6 +253,22 @@ config.logstash.type = :io
 config.logstash.io = io
 ```
 
+#### Multiple Outputs
+
+```ruby
+config.logstash = [
+  {
+    type: :file,
+    path: 'log/production.log'
+  },
+  {
+    type: :udp,
+    port: 5228,
+    host: 'localhost'
+  }
+]
+```
+
 ## Ruby Compatibility
 
 Verified to work with:
@@ -299,6 +320,15 @@ logger = LogStashLogger.new('localhost', 5228)
 logger = LogStashLogger.new('localhost', 5228, :tcp)
 ```
 
+## Contributors
+* [David Butler](https://github.com/dwbutler)
+* [pctj101](https://github.com/pctj101)
+* [Gary Rennie](https://github.com/Gazler)
+* [Nick Ethier](https://github.com/nickethier)
+* [Arron Mabrey](https://github.com/arronmabrey)
+* [Jan Schulte](https://github.com/schultyy)
+* [Kurt Preston](https://github.com/KurtPreston)
+
 ## Contributing
 
 1. Fork it

data/gemfiles/rails_4.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.2.0"
+
+gemspec :path => "../"

data/lib/logstash-logger/device.rb

@@ -14,10 +14,25 @@ module LogStashLogger
     autoload :File, 'logstash-logger/device/file'
     autoload :IO, 'logstash-logger/device/io'
     autoload :Stdout, 'logstash-logger/device/stdout'
+    autoload :Stderr, 'logstash-logger/device/stderr'
+    autoload :MultiDelegator, 'logstash-logger/device/multi_delegator'
 
     def self.new(opts)
       opts = opts.dup
 
+      if opts.is_a?(Array)
+        # Multiple device configs supplied... create a MultiDelegator
+        devices = opts.map{|opt| build_device(opt)}
+        Device::MultiDelegator.new(*devices)
+      elsif Hash
+        # Create a single device
+        build_device(opts)
+      else
+        raise ArgumentError, "Invalid device options: must be a Hash or an Array of Hashes"
+      end
+    end
+
+    def self.build_device(opts)
       if parsed_uri_opts = parse_uri_config(opts)
         opts = parsed_uri_opts
       end
@@ -43,6 +58,7 @@ module LogStashLogger
         when :redis then Redis
         when :io then IO
         when :stdout then Stdout
+        when :stderr then Stderr
         else fail ArgumentError, 'Invalid type'
       end
     end

data/lib/logstash-logger/device/multi_delegator.rb

@@ -0,0 +1,28 @@
+# Container to allow writes to multiple devices
+
+# Code originally from:
+# http://stackoverflow.com/a/6410202
+
+module LogStashLogger
+  module Device
+    class MultiDelegator < Base
+      attr_reader :devices
+
+      def initialize(*devices)
+        @io = self
+        @devices = devices
+        self.class.delegate(:write, :close, :flush)
+      end
+
+      private
+
+      def self.delegate(*methods)
+        methods.each do |m|
+          define_method(m) do |*args|
+            @devices.each { |device| device.send(m, *args) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/logstash-logger/device/stderr.rb

@@ -0,0 +1,13 @@
+module LogStashLogger
+  module Device
+    class Stderr < IO
+      def initialize(opts={})
+        super({io: $stderr}.merge(opts))
+      end
+
+      def close
+        # no-op
+      end
+    end
+  end
+end

data/lib/logstash-logger/logger.rb

@@ -29,15 +29,22 @@ module LogStashLogger
   protected
 
   def self.extract_opts(*args)
+    args.flatten!
+
     if args.length > 1
-      puts "[LogStashLogger] (host, port, type) constructor is deprecated. Please use an options hash instead."
-      host, port, type = *args
-      {host: host, port: port, type: type}
+      if args.all?{|arg| arg.is_a?(Hash)}
+        # Array of Hashes
+        args
+      else
+        # Deprecated host/port/type syntax
+        puts "[LogStashLogger] (host, port, type) constructor is deprecated. Please use an options hash instead."
+        host, port, type = *args
+        {host: host, port: port, type: type}
+      end
     elsif Hash === args[0]
       args[0]
     else
       fail ArgumentError, "Invalid LogStashLogger options"
     end
   end
-
 end

data/lib/logstash-logger/railtie.rb

@@ -6,6 +6,25 @@ module LogStashLogger
 
     logger_options = app.config.logstash
 
+    sanitized_logger_options = if logger_options.is_a?(Array)
+                                 logger_options.map do |opts|
+                                   sanitize_logger_options(app, opts)
+                                 end
+                               else
+                                 sanitize_logger_options(app, logger_options)
+                               end
+
+    logger = LogStashLogger.new(sanitized_logger_options)
+
+    logger.level = ::Logger.const_get(app.config.log_level.to_s.upcase)
+
+    app.config.logger = logger
+  end
+
+  def self.sanitize_logger_options(app, logger_options)
+    # Convert logger options to OrderedOptions if regular Hash
+    logger_options = ActiveSupport::OrderedOptions.new.merge(logger_options)
+
     if parsed_uri_options = LogStashLogger::Device.parse_uri_config(logger_options)
       logger_options.delete(:uri)
       logger_options.merge!(parsed_uri_options)
@@ -19,11 +38,7 @@ module LogStashLogger
       logger_options.sync = app.config.autoflush_log
     end
 
-    logger = LogStashLogger.new(logger_options)
-
-    logger.level = ::Logger.const_get(app.config.log_level.to_s.upcase)
-
-    app.config.logger = logger
+    logger_options
   end
 
   class Railtie < ::Rails::Railtie

data/lib/logstash-logger/version.rb

@@ -1,3 +1,3 @@
 module LogStashLogger
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/spec/device/multi_delegator_spec.rb

@@ -0,0 +1,21 @@
+require 'logstash-logger'
+
+describe LogStashLogger::Device::MultiDelegator do
+  include_context 'device'
+
+  # Create a MultiDelegator writing to both STDOUT and a StringIO
+  let(:subject) { multi_delegator_device }
+
+  let(:stdout) { $stdout }
+  let(:io) { StringIO.new }
+
+  it "writes to $stdout" do
+    # MultiDelegator writes to stdout
+    expect(stdout).to receive(:write).once
+
+    # MultiDelegator writes to IO
+    expect(io).to receive(:write).once
+
+    subject.write("test")
+  end
+end

data/spec/device/stderr_spec.rb

@@ -0,0 +1,16 @@
+require 'logstash-logger'
+
+describe LogStashLogger::Device::Stderr do
+  let(:stderr) { $stderr }
+
+  it 'writes to stderr' do
+    expect(subject.to_io).to eq stderr
+    expect(stderr).to receive(:write).once
+    subject.write("test")
+  end
+
+  it 'ignores #close' do
+    expect(stderr).not_to receive(:close)
+    subject.close
+  end
+end

data/spec/device_spec.rb

@@ -76,6 +76,11 @@ describe LogStashLogger::Device do
       let(:uri_config) { stdout_uri_config }
       it { is_expected.to be_a LogStashLogger::Device::Stdout }
     end
+
+    context 'when URI config is stderr' do
+      let(:uri_config) { stderr_uri_config }
+      it { is_expected.to be_a LogStashLogger::Device::Stderr }
+    end
   end
 
 end

data/spec/logger_spec.rb

@@ -11,10 +11,10 @@ describe LogStashLogger do
       UDPSocket.new.tap {|socket| socket.bind(host, port)}
     end
   end
-  
+
   # The TCP socket written to by the TCP logstash listener server
   let(:tcp_client) { listener.accept }
-  
+
   # The logstash event to log
   let(:logstash_event) do
     LogStash::Event.new.tap do |event|
@@ -22,7 +22,7 @@ describe LogStashLogger do
       event['severity'] = 'INFO'
     end
   end
-  
+
   # The raw input received by the logstash listener
   let :listener_input do
     case connection_type
@@ -30,23 +30,23 @@ describe LogStashLogger do
     when :udp then listener.recvfrom(8192)[0]
     end
   end
-  
+
   # The logstash event received by the listener
   let(:listener_event) { LogStash::Event.new(JSON.parse listener_input) }
-  
+
   #before(:each) do
     # Sync socket writes so we can receive them in the listener immediately
     #@socket = logdev.instance_variable_get(:@dev).send(:connect)
     #@socket.sync = true
   #end
-  
+
   after(:each) do
     listener.close
   end
-  
+
   # The socket that the logger is writing to
   #let(:socket) { @socket }
-  
+
   it 'uses a LogStashLogger::Device as the log device' do
     expect(logdev).to be_a Logger::LogDevice
     expect(logdev.instance_variable_get(:@dev)).to be_a LogStashLogger::Device::Base
@@ -63,11 +63,11 @@ describe LogStashLogger do
     end
 
     logger.info(message)
-    
+
     expect(listener_event['message']).to eq(message)
     expect(listener_event['host']).to eq(hostname)
   end
-  
+
   it 'takes a logstash-formatted json string as input and writes out a logstash event' do
     expect(logdev).to receive(:write).and_call_original do |event|
       expect(event).to be_a LogStash::Event
@@ -76,11 +76,11 @@ describe LogStashLogger do
     end
 
     logger.info(logstash_event.to_json)
-    
+
     expect(listener_event['message']).to eq(logstash_event['message'])
     expect(listener_event['host']).to eq(hostname)
   end
-  
+
   it 'takes a LogStash::Event as input and writes it out intact' do
     expect(logdev).to receive(:write).and_call_original do |event|
       expect(event).to be_a LogStash::Event
@@ -89,21 +89,21 @@ describe LogStashLogger do
       expect(event.timestamp).to eql(logstash_event.timestamp)
       expect(event.host).to eql(hostname)
     end
-    
+
     logger.warn(logstash_event)
-    
+
     expect(listener_event['message']).to eq(logstash_event['message'])
     expect(listener_event['severity']).to eq(logstash_event['severity'])
     expect(listener_event['host']).to eq(hostname)
   end
-  
+
   it 'takes a data hash as input and writes out a logstash event' do
     data = {
       'message' => 'test',
       'severity' => 'INFO',
       'foo' => 'bar'
     }
-    
+
     expect(logdev).to receive(:write).and_call_original do |event|
       expect(event).to be_a LogStash::Event
       expect(event['message']).to eql('test')
@@ -113,7 +113,7 @@ describe LogStashLogger do
     end
 
     logger.info(data.dup)
-    
+
     expect(listener_event['message']).to eq(data["message"])
     expect(listener_event['severity']).to eq(data['severity'])
     expect(listener_event['foo']).to eq(data['foo'])
@@ -135,5 +135,5 @@ describe LogStashLogger do
 
     expect(listener_event['message']).to eq(message.inspect)
   end
-  
+
 end

data/spec/rails_spec.rb

@@ -22,7 +22,7 @@ describe LogStashLogger do
     subject { app.config.logger }
 
     before(:each) do
-      app.config.logstash.clear
+      app.config.logstash = ActiveSupport::OrderedOptions.new
       app.config.logger = nil
     end
 
@@ -52,6 +52,29 @@ describe LogStashLogger do
         end
       end
 
+      context "when configured with multiple devices" do
+        before(:each) do
+          app.config.logstash = [
+            {
+              type: :udp,
+              uri: udp_uri
+            },
+            {
+              type: :file
+            }
+          ]
+          LogStashLogger.setup(app)
+        end
+
+        it "uses a multi-delegator" do
+          expect(subject.device).to be_a LogStashLogger::Device::MultiDelegator
+          expect(subject.device.devices.map(&:class)).to eq([
+            LogStashLogger::Device::UDP,
+            LogStashLogger::Device::File
+          ])
+        end
+      end
+
       context "when logstash is not configured" do
         before(:each) do
           LogStashLogger.setup(app)

data/spec/spec_helper.rb

@@ -46,6 +46,7 @@ RSpec.shared_context 'device' do
   let(:io_device) { LogStashLogger::Device.new(type: :io, io: io)}
 
   let(:redis_device) { LogStashLogger::Device.new(type: :redis, sync: true) }
+  let(:multi_delegator_device) { LogStashLogger::Device.new([{type: :stdout}, {type: :io, io: io}]) }
 
   let(:udp_uri) { "udp://localhost:5228" }
   let(:tcp_uri) { "tcp://localhost:5229" }
@@ -53,6 +54,7 @@ RSpec.shared_context 'device' do
   let(:file_uri) { "file://#{file.path}" }
   let(:redis_uri) { "redis://localhost:6379" }
   let(:stdout_uri) { "stdout://localhost" }
+  let(:stderr_uri) { "stderr://localhost" }
 
   let(:invalid_uri_config) { {uri: "non parsable uri"} }
   let(:udp_uri_config)     { {uri: udp_uri} }
@@ -61,4 +63,5 @@ RSpec.shared_context 'device' do
   let(:file_uri_config)    { {uri: file_uri} }
   let(:redis_uri_config)   { {uri: redis_uri} }
   let(:stdout_uri_config)  { {uri: stdout_uri} }
+  let(:stderr_uri_config)  { {uri: stderr_uri} }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-logger
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - David Butler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-05 00:00:00.000000000 Z
+date: 2015-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -155,14 +155,17 @@ files:
 - gemfiles/rails_3.2.gemfile
 - gemfiles/rails_4.0.gemfile
 - gemfiles/rails_4.1.gemfile
+- gemfiles/rails_4.2.gemfile
 - lib/logstash-logger.rb
 - lib/logstash-logger/device.rb
 - lib/logstash-logger/device/base.rb
 - lib/logstash-logger/device/connectable.rb
 - lib/logstash-logger/device/file.rb
 - lib/logstash-logger/device/io.rb
+- lib/logstash-logger/device/multi_delegator.rb
 - lib/logstash-logger/device/redis.rb
 - lib/logstash-logger/device/socket.rb
+- lib/logstash-logger/device/stderr.rb
 - lib/logstash-logger/device/stdout.rb
 - lib/logstash-logger/device/tcp.rb
 - lib/logstash-logger/device/udp.rb
@@ -183,8 +186,10 @@ files:
 - samples/unix.conf
 - spec/device/file_spec.rb
 - spec/device/io_spec.rb
+- spec/device/multi_delegator_spec.rb
 - spec/device/redis_spec.rb
 - spec/device/socket_spec.rb
+- spec/device/stderr_spec.rb
 - spec/device/stdout_spec.rb
 - spec/device/tcp_spec.rb
 - spec/device/udp_spec.rb
@@ -214,15 +219,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: LogStash Logger for ruby
 test_files:
 - spec/device/file_spec.rb
 - spec/device/io_spec.rb
+- spec/device/multi_delegator_spec.rb
 - spec/device/redis_spec.rb
 - spec/device/socket_spec.rb
+- spec/device/stderr_spec.rb
 - spec/device/stdout_spec.rb
 - spec/device/tcp_spec.rb
 - spec/device/udp_spec.rb