logstash-logger 0.20.1 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa6e6be4a21f97e0e387f3302e453bff59a95427
-  data.tar.gz: 574fcb1301072aa8b5653f86580097fc57505f53
+  metadata.gz: 514e39db2da9a557f7ae7d76f0983d1d0df0ad0e
+  data.tar.gz: 5f1b91eaf92734f575210e0b47605d18b9e9a009
 SHA512:
-  metadata.gz: f8c48f7d03ed01bb01072760411c27f3551844b7157b9f501eb371db633924c470d8238bf9de5f998aae0c34b601263f132158034db4c94f3c6ed6075b34d974
-  data.tar.gz: acd9a7821effd72b1ef1bb1d812ccf25bdf92b1fcf8774473f2ca38fa195ad9250d54e7e97718ce7f4bf8c5f01a87dabf5bbd62a6a90ea83f512c6e96882c888
+  metadata.gz: 1cd1f25d9c54d7819ffc8c5a8707de72df1f46ac61bf410c6f7777eb6364aca34378e7cce99701e69eeb8febb1a15e433af2fbac39bd74d43e9dcd068bbbcdb1
+  data.tar.gz: 19eff3e6e2b01ddf299060372dc6caeae1a9fe148f8bb04d2e8d3e10f93e16e80229a3ef1819dbb08a81eda59fd53b13cf2552ab1bd05078702b56b055cc3709

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.21.0
+
+- Support for merging top level configuration in MultiLogger and
+  MultiDelegator. [#108](https://github.com/dwbutler/logstash-logger/pull/108)
+
 ## 0.20.1
 
 - Fixes missing require for URI [#107](https://github.com/dwbutler/logstash-logger/pull/107)

data/README.md

@@ -238,6 +238,17 @@ This configuration would result in the following output.
 }
 ```
 
+This block has full access to the event, so you can remove fields, modify
+existing fields, etc. For example, to remove the default timestamp:
+
+```ruby
+config = LogStashLogger.configure do |config|
+  config.customize_event do |event|
+    event.remove('@timestamp')
+  end
+end
+```
+
 ## Buffering / Automatic Retries
 
 For devices that establish a connection to a remote service, log messages are buffered internally
@@ -269,6 +280,9 @@ Please be aware of the following caveats to this behavior:
    immediately. In my testing, it took Ruby about 4 seconds to notice the receiving end was down
    and start raising exceptions. Since logstash listeners over TCP/UDP do not acknowledge received
    messages, it's not possible to know which log messages to re-send.
+ * When `sync` is turned off, Ruby may buffer data internally before writing to
+   the IO device. This is why you may not see messages written immediately to a
+   UDP or TCP socket, even though LogStashLogger's buffer is periodically flushed.
 
 ## Full Buffer
 
@@ -597,6 +611,14 @@ For a more detailed discussion of UDP vs TCP, I recommend reading this article:
 
 ## Troubleshooting
 
+### Logstash never receives any logs
+If you are using a device backed by a Ruby IO object (such as a file, UDP socket, or TCP socket), please be aware that Ruby
+keeps its own internal buffer. Despite the fact that LogStashLogger buffers
+messages and flushes them periodically, the data written to the IO object can
+be buffered by Ruby internally indefinitely, and may not even write until the
+program terminates. If this bothers you or you need to see log messages
+immediately, your only recourse is to set the `sync: true` option.
+
 ### JSON::GeneratorError
 Your application is probably attempting to log data that is not encoded in a valid way. When this happens, Ruby's
 standard JSON library will raise an exception. You may be able to overcome this by swapping out a different JSON encoder
@@ -671,6 +693,7 @@ logger = LogStashLogger.new('localhost', 5228, :tcp)
 * [Mike Gunderloy](https://github.com/ffmike)
 * [Vitaly Gorodetsky](https://github.com/vitalis)
 * [Courtland Caldwell](https://github.com/caldwecr)
+* [Bibek Shrestha](https://github.com/bibstha)
 
 ## Contributing
 

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

@@ -10,14 +10,16 @@ module LogStashLogger
 
       def initialize(opts)
         @io = self
-        @devices = create_devices(opts[:outputs])
+        @devices = create_devices(opts)
         self.class.delegate(:write, :close, :close!, :flush)
       end
 
       private
 
       def create_devices(opts)
-        opts.map do |device_opts|
+        output_configurations = opts.delete(:outputs)
+        output_configurations.map do |device_opts|
+          device_opts = opts.merge(device_opts)
           Device.new(device_opts)
         end
       end

data/lib/logstash-logger/logger.rb

@@ -72,7 +72,11 @@ module LogStashLogger
   end
 
   def self.build_multi_logger(opts)
-    loggers = opts[:outputs].map { |logger_opts| build_logger(logger_opts) }
+    output_configurations = opts.delete(:outputs) || []
+    loggers = output_configurations.map do |config|
+      logger_opts = opts.merge(config)
+      build_logger(logger_opts)
+    end
     MultiLogger.new(loggers)
   end
 

data/lib/logstash-logger/version.rb

@@ -1,3 +1,3 @@
 module LogStashLogger
-  VERSION = "0.20.1"
+  VERSION = "0.21.0"
 end

data/spec/constructor_spec.rb

@@ -0,0 +1,22 @@
+require 'logstash-logger'
+
+describe LogStashLogger do
+  describe ".new" do
+    it "returns a Logger instance" do
+      expect(LogStashLogger.new(type: :stdout)).to be_a ::Logger
+    end
+
+    context "type: :multi_logger" do
+      it "returns an instance of LogStashLogger::MultiLogger" do
+        expect(LogStashLogger.new(type: :multi_logger)).to be_a LogStashLogger::MultiLogger
+      end
+
+      it "merges top level configuration into each logger" do
+        logger = LogStashLogger.new(type: :multi_logger, port: 1234, outputs: [ { type: :tcp  }, { type: :udp } ])
+        logger.loggers.each do |logger|
+          expect(logger.device.port).to eq(1234)
+        end
+      end
+    end
+  end
+end

data/spec/device/multi_delegator_spec.rb

@@ -12,4 +12,20 @@ describe LogStashLogger::Device::MultiDelegator do
 
     subject.write("test")
   end
+
+  describe ".new" do
+    it "merges top level configuration to each output" do
+      logger = described_class.new(
+        port: 1234,
+        outputs: [
+          { type: :udp },
+          { type: :tcp }
+        ]
+      )
+
+      logger.devices.each do |device|
+        expect(device.port).to eq(1234)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-logger
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.21.0
 platform: ruby
 authors:
 - David Butler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-18 00:00:00.000000000 Z
+date: 2016-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -199,6 +199,7 @@ files:
 - samples/udp.conf
 - samples/unix.conf
 - spec/configuration_spec.rb
+- spec/constructor_spec.rb
 - spec/device/balancer_spec.rb
 - spec/device/connectable_spec.rb
 - spec/device/file_spec.rb
@@ -253,6 +254,7 @@ specification_version: 4
 summary: LogStash Logger for ruby
 test_files:
 - spec/configuration_spec.rb
+- spec/constructor_spec.rb
 - spec/device/balancer_spec.rb
 - spec/device/connectable_spec.rb
 - spec/device/file_spec.rb