gelf 1.4.0 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 204c030f01e64d6980fe343a5d53144c3f31c894
+  data.tar.gz: 7ae8e4d33e55764f191692a396f950e87118f359
+SHA512:
+  metadata.gz: d3dfbe2d3d722a53de17c4a46edf93ffb4d17105b1f481f07bfaad598d9a29a070d1cdc5c8160e05c11bc1d373ee95c1de7997b676981826169a191f507c324e
+  data.tar.gz: c4d5d7fbf18e55096ae640af049c7e508a718a88c8e321b901bf7765f5da85c421ca3bb76d037534c5844cb1ae85534adda4648b3c9a601228246c7b54f21e17

data/.travis.yml

@@ -3,7 +3,10 @@ rvm:
   - ree
   - 1.9.2
   - 1.9.3
-  - jruby
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - jruby-19mode
 
 notifications:
   irc: "irc.freenode.org#graylog2"

data/CHANGELOG

@@ -1,3 +1,6 @@
+2.0.0, 2016-02-02
+ * Added GELF support
+
 1.3.2, 2011-12-02:
  * support for rubygems-test.
  * rescue from more network errors.

data/CONTRIBUTING.md

@@ -0,0 +1 @@
+Please follow [the instructions on graylog.org](https://www.graylog.org/contributing-to-graylog/).

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+group :development do
+  gem "shoulda", "~> 2.11.3"
+  gem "jeweler", "~> 1.8.7"
+  gem "mocha", "~> 0.14.0"
+  gem "test-unit", "~> 3.0.8"
+end

data/Gemfile.lock

@@ -0,0 +1,61 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    jeweler (1.8.7)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.2)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    metaclass (0.0.1)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.9)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    power_assert (0.2.3)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    shoulda (2.11.3)
+    test-unit (3.0.9)
+      power_assert
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.8.7)
+  mocha (~> 0.14.0)
+  shoulda (~> 2.11.3)
+  test-unit (~> 3.0.8)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2011 Lennart Koopmann, Alexey Palazhchenko
+Copyright (c) 2010-2016 Lennart Koopmann, Alexey Palazhchenko
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,62 @@
+## GELF Ruby library
+
+This is the new GELF gem written by Alexey Palazhchenko. It is based on the old gem by Lennart Koopmann and allows you to send GELF messages to Graylog2 server instances. See [http://www.graylog2.org/about/gelf](http://www.graylog2.org/about/gelf) for more information about GELF and [http://rdoc.info/github/Graylog2/gelf-rb/master/frames](http://rdoc.info/github/Graylog2/gelf-rb/master/frames) for API documentation.
+
+Tested with Ruby 1.8.7, 1.9.x. and 2.0.x.
+
+![](https://travis-ci.org/Graylog2/gelf-rb.png?branch=master)
+
+## Usage
+### Gelf::Notifier
+
+This allows you to sent arbitary messages via UDP to your Graylog2 server.
+
+    n = GELF::Notifier.new("localhost", 12201)
+
+    # Send with custom attributes and an additional parameter "foo"
+    n.notify!(:short_message => "foo", :full_message => "something here\n\nbacktrace?!", :_foo => "bar")
+
+    # Pass any object that responds to .to_hash
+    n.notify!(Exception.new)
+
+The recommended default is to send via UDP but you can choose to send via TCP like this:
+
+    n = GELF::Notifier.new("127.0.0.1", 12201, "LAN", { :protocol => GELF::Protocol::TCP })
+
+Note that the `LAN` or `WAN` option is ignored for TCP because no chunking happens. (Read below for more information.)
+
+### Gelf::Logger
+
+The Gelf::Logger is compatible with the standard Ruby Logger interface and can be used interchangeably.
+Under the hood it uses Gelf::Notifier to send log messages via UDP to Graylog.
+
+    logger = GELF::Logger.new("localhost", 12201, "WAN", { :facility => "appname" })
+
+    logger.debug "foobar"
+    logger.info "foobar"
+    logger.warn "foobar"
+    logger.error "foobar"
+    logger.fatal "foobar"
+
+    logger << "foobar"
+
+Then `WAN` or `LAN` option influences the UDP chunk size depending on if you send in your own
+network (LAN) or on a longer route (i.e. through the internet) and should be set accordingly.
+
+Since it's compatible with the Logger interface, you can also use it in your Rails application:
+
+    # config/environments/production.rb
+    config.logger = GELF::Logger.new("localhost", 12201, "WAN", { :facility => "appname" })
+
+### Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010-2016 Lennart Koopmann and Alexey Palazhchenko. See LICENSE for details.

data/Rakefile

@@ -11,14 +11,13 @@ begin
 
   Jeweler::Tasks.new do |gem|
     gem.name = "gelf"
-    gem.summary = 'Library to send GELF messages to Graylog2 logging server.'
-    gem.description = 'Library to send GELF messages to Graylog2 logging server. Supports plain-text, GELF messages and exceptions.'
-    gem.email = "alexey.palazhchenko@gmail.com"
+    gem.summary = 'Library to send GELF messages to Graylog logging server.'
+    gem.description = 'Library to send GELF messages to Graylog logging server. Supports plain-text, GELF messages and exceptions via UDP and TCP.'
+    gem.email = "lennart@graylog.com"
     gem.homepage = "http://github.com/Graylog2/gelf-rb"
-    gem.authors = ["Alexey Palazhchenko", "Lennart Koopmann"]
+    gem.authors = ["Alexey Palazhchenko", "Lennart Koopmann", "Zac Sprackett"]
     gem.add_dependency "json"
-    gem.add_development_dependency "shoulda"
-    gem.add_development_dependency "mocha"
+    gem.licenses = ["MIT"]
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
 rescue LoadError => e
@@ -33,7 +32,6 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-task :test => :check_dependencies
 task :default => :test
 
 begin

data/VERSION

@@ -1 +1 @@
-1.4.0
+2.0.0

data/gelf.gemspec

@@ -2,26 +2,32 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: gelf 2.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "gelf"
-  s.version = "1.4.0"
+  s.version = "2.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Alexey Palazhchenko", "Lennart Koopmann"]
-  s.date = "2013-01-26"
-  s.description = "Library to send GELF messages to Graylog2 logging server. Supports plain-text, GELF messages and exceptions."
-  s.email = "alexey.palazhchenko@gmail.com"
+  s.require_paths = ["lib"]
+  s.authors = ["Alexey Palazhchenko", "Lennart Koopmann", "Zac Sprackett"]
+  s.date = "2016-02-03"
+  s.description = "Library to send GELF messages to Graylog logging server. Supports plain-text, GELF messages and exceptions via UDP and TCP."
+  s.email = "lennart@graylog.com"
   s.extra_rdoc_files = [
+    "CHANGELOG",
     "LICENSE",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".gemtest",
     ".travis.yml",
     "CHANGELOG",
+    "CONTRIBUTING.md",
+    "Gemfile",
+    "Gemfile.lock",
     "LICENSE",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "benchmarks/notifier.rb",
@@ -38,26 +44,32 @@ Gem::Specification.new do |s|
     "test/test_severity.rb"
   ]
   s.homepage = "http://github.com/Graylog2/gelf-rb"
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
-  s.summary = "Library to send GELF messages to Graylog2 logging server."
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.5.1"
+  s.summary = "Library to send GELF messages to Graylog logging server."
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, ["~> 2.11.3"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
+      s.add_development_dependency(%q<mocha>, ["~> 0.14.0"])
+      s.add_development_dependency(%q<test-unit>, ["~> 3.0.8"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<mocha>, [">= 0"])
     else
+      s.add_dependency(%q<shoulda>, ["~> 2.11.3"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+      s.add_dependency(%q<mocha>, ["~> 0.14.0"])
+      s.add_dependency(%q<test-unit>, ["~> 3.0.8"])
       s.add_dependency(%q<json>, [">= 0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<mocha>, [">= 0"])
     end
   else
+    s.add_dependency(%q<shoulda>, ["~> 2.11.3"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+    s.add_dependency(%q<mocha>, ["~> 0.14.0"])
+    s.add_dependency(%q<test-unit>, ["~> 3.0.8"])
     s.add_dependency(%q<json>, [">= 0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<mocha>, [">= 0"])
   end
 end
 

data/lib/gelf.rb

@@ -5,6 +5,10 @@ require 'digest/md5'
 
 module GELF
   SPEC_VERSION = '1.0'
+  module Protocol
+    UDP = 0
+    TCP = 1
+  end
 end
 
 require 'gelf/severity'

data/lib/gelf/logger.rb

@@ -4,53 +4,47 @@ module GELF
 
     attr_accessor :formatter
 
-    # Does nothing.
-    def close
-    end
-
     # Use it like Logger#add... or better not to use at all.
-    def add(level, *args)
-      raise ArgumentError.new('Wrong arguments.') unless (0..2).include?(args.count)
+    def add(level, message = nil, progname = nil, &block)
+      progname ||= default_options['facility']
 
-      # Ruby Logger's author is a maniac.
-      message, progname = if args.count == 2
-                            [args[0], args[1]]
-                          elsif args.count == 0
-                            [yield, default_options['facility']]
-                          elsif block_given?
-                            [yield, args[0]]
-                          else
-                            [args[0], default_options['facility']]
-                          end
+      if message.nil?
+        if block_given?
+          message = yield
+        else
+          message = progname
+          progname = default_options['facility']
+        end
+      end
+
+      message_hash = { 'facility' => progname }
 
       if message.is_a?(Hash)
         # Stringify keys.
-        hash = {}
         message.each do |k,v|
-          hash[k.to_s] = message[k]
+          message_hash[k.to_s] = message[k]
         end
-
-        hash['facility'] = progname
       else
-        hash = {'short_message' => message, 'facility' => progname}
+        message_hash['short_message'] = message
       end
 
-      hash.merge!(self.class.extract_hash_from_exception(message)) if message.is_a?(Exception)
+      if message.is_a?(Exception)
+        message_hash.merge!(self.class.extract_hash_from_exception(message))
+      end
 
-      notify_with_level(level, hash)
+      notify_with_level(level, message_hash)
     end
 
     # Redefines methods in +Notifier+.
     GELF::Levels.constants.each do |const|
       class_eval <<-EOT, __FILE__, __LINE__ + 1
-        def #{const.downcase}(*args)                  # def debug(*args)
-          args.unshift(yield) if block_given?         #   args.unshift(yield) if block_given?
-          add(GELF::#{const}, *args)                  #   add(GELF::DEBUG, *args)
-        end                                           # end
+        def #{const.downcase}(progname = nil, &block)   # def debug(progname = nil, &block)
+          add(GELF::#{const}, nil, progname, &block)    #   add(GELF::DEBUG, nil, progname, &block)
+        end                                             # end
 
-        def #{const.downcase}?                        # def debug?
-          GELF::#{const} >= level                     #   GELF::DEBUG >= level
-        end                                           # end
+        def #{const.downcase}?                          # def debug?
+          GELF::#{const} >= level                       #   GELF::DEBUG >= level
+        end                                             # end
       EOT
     end
 
@@ -65,7 +59,6 @@ module GELF
   #     config.colorize_logging = false
   class Logger < Notifier
     include LoggerCompatibility
-    @last_chunk_id = 0
   end
 
 end

data/lib/gelf/notifier.rb

@@ -25,8 +25,13 @@ module GELF
       self.default_options['host'] ||= Socket.gethostname
       self.default_options['level'] ||= GELF::UNKNOWN
       self.default_options['facility'] ||= 'gelf-rb'
+      self.default_options['protocol'] ||= GELF::Protocol::UDP
 
-      @sender = RubyUdpSender.new([[host, port]])
+      if self.default_options['protocol'] == GELF::Protocol::TCP
+        @sender = RubyTcpSender.new([[host, port]])
+      else
+        @sender = RubyUdpSender.new([[host, port]])
+      end
       self.level_mapping = :logger
     end
 
@@ -98,6 +103,11 @@ module GELF
       @enabled = true
     end
 
+    # Closes sender
+    def close
+      @sender.close
+    end
+
     # Same as notify!, but rescues all exceptions (including +ArgumentError+)
     # and sends them instead.
     def notify(*args)
@@ -140,7 +150,12 @@ module GELF
       extract_hash(*args)
       @hash['level'] = message_level unless message_level.nil?
       if @hash['level'] >= level
-        @sender.send_datagrams(datagrams_from_hash)
+        if self.default_options['protocol'] == GELF::Protocol::TCP
+          validate_hash
+          @sender.send(@hash.to_json + "\0")
+        else
+          @sender.send_datagrams(datagrams_from_hash)
+        end
       end
     end
 
@@ -208,7 +223,7 @@ module GELF
 
       # Maximum total size is 8192 byte for UDP datagram. Split to chunks if bigger. (GELF v1.0 supports chunking)
       if data.count > @max_chunk_size
-        id = self.class.last_chunk_id += 1
+        id = GELF::Notifier.last_chunk_id += 1
         msg_id = Digest::MD5.digest("#{Time.now.to_f}-#{id}")[0, 8]
         num, count = 0, (data.count.to_f / @max_chunk_size).ceil
         data.each_slice(@max_chunk_size) do |slice|
@@ -222,10 +237,14 @@ module GELF
       datagrams
     end
 
-    def serialize_hash
+    def validate_hash
       raise ArgumentError.new("Hash is empty.") if @hash.nil? || @hash.empty?
 
       @hash['level'] = @level_mapping[@hash['level']]
+    end
+
+    def serialize_hash
+      validate_hash
 
       Zlib::Deflate.deflate(@hash.to_json).bytes
     end

data/lib/gelf/ruby_sender.rb

@@ -16,5 +16,132 @@ module GELF
         @socket.send(datagram, 0, host, port)
       end
     end
+
+    def close
+      @socket.close
+    end
+  end
+
+  class RubyTcpSocket
+    attr_accessor :socket
+
+    def initialize(host, port)
+      @host = host
+      @port = port
+      connect
+    end
+
+    def connected?
+      if not @connected
+        begin
+          if @socket.nil?
+            @socket = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
+          end
+          sockaddr = Socket.sockaddr_in(@port, @host)
+          @socket.connect_nonblock(sockaddr)
+        rescue Errno::EISCONN
+          @connected = true
+        rescue Errno::EINPROGRESS, Errno::EALREADY
+          @connected = false
+        rescue SystemCallError
+          @socket = nil
+          @connected = false
+        end
+      end
+      return @connected
+    end
+
+    def connect
+      @connected = false
+      socket = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
+      sockaddr = Socket.sockaddr_in(@port, @host)
+      begin
+        socket.connect_nonblock(sockaddr)
+      rescue Errno::EISCONN
+        @connected = true
+      rescue SystemCallError
+        return false
+      end
+      @socket = socket
+      return true
+    end
+
+    def matches?(host, port)
+      if @host == host and @port == port
+        true
+      else
+        false
+      end
+    end
+  end
+
+  class RubyTcpSender
+    attr_reader :addresses
+
+    def initialize(addresses)
+      @sockets = []
+      addresses.each do |address|
+        s = RubyTcpSocket.new(address[0], address[1])
+        @sockets.push(s)
+      end
+    end
+
+    def addresses=(addresses)
+      addresses.each do |address|
+        found = false
+        # handle pre existing sockets
+        @sockets.each do |socket|
+          if socket.matches?(address[0], address[1])
+            found = true
+            break
+          end
+        end
+        if not found
+          s = RubyTcpSocket.new(address[0], address[1])
+          @sockets.push(s)
+        end
+      end
+    end
+
+    def send(message)
+      while true do
+        sent = false
+        sockets = @sockets.map { |s|
+          if s.connected?
+            s.socket
+          end
+        }
+        sockets.compact!
+        next unless not sockets.empty?
+        begin
+          result = select( nil, sockets, nil, 1)
+          if result
+            writers = result[1]
+            sent = write_any(writers, message)
+          end
+          break if sent
+        rescue SystemCallError, IOError
+        end
+      end
+    end
+
+    private
+    def write_any(writers, message)
+      writers.shuffle.each do |w|
+        begin
+          w.write(message)
+          return true
+        rescue Errno::EPIPE
+          @sockets.each do |s|
+            if s.socket == w
+              s.socket.close
+              s.socket = nil
+              s.connect
+            end
+          end
+        end
+      end
+      return false
+    end
   end
 end

data/test/test_logger.rb

@@ -21,7 +21,7 @@ class TestLogger < Test::Unit::TestCase
           hash['short_message'] == 'Message' &&
           hash['facility'] == 'gelf-rb'
         end
-        @logger.add(GELF::INFO, 'Message')
+        @logger.add(GELF::INFO, nil, 'Message')
       end
 
       # logger.add(Logger::INFO, RuntimeError.new('Boom!'))
@@ -32,7 +32,7 @@ class TestLogger < Test::Unit::TestCase
           hash['full_message'] =~ /^Backtrace/ &&
           hash['facility'] == 'gelf-rb'
         end
-        @logger.add(GELF::INFO, RuntimeError.new('Boom!'))
+        @logger.add(GELF::INFO, nil, RuntimeError.new('Boom!'))
       end
 
       # logger.add(Logger::INFO) { 'Message' }
@@ -42,7 +42,7 @@ class TestLogger < Test::Unit::TestCase
           hash['short_message'] == 'Message' &&
           hash['facility'] == 'gelf-rb'
         end
-        @logger.add(GELF::INFO) { 'Message' }
+        @logger.add(GELF::INFO, nil, nil) { 'Message' }
       end
 
       # logger.add(Logger::INFO) { RuntimeError.new('Boom!') }
@@ -53,7 +53,7 @@ class TestLogger < Test::Unit::TestCase
           hash['full_message'] =~ /^Backtrace/ &&
           hash['facility'] == 'gelf-rb'
         end
-        @logger.add(GELF::INFO) { RuntimeError.new('Boom!') }
+        @logger.add(GELF::INFO, nil, nil) { RuntimeError.new('Boom!') }
       end
 
       # logger.add(Logger::INFO, 'Message', 'Facility')
@@ -66,6 +66,27 @@ class TestLogger < Test::Unit::TestCase
         @logger.add(GELF::INFO, 'Message', 'Facility')
       end
 
+      # logger.add(Logger::INFO, 'Message', nil)
+      should "use facility from initialization if facility is nil" do
+        logger = GELF::Logger.new('localhost', 12202, 'WAN', :facility => 'foo-bar')
+        logger.expects(:notify_with_level!).with do |level, hash|
+          level == GELF::INFO &&
+          hash['short_message'] == 'Message' &&
+          hash['facility'] == 'foo-bar'
+        end
+        logger.add(GELF::INFO, 'Message', nil)
+      end
+
+      # logger.add(Logger::INFO, 'Message', nil)
+      should "use default facility if facility is nil" do
+        @logger.expects(:notify_with_level!).with do |level, hash|
+          level == GELF::INFO &&
+          hash['short_message'] == 'Message' &&
+          hash['facility'] == 'gelf-rb'
+        end
+        @logger.add(GELF::INFO, 'Message', nil)
+      end
+
       # logger.add(Logger::INFO, RuntimeError.new('Boom!'), 'Facility')
       should "implement add method with level, exception and facility from parameters" do
         @logger.expects(:notify_with_level!).with do |level, hash|
@@ -77,17 +98,17 @@ class TestLogger < Test::Unit::TestCase
         @logger.add(GELF::INFO, RuntimeError.new('Boom!'), 'Facility')
       end
 
-      # logger.add(Logger::INFO, 'Facility') { 'Message' }
+      # logger.add(Logger::INFO, nil, 'Facility') { 'Message' }
       should "implement add method with level and facility from parameters, message from block" do
         @logger.expects(:notify_with_level!).with do |level, hash|
           level == GELF::INFO &&
           hash['short_message'] == 'Message' &&
           hash['facility'] == 'Facility'
         end
-        @logger.add(GELF::INFO, 'Facility') { 'Message' }
+        @logger.add(GELF::INFO, nil, 'Facility') { 'Message' }
       end
 
-      # logger.add(Logger::INFO, 'Facility') { RuntimeError.new('Boom!') }
+      # logger.add(Logger::INFO, nil, 'Facility') { RuntimeError.new('Boom!') }
       should "implement add method with level and facility from parameters, exception from block" do
         @logger.expects(:notify_with_level!).with do |level, hash|
           level == GELF::INFO &&
@@ -95,7 +116,7 @@ class TestLogger < Test::Unit::TestCase
           hash['full_message'] =~ /^Backtrace/ &&
           hash['facility'] == 'Facility'
         end
-        @logger.add(GELF::INFO, 'Facility') { RuntimeError.new('Boom!') }
+        @logger.add(GELF::INFO, nil, 'Facility') { RuntimeError.new('Boom!') }
       end
 
 
@@ -123,7 +144,7 @@ class TestLogger < Test::Unit::TestCase
         @logger.add(GELF::INFO, { :short_message => "Some message", :_foo => "bar", "_zomg" => "wat"})
       end
 
-      # logger.add(Logger::INFO, "somefac", { :short_message => "Some message", :_foo => "bar", "_zomg" => "wat" })
+      # logger.add(Logger::INFO, { :short_message => "Some message", :_foo => "bar", "_zomg" => "wat" }, 'somefac')
       should "implement add method with level and message from hash, facility from parameters and some additional fields" do
         @logger.expects(:notify_with_level!).with do |level, hash|
           level == GELF::INFO &&
@@ -139,19 +160,31 @@ class TestLogger < Test::Unit::TestCase
     GELF::Levels.constants.each do |const|
       # logger.error "Argument #{ @foo } mismatch."
       should "call add with level #{const} from method name, message from parameter" do
-        @logger.expects(:add).with(GELF.const_get(const), 'message')
+        @logger.expects(:notify_with_level!).with do |level, hash|
+          level == GELF.const_get(const) &&
+          hash['short_message'] == 'message' &&
+          hash['facility'] == 'gelf-rb'
+        end
         @logger.__send__(const.downcase, 'message')
       end
 
       # logger.fatal { "Argument 'foo' not given." }
       should "call add with level #{const} from method name, message from block" do
-        @logger.expects(:add).with(GELF.const_get(const), 'message')
+        @logger.expects(:notify_with_level!).with do |level, hash|
+          level == GELF.const_get(const) &&
+          hash['short_message'] == 'message' &&
+          hash['facility'] == 'gelf-rb'
+        end
         @logger.__send__(const.downcase) { 'message' }
       end
 
       # logger.info('initialize') { "Initializing..." }
       should "call add with level #{const} from method name, facility from parameter, message from block" do
-        @logger.expects(:add).with(GELF.const_get(const), 'message', 'facility')
+        @logger.expects(:notify_with_level!).with do |level, hash|
+          level == GELF.const_get(const) &&
+          hash['short_message'] == 'message' &&
+          hash['facility'] == 'facility'
+        end
         @logger.__send__(const.downcase, 'facility') { 'message' }
       end
 
@@ -176,5 +209,13 @@ class TestLogger < Test::Unit::TestCase
     should "have formatter attribute" do
       @logger.formatter
     end
+
+
+    context "close" do
+      should "close socket" do
+        @sender.expects(:close).once
+        @logger.close
+      end
+    end
   end
 end

data/test/test_notifier.rb

@@ -149,7 +149,16 @@ class TestNotifier < Test::Unit::TestCase
         datagrams = @notifier.__send__(:datagrams_from_hash)
         assert_equal 1, datagrams.count
         assert_instance_of String, datagrams[0]
-        assert_equal "\x78\x9c", datagrams[0][0..1] # zlib header
+
+        asserted = "\x78\x9c"
+        if RUBY_VERSION[0,1].to_i >= 2
+          puts "I'm a Ruby > 2.0.0. Enforcing ASCII-8BIT. (#{RUBY_VERSION}/#{RUBY_VERSION[0,1].to_i})"
+          # lol well yeah, Rubby. 
+          # http://stackoverflow.com/questions/15843684/binary-string-literals-in-ruby-2-0
+          asserted = asserted.b
+        end
+
+        assert_equal asserted, datagrams[0][0..1] # zlib header
       end
 
       should "split long data" do
@@ -168,6 +177,29 @@ class TestNotifier < Test::Unit::TestCase
           assert_equal datagrams.count, datagram[11].ord
         end
       end
+
+      should "split long data when subclassed" do
+        class MyNotifier < GELF::Notifier; end
+
+        @notifier = MyNotifier.new('host', 1234)
+        @sender = mock
+        @notifier.instance_variable_set('@sender', @sender)
+
+        srand(1) # for stable tests
+        hash = { 'version' => '1.0', 'short_message' => 'message' }
+        hash.merge!('something' => (0..3000).map { RANDOM_DATA[rand(RANDOM_DATA.count)] }.join) # or it will be compressed too good
+        @notifier.instance_variable_set('@hash', hash)
+        datagrams = @notifier.__send__(:datagrams_from_hash)
+        assert_equal 2, datagrams.count
+        datagrams.each_index do |i|
+          datagram = datagrams[i]
+          assert_instance_of String, datagram
+          assert datagram[0..1] == "\x1e\x0f" # chunked GELF magic number
+          # datagram[2..9] is a message id
+          assert_equal i, datagram[10].ord
+          assert_equal datagrams.count, datagram[11].ord
+        end
+      end
     end
 
     context "level threshold" do
@@ -194,6 +226,13 @@ class TestNotifier < Test::Unit::TestCase
       end
     end
 
+    context "close" do
+      should "close sender" do
+        @sender.expects(:close).once
+        @notifier.close
+      end
+    end
+
     context "when disabled" do
       setup do
         @notifier.disable

metadata

@@ -1,79 +1,105 @@
 --- !ruby/object:Gem::Specification
 name: gelf
 version: !ruby/object:Gem::Version
-  version: 1.4.0
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - Alexey Palazhchenko
 - Lennart Koopmann
+- Zac Sprackett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-26 00:00:00.000000000 Z
+date: 2016-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: shoulda
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: 2.11.3
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.11.3
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: jeweler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.7
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.8
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Library to send GELF messages to Graylog2 logging server. Supports plain-text,
-  GELF messages and exceptions.
-email: alexey.palazhchenko@gmail.com
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Library to send GELF messages to Graylog logging server. Supports plain-text,
+  GELF messages and exceptions via UDP and TCP.
+email: lennart@graylog.com
 executables: []
 extensions: []
 extra_rdoc_files:
+- CHANGELOG
 - LICENSE
-- README.rdoc
+- README.md
 files:
-- .gemtest
-- .travis.yml
+- ".gemtest"
+- ".travis.yml"
 - CHANGELOG
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - benchmarks/notifier.rb
@@ -89,27 +115,27 @@ files:
 - test/test_ruby_sender.rb
 - test/test_severity.rb
 homepage: http://github.com/Graylog2/gelf-rb
-licenses: []
+licenses:
+- MIT
+metadata: {}
 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: 
-rubygems_version: 1.8.24
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 3
-summary: Library to send GELF messages to Graylog2 logging server.
+specification_version: 4
+summary: Library to send GELF messages to Graylog logging server.
 test_files: []

data/README.rdoc

@@ -1,18 +0,0 @@
-= GELF
-
-This is the new GELF gem written by Alexey Palazhchenko. It is based on the old gem by Lennart Koopmann and allows you to send GELF messages to Graylog2 server instances. See http://www.graylog2.org/about/gelf for more information about GELF and http://rdoc.info/github/Graylog2/gelf-rb/master/frames for API documentation.
-
-Works with Ruby 1.8.7 and 1.9.x. 1.8.6 is not supported.
-
-== Note on Patches/Pull Requests
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010-2011 Lennart Koopmann and Alexey Palazhchenko. See LICENSE for details.