logstash-logger 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+localhost

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+#  - ree
+#  - 1.8.7
+  - 1.9.3
+#  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+#  - rbx-18mode
+#  - rbx-19mode

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in logstash-logger.gemspec
+gemspec
+
+gem 'json', :platform => :ruby_18
+
+group :development do
+  gem 'ruby-debug', :platform => :ruby_18
+  gem 'debugger', :platform => :ruby_19
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Butler
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# LogStashLogger [![Build Status](https://travis-ci.org/dwbutler/logstash-logger.png?branch=master)](https://travis-ci.org/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 TCP connection, in logstash JSON format. This is an improvement over
+writing to a file or syslog since logstash can receive the structured data directly.
+
+## Features
+
+* Writes directly to logstash over a TCP connection.
+* Always writes in logstash JSON format.
+* Logger can take a string message, a hash, a LogStash::Event, or a logstash-formatted json string as input.
+* Events are automatically populated with message, timestamp, host, and severity.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'logstash-logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logstash-logger
+
+## Usage
+
+First set up a logstash agent to receive input over a TCP port.
+
+```ruby
+logger = LogStashLogger.new('localhost', 5228)
+logger.info 'test'
+# Logs {"@source":"server-host-name","@tags":[],"@fields":{"severity":"INFO"},"@message":"test","@timestamp":"2012-12-15T00:48:29+00:00"}
+```
+
+## Rails integration
+
+Add the following to your config/environments/production.rb:
+
+```ruby
+config.logger = ActiveSupport::TaggedLogging.new(LogStashLogger.new('localhost', 5228))
+```
+
+To get Rails to nicely output its logs in structured logstash format, try one of the following gems:
+
+* [lograge](https://github.com/roidrage/lograge)
+* [yarder](https://github.com/rurounijones/yarder)
+
+Currently these gems output a JSON string, which LogStashLogger then parses.
+Future versions of these gems could potentially have deeper integration with LogStashLogger.
+
+## Ruby compatibility
+
+Verified to work with:
+
+* Ruby 1.9.3
+* JRuby 1.7.1 (1.9 mode)
+
+Ruby 1.8.7 is not supported because LogStash::Event is not compatible with Ruby 1.8.7. This might change in the future.
+
+Rubinius might work, but I haven't been able to test it.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+  t.verbose = false
+end
+
+task :default => :spec

data/lib/logstash-logger.rb

@@ -0,0 +1,10 @@
+require 'logstash-logger/version'
+
+require 'thread'
+require 'socket'
+require 'logstash-event'
+
+require 'logstash-logger/tcp_client'
+require 'logstash-logger/logger'
+require 'logstash-logger/version'
+

data/lib/logstash-logger/logger.rb

@@ -0,0 +1,66 @@
+class LogStashLogger < ::Logger
+  
+  attr_reader :client
+  
+  LOGSTASH_EVENT_FIELDS = %w(@timestamp @tags @type @source @fields @message).freeze
+  HOST = Socket.gethostname
+  
+  def initialize(host, port)
+    @client = ::LogStashLogger::TCPClient.new(host, port)
+    super
+  end
+  
+  def add(severity, message = nil, progname = nil, &block)
+    severity ||= UNKNOWN
+    if severity < @level
+      return true
+    end
+    progname ||= @progname
+    if message.nil?
+      if block_given?
+        message = yield
+      else
+        message = progname
+        progname = @progname
+      end
+    end
+    @client.write(
+      format_message(format_severity(severity), Time.now, progname, message))
+    true
+  end
+  
+  def format_message(severity, time, progname, message)
+    data = message
+    if data.is_a?(String) && data[0] == '{'
+      data = (JSON.parse(message) rescue nil) || message
+    end
+    
+    event = case data
+    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)
+      LogStash::Event.new(event_data)
+    when String
+      LogStash::Event.new("@message" => data, "@timestamp" => time)
+    end
+    
+    event['severity'] ||= severity
+    #event.type = progname
+    if event.source == 'unknown'
+      event["@source"] = HOST
+    end
+    
+    event
+  end
+end

data/lib/logstash-logger/tcp_client.rb

@@ -0,0 +1,23 @@
+class LogStashLogger::TCPClient
+  def initialize(host, port)
+    @host = host
+    @port = port
+  end
+  
+  def write(event)
+    begin
+      connect unless @socket
+      
+      @socket.write("#{event.to_hash.to_json}\n")
+    rescue => e
+      warn "LogStashLogger::TCPClient - #{e.class} - #{e.message}"
+      @socket && @socket.close rescue nil
+      @socket = nil
+    end
+  end
+  
+  private
+  def connect
+    @socket = TCPSocket.new(@host, @port)
+  end
+end

data/lib/logstash-logger/version.rb

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

data/logstash-logger.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logstash-logger/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "logstash-logger"
+  gem.version       = LogStashLogger::VERSION
+  gem.authors       = ["David Butler"]
+  gem.email         = ["dwbutler@ucla.edu"]
+  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.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_runtime_dependency 'logstash-event'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+end

data/spec/logger_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe LogStashLogger do
+  subject { LogStashLogger.new('localhost', port)}
+  let(:port) { 5228 }
+  let(:server) { TCPServer.new(port) }
+  let(:host) { Socket.gethostname }
+  
+  before(:all) do
+    server # Initialize TCP server
+  end
+  
+  let(:logstash_event) do
+    event = LogStash::Event.new
+    event.message = 'test'
+    event['severity'] = 'INFO'
+    event
+  end
+
+  it 'should take a string message and write a logstash event' do
+    message = 'test'
+  
+    subject.client.should_receive(:write) do |event|
+      event.should be_a LogStash::Event
+      event.source.should eql(host)
+      event.message.should eql(message)
+      event['severity'].should eql('INFO')
+    end
+
+    subject.info(message)
+  end
+  
+  it 'should take a logstash-formatted json string and write out a logstash event' do
+    subject.client.should_receive(:write) do |event|
+      event.should be_a LogStash::Event
+      event.message.should eql(logstash_event.message)
+      event.source.should eql(host)
+    end
+
+    subject.info(logstash_event.to_json)
+  end
+  
+  it 'should take a LogStash::Event and write it out' do
+    subject.client.should_receive(:write) 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(host)
+    end
+    
+    subject.warn(logstash_event)
+  end
+  
+  it 'should take a hash and write out a logstash event' do
+    data = {
+      "@message" => 'test',
+      'severity' => 'INFO'
+    }
+    
+    subject.client.should_receive(:write) do |event|
+      event.should be_a LogStash::Event
+      event.message.should eql('test')
+      event['severity'].should eql('INFO')
+      event.source.should eql(host)
+    end
+
+    subject.info(data)
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'logstash-logger'
+
+RSpec.configure do |config|
+  config.order = "random"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification 
+name: logstash-logger
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- David Butler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-12-15 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: logstash-event
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Ruby logger that writes directly to LogStash
+email: 
+- dwbutler@ucla.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/logstash-logger.rb
+- lib/logstash-logger/logger.rb
+- lib/logstash-logger/tcp_client.rb
+- lib/logstash-logger/version.rb
+- logstash-logger.gemspec
+- spec/logger_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/dwbutler/logstash-logger
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: LogStash Logger for ruby
+test_files: 
+- spec/logger_spec.rb
+- spec/spec_helper.rb