logstash-logger 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 226fca630b4975188d705c7a09a96f48d8fe7f3b
-  data.tar.gz: f898f4f314c038719ce689f1e9a63c4f4679bbd9
+  metadata.gz: 84c02ef7b86b7f3bbd3342b9978e6b172f9705ee
+  data.tar.gz: fb9fe50daa68b2c7f441b21816500baeb9c7e081
 SHA512:
-  metadata.gz: ef10037612a82b594afbd20b6349daf16d2803dc519a199be08dc499d264e5106f162e8668b0d689d11bc9b8e5a8d4256fc7ace7a9a176975c8459d508bb5317
-  data.tar.gz: b55942ec2be01e35b92c557472b772ca08504ad11460ff204c49c26491567a1b29b8acf50bc1c52cd2cadd30775024a01db88b90325480913c59560aacad5a14
+  metadata.gz: e759b59bb77b80ab16c15c99a22e33d33d81af4e151eaacd722fb6cf69648161f4e0053a5c54f97938a71c08dc63482e4ac5849fbf43854ca23be1520f8de8bd
+  data.tar.gz: 0da0fe1fd184fc8ddbe7ebb9a16c103496a9b8d9add08a1428ba707bcb794c87429fabce1a896e83d89b92452f467ccc9fd7b93fe7a6cfccbb76298a6ab73319

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.9.0
+- Support for customizing the fields on all logged messages via configuration.
+Fixes [#32](https://github.com/dwbutler/logstash-logger/pull/32).
+Thanks [Chris Blatchley](https://github.com/chrisblatchley)!
+
 ## 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)!

data/README.md

@@ -76,11 +76,11 @@ such as Heroku where you may want to read configuration values from the environm
 is `type://host:port/path`. Some sample URI configurations are given below.
 
 ```
-udp://localhost:5228       
-tcp://localhost:5229       
+udp://localhost:5228
+tcp://localhost:5229
 unix:///tmp/socket
-file:///path/to/file        
-redis://localhost:6379     
+file:///path/to/file
+redis://localhost:6379
 stdout:/
 stderr:/
 ```
@@ -143,6 +143,44 @@ input {
 }
 ```
 
+## Custom Log Fields
+
+`LogStashLogger` by default will log a JSON object with the format below.
+
+```json
+{
+  "message":"Some Message",
+  "@timestamp":"2015-01-29T10:43:32.196-05:00",
+  "@version":"1",
+  "severity":"INFO",
+  "host":"hostname"
+}
+```
+
+Some applications may need to attach additional metadata to each message.
+The `LogStash::Event` can be manipulated directly by specifying a `customize_event` block in the `LogStashLogger` configuration.
+
+```ruby
+config = LogStashLogger.configure do |config|
+  config.customize_event do |event|
+    event["other_field"] = "some_other_value"
+  end
+end
+```
+
+This configuration would result in the following output.
+
+```json
+{
+    "message": "Some Message",
+    "@timestamp": "2015-01-29T10:43:32.196-05:00",
+    "@version": "1",
+    "severity": "INFO",
+    "host": "hostname",
+    "other_field": "some_other_value"
+}
+```
+
 ## Rails Integration
 
 Verified to work with both Rails 3 and 4.
@@ -273,7 +311,7 @@ config.logstash = [
 
 Verified to work with:
 
-* MRI Ruby 1.9.3, 2.0+, 2.1+
+* MRI Ruby 1.9.3, 2.0.x, 2.1.x, 2.2.x
 * JRuby 1.7+
 * Rubinius 2.2+
 
@@ -297,6 +335,18 @@ disadvantages of each type:
 For a more detailed discussion of UDP vs TCP, I recommend reading this article:
 [UDP vs. TCP](http://gafferongames.com/networking-for-game-programmers/udp-vs-tcp/)
 
+## Troubleshooting
+
+### 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
+such as Oj. Use the [oj_mimic_json](https://github.com/ohler55/oj_mimic_json) gem to use Oj for JSON generation.
+
+### No logs getting sent on Heroku
+Heroku recommends installing the [rails_12factor](https://github.com/heroku/rails_12factor) so that logs get sent to STDOUT.
+Unfortunately, this overrides LogStashLogger, preventing logs from being sent to their configured destination. The solution
+is to remove `rails_12factor` from your Gemfile.
+
 ## Breaking changes
 
 ### Version 0.5+
@@ -328,6 +378,7 @@ logger = LogStashLogger.new('localhost', 5228, :tcp)
 * [Arron Mabrey](https://github.com/arronmabrey)
 * [Jan Schulte](https://github.com/schultyy)
 * [Kurt Preston](https://github.com/KurtPreston)
+* [Chris Blatchley](https://github.com/chrisblatchley)
 
 ## Contributing
 

data/lib/logstash-logger.rb

@@ -6,5 +6,6 @@ require 'logstash-logger/device'
 
 require 'logstash-logger/logger'
 require 'logstash-logger/formatter'
+require 'logstash-logger/configuration'
 
 require 'logstash-logger/railtie' if defined? Rails

data/lib/logstash-logger/configuration.rb

@@ -0,0 +1,26 @@
+module LogStashLogger
+  class << self
+    def configure(&block)
+      @configuration = Configuration.new(&block) if block_given? || @configuration.nil?
+      @configuration
+    end
+
+    alias :configuration :configure
+  end
+
+  class Configuration
+    attr_accessor :customize_event_block
+
+    def initialize(*args)
+      @customize_event_block = nil
+
+      yield self if block_given?
+      self
+    end
+
+    def customize_event(&block)
+      @customize_event_block = block
+    end
+
+  end
+end

data/lib/logstash-logger/formatter.rb

@@ -36,6 +36,8 @@ module LogStashLogger
 
       event['host'] ||= HOST
 
+      LogStashLogger.configuration.customize_event_block.call(event) if LogStashLogger.configuration.customize_event_block.respond_to?(:call)
+
       current_tags.each do |tag|
         event.tag(tag)
       end

data/lib/logstash-logger/version.rb

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

data/spec/configuration_spec.rb

@@ -0,0 +1,27 @@
+require 'logstash-logger'
+
+describe LogStashLogger do
+  describe "#configure" do
+    it 'auto initializes' do
+      config = LogStashLogger.configure
+      expect(config).to be_a LogStashLogger::Configuration
+      expect(LogStashLogger.configuration).to eq(config)
+    end
+
+    describe LogStashLogger::Configuration do
+      describe "#customize_event" do
+        it 'allows each LogStash::Event to be customized' do
+          config = LogStashLogger.configure do |config|
+            config.customize_event do |event|
+              event["test1"] = "response1"
+            end
+          end
+
+          event = LogStash::Event.new({})
+          config.customize_event_block.call(event)
+          expect(event["test1"]).to eq("response1")
+        end
+      end
+    end
+  end
+end

data/spec/logger_spec.rb

@@ -54,27 +54,14 @@ describe LogStashLogger do
 
   it 'takes a string message as input and writes a logstash event' do
     message = 'test'
-
-    expect(logdev).to receive(:write).and_call_original do |event|
-      expect(event).to be_a LogStash::Event
-      expect(event.host).to eql(hostname)
-      expect(event['message']).to eql(message)
-      expect(event['severity']).to eql('INFO')
-    end
-
     logger.info(message)
 
+    expect(listener_event['severity']).to eql('INFO')
     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
-      expect(event['message']).to eql(logstash_event['message'])
-      expect(event.host).to eql(hostname)
-    end
-
     logger.info(logstash_event.to_json)
 
     expect(listener_event['message']).to eq(logstash_event['message'])
@@ -82,18 +69,11 @@ describe LogStashLogger do
   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
-      expect(event['message']).to eql(logstash_event['message'])
-      expect(event['severity']).to eql(logstash_event['severity'])
-      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['@timestamp'].iso8601).to eq(logstash_event.timestamp.iso8601)
     expect(listener_event['host']).to eq(hostname)
   end
 
@@ -104,14 +84,6 @@ describe LogStashLogger do
       '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')
-      expect(event['severity']).to eql('INFO')
-      expect(event['foo']).to eql('bar')
-      expect(event.host).to eql(hostname)
-    end
-
     logger.info(data.dup)
 
     expect(listener_event['message']).to eq(data["message"])
@@ -124,16 +96,23 @@ describe LogStashLogger do
   it 'takes any object as input and writes a logstash event' do
     message = Time.now
 
-    expect(logdev).to receive(:write).and_call_original do |event|
-      expect(event).to be_a LogStash::Event
-      expect(event.host).to eql(hostname)
-      expect(event['message']).to eql(message.inspect)
-      expect(event['severity']).to eql('INFO')
-    end
-
     logger.info(message)
 
     expect(listener_event['message']).to eq(message.inspect)
+    expect(listener_event['host']).to eq(hostname)
+    expect(listener_event['severity']).to eq('INFO')
+  end
+
+  it 'allows event to be customized via configuration' do
+    LogStashLogger.configure do |config|
+      config.customize_event do |event|
+        event["test1"] = "response1"
+      end
+    end
+
+    logger.info("test")
+
+    expect(listener_event["test1"]).to eq("response1")
   end
 
 end

data/spec/spec_helper.rb

@@ -7,6 +7,12 @@ RSpec.configure do |config|
     puts "Testing with #{CONNECTION_TYPE.to_s.upcase} socket type"
   end
 
+  config.before(:each) do
+    LogStashLogger.configure do
+
+    end
+  end
+
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-logger
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - David Butler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-07 00:00:00.000000000 Z
+date: 2015-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -157,6 +157,7 @@ files:
 - gemfiles/rails_4.1.gemfile
 - gemfiles/rails_4.2.gemfile
 - lib/logstash-logger.rb
+- lib/logstash-logger/configuration.rb
 - lib/logstash-logger/device.rb
 - lib/logstash-logger/device/base.rb
 - lib/logstash-logger/device/connectable.rb
@@ -184,6 +185,7 @@ files:
 - samples/tcp.conf
 - samples/udp.conf
 - samples/unix.conf
+- spec/configuration_spec.rb
 - spec/device/file_spec.rb
 - spec/device/io_spec.rb
 - spec/device/multi_delegator_spec.rb
@@ -219,11 +221,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: LogStash Logger for ruby
 test_files:
+- spec/configuration_spec.rb
 - spec/device/file_spec.rb
 - spec/device/io_spec.rb
 - spec/device/multi_delegator_spec.rb