yell-adapters-gelf 0.4.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in yell-adapters-gelf.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+Copyright (c) 2011-2012 Rudolf Schmidt
+
+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,62 @@
+Yell Gelf - Graylog2 Adapter for Your Extensible Logging Library
+
+If you are not yet familiar with **Yell - Your Extensible Logging Library** 
+check out the githup project under https://github.com/rudionrails/yell or jump 
+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.
+
+## Installation
+
+System wide:
+
+```console
+gem install yell-gelf
+```
+
+Or in your Gemfile:
+
+```ruby
+gem "yell-gelf"
+```
+
+## Usage
+
+After you set-up Graylog2 accordingly, you may use the Gelf adapter just like 
+any other.
+
+```ruby
+logger = Yell.new :gelf
+
+logger.info "Hello World"
+# Check your Graylog2 web server for the received message.
+```
+
+Or alternatively with the block syntax:
+
+```ruby
+logger = Yell.new do
+  adapter :gelf
+end
+
+logger.info 'Hello World!'
+```
+
+If you are running Graylog2 on a different server or port, you can pass those 
+options to the adapter:
+
+```ruby
+logger = Yell.new :gelf, :host => 'hostname', :port => 1234
+
+# Or with the block syntax
+logger = Yell.new do
+  adapter :gelf, :host => 'hostname', :port => 1234
+end
+
+logger.info 'Hello World!'
+```
+
+
+Copyright © 2011-2012 Rudolf Schmidt, released under the MIT license
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/yell-adapters-gelf.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+# Copyright (c) 2011-2012 Rudolf Schmidt
+#
+# 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.
+
+require 'yell'
+
+begin
+  require 'yell/adapters/gelf'
+rescue LoadError
+  $: << File.dirname(__FILE__)
+  require 'yell/adapters/gelf'
+end
+
+module Yell #:nodoc:
+end
+

data/lib/yell/adapters/gelf.rb

@@ -0,0 +1,148 @@
+# 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
+      Severities = [7, 6, 4, 3, 2, 1]
+
+      # Combines syslog severities with internal representation:
+      #   'DEBUG'   => 7
+      #   'INFO'    => 6
+      #   'WARN'    => 4
+      #   'ERROR'   => 3
+      #   'FATAL'   => 2
+      #   'UNKNOWN' => 1
+      SeverityMap = Hash[ *(Yell::Severities.zip(Severities).flatten) ]
+
+      class Sender
+        def initialize( *hosts )
+          @hosts  = hosts
+          @socket = UDPSocket.new
+        end
+
+        def send( *datagrams )
+          datagrams.each do |d|
+            @socket.send( d, 0, *host_and_port )
+          end
+        end
+
+        def close
+          @socket.close unless @socket.closed?
+        end
+
+        private
+
+        def host_and_port
+          # Don't cycle the elements when only one present
+          return @hosts.first if @hosts.size == 1
+
+          # Cycle host and port
+          host = @hosts.shift
+          @hosts << host
+
+          host
+        end
+      end
+
+      def initialize( options = {}, &block )
+        @uid = 0
+
+        # initialize the UDP Sender
+        @host = options.fetch(:host, 'localhost')
+        @port = options.fetch(:port, 12201)
+
+        max_chunk_size options.fetch(:max_chunk_size, :wan)
+
+        super( options, &block )
+      end
+
+
+      # The sender (UDP Socket)
+      def sender
+        @sender ||= Yell::Adapters::Gelf::Sender.new( [@host, @port] )
+      end
+
+      # Close the UDP sender
+      def close
+        @sender.close if @sender.respond_to? :close
+
+        @sender = nil
+      end
+
+      def max_chunk_size( val )
+        @max_chunk_size = case val
+          when :wan then 1420
+          when :lan then 8154
+          else val
+        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 )
+      end
+
+      def datagrams( data )
+        bytes = Zlib::Deflate.deflate( data.to_json ).bytes
+        _datagrams = []
+
+        if bytes.count > @max_chunk_size
+          _id = Digest::MD5.digest( "#{Time.now.to_f}-#{object_id}-#{uid}" )[0, 8]
+
+          num, count = 0, (bytes.count.to_f / @max_chunk_size).ceil
+          bytes.each_slice( @max_chunk_size ) do |slice|
+            _datagrams << "\x1e\x0f" + _id + [num, count, *slice].pack('C*')
+            num += 1
+          end
+        else
+          _datagrams << bytes.to_a.pack('C*')
+        end
+
+        _datagrams
+      end
+
+      def uid
+        @uid += 1
+      end
+
+    end
+
+    register( :gelf, Yell::Adapters::Gelf )
+    register( :graylog2, Yell::Adapters::Gelf )
+
+  end
+end
+

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

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module Yell #:nodoc:
+  module Adapters #:nodoc:
+
+    class Gelf
+      VERSION = "0.4.0"
+
+    end
+
+  end
+end
+

data/yell-adapters-gelf.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require "yell/adapters/gelf/version"
+
+Gem::Specification.new do |s|
+  s.name        = "yell-adapters-gelf"
+  s.version     = Yell::Adapters::Gelf::VERSION
+  s.authors     = ["Rudolf Schmidt"]
+
+
+  s.homepage    = "http://rubygems.org/gems/yell"
+  s.summary     = %q{Yell - Your Extensible Logging Library }
+  s.description = %q{Graylog2 adapter for Yell}
+
+  s.rubyforge_project = "yell"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  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"
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: yell-adapters-gelf
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
+platform: ruby
+authors:
+- Rudolf Schmidt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yell
+  requirement: &11062060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11062060
+description: Graylog2 adapter for Yell
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yell-adapters-gelf.rb
+- lib/yell/adapters/gelf.rb
+- lib/yell/adapters/gelf/version.rb
+- yell-adapters-gelf.gemspec
+homepage: http://rubygems.org/gems/yell
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: yell
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Yell - Your Extensible Logging Library
+test_files: []
+has_rdoc: