logstash-logger 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4495e92019c98077d726a256f7713ffb43b1a6f2
-  data.tar.gz: 2768785f7ae86851d7f09d2270a5fb8565ec4080
+  metadata.gz: 2cb98c8cb41ee7a5cd49492cb17c1c3c06df5f37
+  data.tar.gz: 2c09577089a1a3f4dcb71ae16a426080d456d2b0
 SHA512:
-  metadata.gz: b1931b2ca5c0bbd7bf786f04f7226d846d499bb5ec0b316412d6fc69e050bb7858cfdf201f70c09c287f225be6fdd96962bf7493cf64fc7afe5925b944eddd11
-  data.tar.gz: a521fe134818cc560c90a906291622352370c84ec5e9de4a9e223544426efd091b204a0724e16bf584bb554950bbb00ffe26c7b6056b839fc06d9cf51e758e92
+  metadata.gz: fb7d7c1d9f6305721b8aea10d33de1c2d37c19b0de495b06d358fc783082ec3b1ab16d0e7b61be6c6ab621c4452b3509dd6798ca08789c38685d93260e8b8861
+  data.tar.gz: 0ec0923505339d1c9d561aa2e52a54dd7a9cb9cc045ffdaf9e8117db15a58b7eb7df1b5c13b1a7b96426743a0a789326940ea8d2891831f94effb8777c1870d6

data/.gitignore

@@ -15,4 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-
+.idea/

data/.travis.yml

@@ -2,6 +2,9 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - 2.1.2
   - jruby-19mode # JRuby in 1.9 mode
 #  - rbx-18mode
 #  - rbx-19mode

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+0.4.1
+-----
+- Fixed support for `LogStash::Event` v1 format when logging a hash. Extra data
+now goes to the top level instead of into the `@fields` key.
+
+0.4.0
+-----
+- Support for new `LogStash::Event` v1 format. v0 is supported in 0.3+.
+
+0.3.0
+-----
+- Added support for logging to a UDP listener.
+
+0.2.1
+-----
+- Fixed to use Logstash's default time format for timestamps.
+
+0.2.0
+-----
+- Better use of Ruby Logger's built-in LogDevice.
+
+0.1.0
+-----
+- Initial release. Support for logging to a TCP listener.

data/README.md

@@ -1,4 +1,5 @@
-# LogStashLogger [![Build Status](https://travis-ci.org/dwbutler/logstash-logger.png?branch=master)](https://travis-ci.org/dwbutler/logstash-logger)
+# LogStashLogger
+[![Build Status](https://travis-ci.org/dwbutler/logstash-logger.png?branch=master)](https://travis-ci.org/dwbutler/logstash-logger) [![Code Climate](https://codeclimate.com/github/dwbutler/logstash-logger.png)](https://codeclimate.com/github/dwbutler/logstash-logger)
 
 This gem implements a subclass of Ruby's Logger class that logs directly to [logstash](http://logstash.net).
 It writes to a logstash listener over a UDP (default) or TCP connection, in logstash JSON format. This is an improvement over
@@ -28,20 +29,48 @@ Or install it yourself as:
 ## Basic Usage
 
 First set up a logstash agent to receive input over a UDP or TCP port.
-Then in ruby, create a LogStashLogger that writes to that port.
+Then in ruby, create a `LogStashLogger` that writes to that port.
+
+The logger accepts a string message, a JSON string, a hash, or a `LogStash::Event`.
 
 ```ruby
 require 'logstash-logger'
 
 # Defaults to UDP
 logger = LogStashLogger.new('localhost', 5228)
-logger.info 'test'
-# Writes the following to UDP port 5228:
-# {"@source":"server-host-name","@tags":[],"@fields":{"severity":"INFO"},"@message":"test","@timestamp":"2013-04-08T18:56:23.767273+00:00"}
 
 # Specify UDP or TCP explicitly
 udp_logger = LogStashLogger.new('localhost', 5228, :udp)
 tcp_logger = LogStashLogger.new('localhost', 5229, :tcp)
+
+# The following messages are written to UDP port 5228:
+
+logger.info 'test'
+# {"message":"test","@timestamp":"2014-05-22T09:37:19.204-07:00","@version":"1","severity":"INFO","source":"[server-hostname]"}
+
+logger.error '{"message": "error"}'
+# {"message":"error","@timestamp":"2014-05-22T10:10:55.877-07:00","@version":"1","severity":"ERROR","source":"[server-hostname]"}
+
+logger.debug message: 'test', foo: 'bar'
+# {"message":"test","foo":"bar","@timestamp":"2014-05-22T09:43:24.004-07:00","@version":"1","severity":"DEBUG","source":"[server-hostname]"}
+
+logger.warn LogStash::Event.new(message: 'test', foo: 'bar')
+# {"message":"test","foo":"bar","@timestamp":"2014-05-22T16:44:37.364Z","@version":"1","severity":"WARN","source":"[server-hostname]"}
+```
+
+## Logstash configuration
+
+In order for Logstash to correctly receive and parse the event, you will need to
+configure and run a UDP listener that uses the `json_lines` codec:
+
+```ruby
+input {
+  udp {
+    host => "0.0.0.0"
+    port => 5228
+    codec => json_lines
+  }
+}
 ```
 
 ## Rails integration
@@ -49,7 +78,9 @@ tcp_logger = LogStashLogger.new('localhost', 5229, :tcp)
 Add the following to your config/environments/production.rb:
 
 ```ruby
-config.logger = ActiveSupport::TaggedLogging.new(LogStashLogger.new('localhost', 5228))
+logger = LogStashLogger.new('localhost', 5228)
+logger.level = Logger::INFO # default is Logger::DEBUG
+config.logger = ActiveSupport::TaggedLogging.new(logger)
 ```
 
 To get Rails to nicely output its logs in structured logstash format, try one of the following gems:

data/lib/logstash-logger/logger.rb

@@ -1,8 +1,5 @@
 class LogStashLogger < ::Logger
   
-  attr_reader :client
-  
-  LOGSTASH_EVENT_FIELDS = %w(@timestamp @tags @type @source @fields message).freeze
   HOST = ::Socket.gethostname
   
   def initialize(host, port, socket_type=:udp)
@@ -30,7 +27,7 @@ class LogStashLogger < ::Logger
   
   def format_message(severity, time, progname, message)
     data = message
-    if data.is_a?(String) && data[0] == '{'
+    if data.is_a?(String) && data.start_with?('{')
       data = (JSON.parse(message) rescue nil) || message
     end
     
@@ -38,17 +35,7 @@ class LogStashLogger < ::Logger
     when LogStash::Event
       data.clone
     when Hash
-      event_data = {
-        "@tags" => [],
-        "@fields" => {},
-        "@timestamp" => time
-      }
-      LOGSTASH_EVENT_FIELDS.each do |field_name|
-        if field_data = data.delete(field_name)
-          event_data[field_name] = field_data
-        end
-      end
-      event_data["@fields"].merge!(data)
+      event_data = data.merge("@timestamp" => time)
       LogStash::Event.new(event_data)
     when String
       LogStash::Event.new("message" => data, "@timestamp" => time)
@@ -56,10 +43,12 @@ class LogStashLogger < ::Logger
     
     event['severity'] ||= severity
     #event.type = progname
+
+    event['source'] ||= HOST
     if event['source'] == 'unknown'
       event['source'] = HOST
     end
     
     event
   end
-end
+end

data/lib/logstash-logger/version.rb

@@ -1,5 +1,5 @@
 require 'logger'
 
 class LogStashLogger < ::Logger
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/logstash-logger.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Ruby logger that writes directly to LogStash}
   gem.summary       = %q{LogStash Logger for ruby}
   gem.homepage      = "http://github.com/dwbutler/logstash-logger"
+  gem.license       = "MIT"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/logger_spec.rb

@@ -62,69 +62,77 @@ describe LogStashLogger do
   #let(:socket) { @socket }
   
   it 'uses a LogStashLogger::Socket as the log device' do
-    logdev.should be_a Logger::LogDevice
-    logdev.instance_variable_get(:@dev).should be_a LogStashLogger::Socket
+    expect(logdev).to be_a Logger::LogDevice
+    expect(logdev.instance_variable_get(:@dev)).to be_a LogStashLogger::Socket
   end
 
   it 'takes a string message as input and writes a logstash event' do
     message = 'test'
 
-    logdev.should_receive(:write).and_call_original do |event|
-      event.should be_a LogStash::Event
-      event.source.should eql(hostname)
-      event['message'].should eql(message)
-      event['severity'].should eql('INFO')
+    expect(logdev).to receive(:write).and_call_original do |event|
+      expect(event).to be_a LogStash::Event
+      expect(event.source).to eql(hostname)
+      expect(event['message']).to eql(message)
+      expect(event['severity']).to eql('INFO')
     end
 
     logger.info(message)
     
-    listener_event['message'].should == message
+    expect(listener_event['message']).to eq(message)
+    expect(listener_event['source']).to eq(hostname)
   end
   
   it 'takes a logstash-formatted json string as input and writes out a logstash event' do
-    logdev.should_receive(:write).and_call_original do |event|
-      event.should be_a LogStash::Event
-      event['message'].should eql(logstash_event['message'])
-      event.source.should eql(hostname)
+    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.source).to eql(hostname)
     end
 
     logger.info(logstash_event.to_json)
     
-    listener_event['message'].should == logstash_event['message']
+    expect(listener_event['message']).to eq(logstash_event['message'])
+    expect(listener_event['source']).to eq(hostname)
   end
   
   it 'takes a LogStash::Event as input and writes it out intact' do
-    logdev.should_receive(:write).and_call_original do |event|
-      event.should be_a LogStash::Event
-      event['message'].should eql(logstash_event['message'])
-      event['severity'].should eql(logstash_event['severity'])
-      event.timestamp.should eql(logstash_event.timestamp)
-      event.source.should eql(hostname)
+    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.source).to eql(hostname)
     end
     
     logger.warn(logstash_event)
     
-    listener_event['message'].should == logstash_event['message']
-    listener_event['severity'].should == logstash_event['severity']
+    expect(listener_event['message']).to eq(logstash_event['message'])
+    expect(listener_event['severity']).to eq(logstash_event['severity'])
+    expect(listener_event['source']).to eq(hostname)
   end
   
   it 'takes a data hash as input and writes out a logstash event' do
     data = {
-      "message" => 'test',
-      'severity' => 'INFO'
+      'message' => 'test',
+      'severity' => 'INFO',
+      'foo' => 'bar'
     }
     
-    logdev.should_receive(:write).and_call_original do |event|
-      event.should be_a LogStash::Event
-      event['message'].should eql('test')
-      event['severity'].should eql('INFO')
-      event.source.should eql(hostname)
+    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.source).to eql(hostname)
     end
 
     logger.info(data.dup)
     
-    listener_event['message'].should == data["message"]
-    listener_event['severity'].should == data['severity']
+    expect(listener_event['message']).to eq(data["message"])
+    expect(listener_event['severity']).to eq(data['severity'])
+    expect(listener_event['foo']).to eq(data['foo'])
+    expect(listener_event['source']).to eq(hostname)
+    expect(listener_event['@timestamp']).to_not be_nil
   end
   
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: logstash-logger
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - David Butler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-09 00:00:00.000000000 Z
+date: 2014-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   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: rake
   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: wwtd
   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: Ruby logger that writes directly to LogStash
@@ -73,8 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -87,7 +88,8 @@ files:
 - spec/logger_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/dwbutler/logstash-logger
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -95,17 +97,17 @@ 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.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: LogStash Logger for ruby