yell-adapters-gelf 0.4.1 → 0.6.0

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+
+script: "rake"
+
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  # - rbx-19mode
+  - ree
+
+notifications:
+  email:
+    - me@rudionrails.com
+

data/README.md

@@ -7,6 +7,11 @@ directly into the Yell wiki at https://github.com/rudionrails/yell/wiki.
 Just in case you wonder: GELF means Graylog Extended Log Format. Read all 
 it at http://www.graylog2.org/about/gelf.
 
+[![Build Status](https://secure.travis-ci.org/rudionrails/yell-adapters-gelf.png?branch=master)](http://travis-ci.org/rudionrails/yell-adapters-gelf)
+
+The Graylog adapter for Yell works and is tested with ruby 1.8.7, 1.9.x, jruby 1.8 and 1.9 mode, rubinius 1.8 and 1.9 as well as ree.
+
+
 ## Installation
 
 System wide:
@@ -36,8 +41,8 @@ logger.info "Hello World"
 Or alternatively with the block syntax:
 
 ```ruby
-logger = Yell.new do
-  adapter :gelf
+logger = Yell.new do |l|
+  l.adapter :gelf
 end
 
 logger.info 'Hello World!'
@@ -50,13 +55,12 @@ options to the adapter:
 logger = Yell.new :gelf, :host => 'hostname', :port => 1234
 
 # Or with the block syntax
-logger = Yell.new do
-  adapter :gelf, :host => 'hostname', :port => 1234
+logger = Yell.new do |l|
+  l.adapter :gelf, :host => 'hostname', :port => 1234
 end
 
 logger.info 'Hello World!'
 ```
 
-
-Copyright © 2011-2012 Rudolf Schmidt, released under the MIT license
+Copyright © 2012 Rudolf Schmidt, released under the MIT license
 

data/Rakefile

@@ -1 +1,22 @@
-require "bundler/gem_tasks"
+$:.unshift( 'lib' )
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+# === RSpec
+begin
+  require 'rspec/core/rake_task'
+
+  desc "Run specs"
+  RSpec::Core::RakeTask.new do |t|
+    t.rspec_opts = %w(--color --format progress --order random)
+    t.ruby_opts = %w(-w)
+  end
+rescue LoadError
+  task :spec do
+    abort "`gem install rspec` in order to run tests"
+  end
+end
+
+task :default => :spec
+

data/lib/yell/adapters/gelf/version.rb

@@ -4,7 +4,7 @@ module Yell #:nodoc:
   module Adapters #:nodoc:
 
     class Gelf
-      VERSION = "0.4.1"
+      VERSION = "0.6.0"
 
     end
 

data/lib/yell/adapters/gelf.rb

@@ -1,20 +1,15 @@
 # encoding: utf-8
 
-require 'socket'
-require 'json'
-require 'zlib'
-require 'digest/md5'
-
 module Yell #:nodoc:
   module Adapters #:nodoc:
 
     # GELF for Graylog2.
     class Gelf < Yell::Adapters::Base
 
-      # Syslog severities
+      # Graylog severities
       Severities = [7, 6, 4, 3, 2, 1]
 
-      # Combines syslog severities with internal representation:
+      # Combines Graylog severities with internal representation:
       #   'DEBUG'   => 7
       #   'INFO'    => 6
       #   'WARN'    => 4
@@ -48,71 +43,75 @@ module Yell #:nodoc:
           # Cycle host and port
           host = @hosts.shift
           @hosts << host
-
           host
         end
       end
 
-      def initialize( options = {}, &block )
+
+      setup do |options|
         @uid = 0
 
-        # initialize the UDP Sender
-        @host = options.fetch(:host, 'localhost')
-        @port = options.fetch(:port, 12201)
+        self.facility = options.fetch(:facility, 'yell')
 
-        max_chunk_size options.fetch(:max_chunk_size, :wan)
+        # initialize the UDP Sender
+        self.host = options.fetch(:host, 'localhost')
+        self.port = options.fetch(:port, 12201)
 
-        super( options, &block )
+        self.max_chunk_size = options.fetch(:max_chunk_size, :wan)
       end
 
+      write do |event|
+        # https://github.com/Graylog2/graylog2-docs/wiki/GELF
+        _datagrams = datagrams(
+          'version'       => '1.0',
 
-      # The sender (UDP Socket)
-      def sender
-        @sender ||= Yell::Adapters::Gelf::Sender.new( [@host, @port] )
+          'facility'      => facility,
+          'level'         => SeverityMap[event.level],
+          'short_message' => event.message,
+          'timestamp'     => event.time.to_f,
+          'host'          => event.hostname,
+
+          'file'          => event.file,
+          'line'          => event.line,
+          '_method'       => event.method,
+          '_pid'          => event.pid
+        )
+
+        sender.send( *_datagrams )
       end
 
-      # Close the UDP sender
-      def close
+      close do
         @sender.close if @sender.respond_to? :close
-
         @sender = nil
       end
 
-      def max_chunk_size( val )
+
+      # Accessor to the Graylog host
+      attr_accessor :host
+
+      # Accessor to the Graylog port
+      attr_accessor :port
+
+      # Accessor to the Graylog facility
+      attr_accessor :facility
+
+      # Accessor to the Graylog chunk size
+      attr_reader :max_chunk_size
+
+      def max_chunk_size=( val )
         @max_chunk_size = case val
           when :wan then 1420
           when :lan then 8154
-          else val
+          else val.to_i
         end
       end
 
 
       private
 
-      def write!( event )
-        # See https://github.com/Graylog2/graylog2-docs/wiki/GELF 
-        # for formatting options.
-        _datagrams = datagrams(
-          'version'       => '1.0', 
-          'facility'      => 'yell', 
-
-          'level'         => SeverityMap[event.level], 
-          'short_message' => event.message, 
-          'timestamp'     => event.time.to_f, 
-          'host'          => Socket.gethostname, 
-
-          'file'          => event.file, 
-          'line'          => event.line, 
-          '_method'       => event.method,
-          '_pid'          => Process.pid
-        )
-
-        sender.send( *_datagrams )
-      rescue Exception => e
-        close
-
-        # re-raise the exception
-        raise( e, caller )
+      # The sender (UDP Socket)
+      def sender
+        @sender ||= Yell::Adapters::Gelf::Sender.new( [@host, @port] )
       end
 
       def datagrams( data )

data/lib/yell-adapters-gelf.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-# Copyright (c) 2011-2012 Rudolf Schmidt
+# Copyright (c) 2012 Rudolf Schmidt
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -21,15 +21,15 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-require 'yell'
-
-begin
-  require 'yell/adapters/gelf'
-rescue LoadError
-  $: << File.dirname(__FILE__)
-  require 'yell/adapters/gelf'
-end
-
 module Yell #:nodoc:
 end
 
+require 'socket'
+require 'zlib'
+require 'digest/md5'
+
+require 'json'
+require 'yell'
+
+require File.dirname(__FILE__) + '/yell/adapters/gelf'
+

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'yell-adapters-gelf'
+
+require 'rspec'
+require 'rr'
+
+RSpec.configure do |config|
+  config.mock_framework = :rr
+
+end
+

data/spec/yell/adapters/gelf_spec.rb

@@ -0,0 +1,169 @@
+require 'spec_helper'
+
+describe Yell::Adapters::Gelf do
+
+  module SenderStub
+    extend self
+
+    def datagrams; @datagrams; end
+
+    def send( *datagrams )
+      @datagrams = datagrams
+    end
+  end
+
+  before do
+    stub( Yell::Adapters::Gelf::Sender ).new( anything ) { SenderStub }
+  end
+
+  context "a new Yell::Adapters::Gelf instance" do
+    subject { Yell::Adapters::Gelf.new }
+
+    it { subject.host.should == 'localhost' }
+    it { subject.port.should == 12201 }
+    it { subject.facility.should == 'yell' }
+    it { subject.max_chunk_size.should == 1420 }
+  end
+
+  context :host do
+    let( :adapter ) { Yell::Adapters::Gelf.new }
+    subject { adapter.host }
+
+    before { adapter.host = 'hostname' }
+
+    it { should == 'hostname' }
+  end
+
+  context :port do
+    let( :adapter ) { Yell::Adapters::Gelf.new }
+    subject { adapter.port }
+
+    before { adapter.port = 1234 }
+
+    it { should == 1234 }
+  end
+
+  context :max_chunk_size do
+    let( :adapter ) { Yell::Adapters::Gelf.new }
+    subject { adapter.max_chunk_size }
+
+    context :wan do
+      before { adapter.max_chunk_size = :wan }
+      it { should == 1420 }
+    end
+
+    context :lan do
+      before { adapter.max_chunk_size = :lan }
+      it { should == 8154 }
+    end
+
+    context :other do
+      before { adapter.max_chunk_size = "1234" }
+      it { should == 1234 }
+    end
+  end
+
+  context :write do
+    let( :event ) { Yell::Event.new( 'INFO', 'Hello World' ) }
+    let( :adapter ) { Yell::Adapters::Gelf.new }
+
+    context "single" do
+      let( :datagrams ) { SenderStub.datagrams }
+
+      before do
+        deflated = Zlib::Deflate.deflate( "*" * 1441000 ) # compresses to 1420 bytes
+        mock( Zlib::Deflate ).deflate( anything ) { deflated }
+
+        adapter.write event
+      end
+
+      it "should be one part" do
+        datagrams.size.should == 1
+      end
+
+      it "should be a string" do
+        datagrams[0].should be_kind_of String
+      end
+
+      it "should be zipped" do
+        datagrams[0][0..1].should == "\x78\x9c" # zlib header
+      end
+    end
+
+    context "chunked" do
+      let( :datagrams ) { SenderStub.datagrams }
+
+      before do
+        deflated = Zlib::Deflate.deflate( "*" * 1442000 ) # compresses to 1421 bytes
+        mock( Zlib::Deflate ).deflate( anything ) { deflated }
+
+        adapter.write event
+      end
+
+      it "should be multiple parts" do
+        datagrams.size.should == 2
+      end
+
+      it "should be multiple strings" do
+        datagrams.each { |datagram| datagram.should be_kind_of String }
+      end
+
+      it "should be multiple GELF chunks" do
+        # datagram assertions mostly taken from original gelf-rb gem
+        datagrams.each_with_index do |datagram, index|
+          datagram[0..1].should == "\x1e\x0f" # GELF header
+
+          # datagram[2..9] is unique the message id
+          datagram[10].ord.should == index # chunk number
+          datagram[11].ord.should == datagrams.size # total chunk number
+        end
+      end
+    end
+
+    context :datagrams do
+      after { adapter.write event }
+
+      it "should receive :version" do
+        mock.proxy( adapter ).datagrams( hash_including('version' => '1.0') )
+      end
+
+      it "should receive :facility" do
+        mock.proxy( adapter ).datagrams( hash_including('facility' => adapter.facility) )
+      end
+
+      it "should receive :level" do
+        mock.proxy( adapter ).datagrams( hash_including('level' => Yell::Adapters::Gelf::SeverityMap[event.level]) )
+      end
+
+      it "should receive :short_message" do
+        mock.proxy( adapter ).datagrams( hash_including('short_message' => event.message) )
+      end
+
+      it "should receive :timestamp" do
+        mock.proxy( adapter ).datagrams( hash_including('timestamp' => event.time.to_f) )
+      end
+
+      it "should receive :host" do
+        mock.proxy( adapter ).datagrams( hash_including('host' => event.hostname) )
+      end
+
+      it "should receive :file" do
+        mock.proxy( adapter ).datagrams( hash_including('file' => event.file) )
+      end
+
+      it "should receive :line" do
+        mock.proxy( adapter ).datagrams( hash_including('line' => event.line) )
+      end
+
+      it "should receive :method" do
+        mock.proxy( adapter ).datagrams( hash_including('_method' => event.method) )
+      end
+
+      it "should receive :pid" do
+        mock.proxy( adapter ).datagrams( hash_including('_pid' => event.pid) )
+      end
+    end
+  end
+
+end
+

data/yell-adapters-gelf.gemspec

@@ -20,7 +20,9 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  s.add_runtime_dependency "yell", "~> 0.4"
+  s.add_runtime_dependency "yell", "~> 0.6"
+  s.add_runtime_dependency "json"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rr"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yell-adapters-gelf
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,19 +9,52 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-30 00:00:00.000000000 Z
+date: 2012-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yell
-  requirement: &70330052059680 !ruby/object:Gem::Requirement
+  requirement: &70278652183180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.6'
   type: :runtime
   prerelease: false
-  version_requirements: *70330052059680
+  version_requirements: *70278652183180
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70278652182780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70278652182780
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70278652182320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70278652182320
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &70278652181900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70278652181900
 description: Graylog2 adapter for Yell
 email: 
 executables: []
@@ -29,6 +62,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -36,6 +70,8 @@ files:
 - lib/yell-adapters-gelf.rb
 - lib/yell/adapters/gelf.rb
 - lib/yell/adapters/gelf/version.rb
+- spec/spec_helper.rb
+- spec/yell/adapters/gelf_spec.rb
 - yell-adapters-gelf.gemspec
 homepage: http://rubygems.org/gems/yell
 licenses: []
@@ -61,5 +97,7 @@ rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Yell - Your Extensible Logging Library
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/yell/adapters/gelf_spec.rb
 has_rdoc: