gelf 1.1.0.beta4 → 1.1.0.beta6

data/VERSION

@@ -1 +1 @@
-1.1.0.beta4
+1.1.0.beta6

data/benchmarks/notifier.rb

@@ -15,11 +15,11 @@ k3_message = (1..3*1024).map { RANDOM_DATA[rand(RANDOM_DATA.count)] }.join
 
 TARGET_HOST = 'localhost'
 TARGET_PORT = 12201
-DEFAULT_OPTIONS = { 'host' => 'localhost' }
+DEFAULT_OPTIONS = { '_host' => 'localhost' }
 TIMES = 5000
 
-SHORT_HASH = { 'short_message' => 'message' }
-LONG_HASH  = { 'short_message' => 'message', 'long_message' => k3_message }
+SHORT_HASH = { '_short_message' => 'message' }
+LONG_HASH  = { '_short_message' => 'message', '_long_message' => k3_message }
 
 
 notifier_lan = GELF::Notifier.new(TARGET_HOST, TARGET_PORT, 'LAN', DEFAULT_OPTIONS)

data/gelf.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gelf}
-  s.version = "1.1.0.beta4"
+  s.version = "1.1.0.beta6"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aleksey Palazhchenko", "Lennart Koopmann"]
-  s.date = %q{2010-12-02}
+  s.date = %q{2010-12-03}
   s.description = %q{Library to send GELF messages to Graylog2 logging server. Supports plain-text, GELF messages and exceptions.}
   s.email = %q{aleksey.palazhchenko@gmail.com}
   s.extra_rdoc_files = [

data/lib/gelf.rb

@@ -1,7 +1,7 @@
 require 'json'
 require 'socket'
 require 'zlib'
-require 'digest/sha2'
+require 'digest/md5'
 
 module GELF
   SPEC_VERSION = '1.0'

data/lib/gelf/em_sender.rb

@@ -1,10 +1,19 @@
-module GELF
-  # Sender for EventMachine.
-  class EMSender
-    def initialize(host, port)
-    end
-
-    def send_datagrams(datagrams)
-    end
-  end
-end
+# module GELF
+#   # TCP Sender for EventMachine.
+#   class EMTcpSender
+#     def initialize(host, port)
+#     end
+#
+#     def send_datagrams(datagrams)
+#     end
+#   end
+#
+#   # UDP Sender for EventMachine.
+#   class EMUdpSender
+#     def initialize(host, port)
+#     end
+#
+#     def send_datagrams(datagrams)
+#     end
+#   end
+# end

data/lib/gelf/logger.rb

@@ -20,7 +20,7 @@ module GELF
                             [args[0], nil]
                           end
 
-      hash = {'gelf_short_message' => message, 'gelf_facility' => facility}
+      hash = {'_short_message' => message, '_facility' => facility}
       hash.merge!(self.class.extract_hash_from_exception(message)) if message.is_a?(Exception)
       notify_with_level(level, hash)
     end
@@ -39,7 +39,7 @@ module GELF
     end
 
     def <<(message)
-      notify('gelf_short_message' => message, 'gelf_level' => GELF::UNKNOWN)
+      notify('_short_message' => message, '_level' => GELF::UNKNOWN)
     end
   end
 

data/lib/gelf/notifier.rb

@@ -21,12 +21,12 @@ module GELF
 
       @default_options = {}
       self.default_options = default_options
-      self.default_options['gelf_version'] = SPEC_VERSION
-      self.default_options['gelf_host'] ||= Socket.gethostname
-      self.default_options['gelf_level'] ||= GELF::DEBUG
-      self.default_options['gelf_facility'] ||= 'gelf-rb'
+      self.default_options['_version'] = SPEC_VERSION
+      self.default_options['_host'] ||= Socket.gethostname
+      self.default_options['_level'] ||= GELF::DEBUG
+      self.default_options['_facility'] ||= 'gelf-rb'
 
-      @sender = RubySender.new(host, port)
+      @sender = RubyUdpSender.new(host, port)
     end
 
     # +size+ may be a number of bytes, 'WAN' (1420 bytes) or 'LAN' (8154).
@@ -96,8 +96,8 @@ module GELF
     def notify_with_level!(message_level, *args)
       return unless @enabled
       extract_hash(*args)
-      @hash['gelf_level'] = message_level unless message_level.nil?
-      if @hash['gelf_level'] >= level
+      @hash['_level'] = message_level unless message_level.nil?
+      if @hash['_level'] >= level
         @sender.send_datagrams(datagrams_from_hash)
       end
     end
@@ -106,11 +106,11 @@ module GELF
       primary_data = if object.respond_to?(:to_hash)
                        object.to_hash
                      elsif object.is_a?(Exception)
-                       args['gelf_level'] ||= GELF::ERROR
+                       args['_level'] ||= GELF::ERROR
                        self.class.extract_hash_from_exception(object)
                      else
-                       args['gelf_level'] ||= GELF::INFO
-                       { 'gelf_short_message' => object.to_s }
+                       args['_level'] ||= GELF::INFO
+                       { '_short_message' => object.to_s }
                      end
 
       @hash = default_options.merge(args.merge(primary_data))
@@ -123,21 +123,21 @@ module GELF
 
     def self.extract_hash_from_exception(exception)
       bt = exception.backtrace || ["Backtrace is not available."]
-      { 'gelf_short_message' => "#{exception.class}: #{exception.message}", 'gelf_full_message' => "Backtrace:\n" + bt.join("\n") }
+      { '_short_message' => "#{exception.class}: #{exception.message}", '_full_message' => "Backtrace:\n" + bt.join("\n") }
     end
 
     # Converts Hoptoad-specific keys in +@hash+ to Graylog2-specific.
     def convert_hoptoad_keys_to_graylog2
-      if @hash['gelf_short_message'].to_s.empty?
+      if @hash['_short_message'].to_s.empty?
         if @hash.has_key?('error_class') && @hash.has_key?('error_message')
-          @hash['gelf_short_message'] = "#{@hash['error_class']}: #{@hash['error_message']}"
+          @hash['_short_message'] = "#{@hash['error_class']}: #{@hash['error_message']}"
           @hash.delete('error_class')
           @hash.delete('error_message')
         end
       end
     end
 
-    CALLER_REGEXP = /^(.*):(\d+):.*/
+    CALLER_REGEXP = /^(.*):(\d+).*/
 
     def set_file_and_line
       stack = caller
@@ -145,14 +145,14 @@ module GELF
         frame = stack.shift
       end while frame.include?(__FILE__)
       match = CALLER_REGEXP.match(frame)
-      @hash['gelf_file'] = match[1]
-      @hash['gelf_line'] = match[2].to_i
+      @hash['_file'] = match[1]
+      @hash['_line'] = match[2].to_i
     end
 
     def check_presence_of_mandatory_attributes
-      %w(gelf_version gelf_short_message gelf_host).each do |attribute|
+      %w(_version _short_message _host).each do |attribute|
         if @hash[attribute].to_s.empty?
-          raise ArgumentError.new("#{attribute} is missing. Options gelf_version, gelf_short_message and gelf_host must be set.")
+          raise ArgumentError.new("#{attribute} is missing. Options _version, _short_message and _host must be set.")
         end
       end
     end
@@ -160,7 +160,7 @@ module GELF
     def datagrams_from_hash
       raise ArgumentError.new("Hash is empty.") if @hash.nil? || @hash.empty?
 
-      @hash['gelf_level'] = GELF::LEVELS_MAPPING[@hash['gelf_level']]
+      @hash['_level'] = GELF::LEVELS_MAPPING[@hash['_level']]
 
       data = Zlib::Deflate.deflate(@hash.to_json).bytes
       datagrams = []
@@ -168,7 +168,7 @@ module GELF
       # Maximum total size is 8192 byte for UDP datagram. Split to chunks if bigger. (GELFv2 supports chunking)
       if data.count > @max_chunk_size
         id = self.class.last_chunk_id += 1
-        msg_id = Digest::SHA256.digest("#{Time.now.to_f}-#{id}")
+        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|
           datagrams << self.class.chunk_data(slice, msg_id, num, count)
@@ -182,7 +182,7 @@ module GELF
     end
 
     def self.chunk_data(data, msg_id, num, count)
-      return "\x1e\x0f" + msg_id + [num, count, *data].pack('nnC*')
+      return "\x1e\x0f" + msg_id + [num, count, *data].pack('C*')
     end
 
     def stringify_hash_keys

data/lib/gelf/ruby_sender.rb

@@ -1,6 +1,6 @@
 module GELF
-  # Plain Ruby sender.
-  class RubySender
+  # Plain Ruby UDP sender.
+  class RubyUdpSender
     def initialize(host, port)
       @host, @port = host, port
       @socket = UDPSocket.open
@@ -12,4 +12,18 @@ module GELF
       end
     end
   end
+
+  # Plain Ruby TCP sender.
+  class RubyTcpSender
+    def initialize(host, port)
+      @host, @port = host, port
+      @socket = TCPSocket.open
+    end
+
+    def send_datagrams(datagrams)
+      datagrams.each do |datagram|
+        @socket.send(datagram, 0, @host, @port)
+      end
+    end
+  end
 end

data/test/test_logger.rb

@@ -18,7 +18,7 @@ class TestLogger < Test::Unit::TestCase
       should "implement add method with level and message from parameters" do
         @notifier.expects(:notify_with_level!).with do |level, hash|
           level == GELF::INFO &&
-          hash['gelf_short_message'] == 'Message'
+          hash['_short_message'] == 'Message'
         end
         @notifier.add(GELF::INFO, 'Message')
       end
@@ -27,8 +27,8 @@ class TestLogger < Test::Unit::TestCase
       should "implement add method with level and exception from parameters" do
         @notifier.expects(:notify_with_level!).with do |level, hash|
           level == GELF::INFO &&
-          hash['gelf_short_message'] == 'RuntimeError: Boom!' &&
-          hash['gelf_full_message'] =~ /^Backtrace/
+          hash['_short_message'] == 'RuntimeError: Boom!' &&
+          hash['_full_message'] =~ /^Backtrace/
         end
         @notifier.add(GELF::INFO, RuntimeError.new('Boom!'))
       end
@@ -37,7 +37,7 @@ class TestLogger < Test::Unit::TestCase
       should "implement add method with level from parameter and message from block" do
         @notifier.expects(:notify_with_level!).with do |level, hash|
           level == GELF::INFO &&
-          hash['gelf_short_message'] == 'Message'
+          hash['_short_message'] == 'Message'
         end
         @notifier.add(GELF::INFO) { 'Message' }
       end
@@ -46,8 +46,8 @@ class TestLogger < Test::Unit::TestCase
       should "implement add method with level from parameter and exception from block" do
         @notifier.expects(:notify_with_level!).with do |level, hash|
           level == GELF::INFO &&
-          hash['gelf_short_message'] == 'RuntimeError: Boom!' &&
-          hash['gelf_full_message'] =~ /^Backtrace/
+          hash['_short_message'] == 'RuntimeError: Boom!' &&
+          hash['_full_message'] =~ /^Backtrace/
         end
         @notifier.add(GELF::INFO) { RuntimeError.new('Boom!') }
       end
@@ -56,8 +56,8 @@ class TestLogger < Test::Unit::TestCase
       should "implement add method with level, message and facility from parameters" do
         @notifier.expects(:notify_with_level!).with do |level, hash|
           level == GELF::INFO &&
-          hash['gelf_short_message'] == 'Message' &&
-          hash['gelf_facility'] == 'Facility'
+          hash['_short_message'] == 'Message' &&
+          hash['_facility'] == 'Facility'
         end
         @notifier.add(GELF::INFO, 'Message', 'Facility')
       end
@@ -66,9 +66,9 @@ class TestLogger < Test::Unit::TestCase
       should "implement add method with level, exception and facility from parameters" do
         @notifier.expects(:notify_with_level!).with do |level, hash|
           level == GELF::INFO &&
-          hash['gelf_short_message'] == 'RuntimeError: Boom!' &&
-          hash['gelf_full_message'] =~ /^Backtrace/ &&
-          hash['gelf_facility'] == 'Facility'
+          hash['_short_message'] == 'RuntimeError: Boom!' &&
+          hash['_full_message'] =~ /^Backtrace/ &&
+          hash['_facility'] == 'Facility'
         end
         @notifier.add(GELF::INFO, RuntimeError.new('Boom!'), 'Facility')
       end
@@ -77,8 +77,8 @@ class TestLogger < Test::Unit::TestCase
       should "implement add method with level and facility from parameters and message from block" do
         @notifier.expects(:notify_with_level!).with do |level, hash|
           level == GELF::INFO &&
-          hash['gelf_short_message'] == 'Message' &&
-          hash['gelf_facility'] == 'Facility'
+          hash['_short_message'] == 'Message' &&
+          hash['_facility'] == 'Facility'
         end
         @notifier.add(GELF::INFO, 'Facility') { 'Message' }
       end
@@ -87,9 +87,9 @@ class TestLogger < Test::Unit::TestCase
       should "implement add method with level and facility from parameters and exception from block" do
         @notifier.expects(:notify_with_level!).with do |level, hash|
           level == GELF::INFO &&
-          hash['gelf_short_message'] == 'RuntimeError: Boom!' &&
-          hash['gelf_full_message'] =~ /^Backtrace/ &&
-          hash['gelf_facility'] == 'Facility'
+          hash['_short_message'] == 'RuntimeError: Boom!' &&
+          hash['_full_message'] =~ /^Backtrace/ &&
+          hash['_facility'] == 'Facility'
         end
         @notifier.add(GELF::INFO, 'Facility') { RuntimeError.new('Boom!') }
       end
@@ -126,8 +126,8 @@ class TestLogger < Test::Unit::TestCase
 
     should "support Notifier#<<" do
       @notifier.expects(:notify_with_level!).with do |nil_, hash|
-        hash['gelf_short_message'] == "Message" &&
-        hash['gelf_level'] == GELF::UNKNOWN
+        hash['_short_message'] == "Message" &&
+        hash['_level'] == GELF::UNKNOWN
       end
       @notifier << "Message"
     end

data/test/test_notifier.rb

@@ -1,10 +1,10 @@
 require 'helper'
 
-HASH = { 'gelf_version' => '1.0',
-         'gelf_short_message' => 'message',
-         'gelf_host' => 'somehost',
-         'gelf_level' => GELF::WARN,
-         'gelf_facility' => 'test' }
+HASH = { '_version' => '1.0',
+         '_short_message' => 'message',
+         '_host' => 'somehost',
+         '_level' => GELF::WARN,
+         '_facility' => 'test' }
 
 RANDOM_DATA = ('A'..'Z').to_a
 
@@ -13,12 +13,12 @@ class TestNotifier < Test::Unit::TestCase
     Socket.expects(:gethostname).returns('default_hostname')
     n = GELF::Notifier.new
     assert_equal ['localhost', 12201, 1420], [n.host, n.port, n.max_chunk_size]
-    assert_equal( { 'gelf_version' => '1.0', 'gelf_level' => GELF::DEBUG,
-                    'gelf_host' => 'default_hostname', 'gelf_facility' => 'gelf-rb' },
+    assert_equal( { '_version' => '1.0', '_level' => GELF::DEBUG,
+                    '_host' => 'default_hostname', '_facility' => 'gelf-rb' },
                   n.default_options )
-    n.host, n.port, n.max_chunk_size, n.default_options = 'graylog2.org', 7777, :lan, {'gelf_host' => 'grayhost'}
+    n.host, n.port, n.max_chunk_size, n.default_options = 'graylog2.org', 7777, :lan, {'_host' => 'grayhost'}
     assert_equal ['graylog2.org', 7777, 8154], [n.host, n.port, n.max_chunk_size]
-    assert_equal({'gelf_host' => 'grayhost'}, n.default_options)
+    assert_equal({'_host' => 'grayhost'}, n.default_options)
 
     n.max_chunk_size = 1337.1
     assert_equal 1337, n.max_chunk_size
@@ -40,8 +40,8 @@ class TestNotifier < Test::Unit::TestCase
 
       should "work with hash" do
         hash = @notifier.__send__(:extract_hash, HASH)
-        hash.delete('gelf_file')
-        hash.delete('gelf_line')
+        hash.delete('_file')
+        hash.delete('_line')
         assert_equal HASH, hash
       end
 
@@ -49,8 +49,8 @@ class TestNotifier < Test::Unit::TestCase
         o = Object.new
         o.expects(:to_hash).returns(HASH)
         hash = @notifier.__send__(:extract_hash, o)
-        hash.delete('gelf_file')
-        hash.delete('gelf_line')
+        hash.delete('_file')
+        hash.delete('_line')
         assert_equal HASH, hash
       end
 
@@ -58,65 +58,65 @@ class TestNotifier < Test::Unit::TestCase
         e = RuntimeError.new('message')
         e.set_backtrace(caller)
         hash = @notifier.__send__(:extract_hash, e)
-        assert_equal 'RuntimeError: message', hash['gelf_short_message']
-        assert_match /Backtrace/, hash['gelf_full_message']
-        assert_equal GELF::ERROR, hash['gelf_level']
+        assert_equal 'RuntimeError: message', hash['_short_message']
+        assert_match /Backtrace/, hash['_full_message']
+        assert_equal GELF::ERROR, hash['_level']
       end
 
       should "work with exception without backtrace" do
         e = RuntimeError.new('message')
         hash = @notifier.__send__(:extract_hash, e)
-        assert_match /Backtrace is not available/, hash['gelf_full_message']
+        assert_match /Backtrace is not available/, hash['_full_message']
       end
 
       should "work with exception and hash" do
-        e, h = RuntimeError.new('message'), {'param' => 1, 'gelf_level' => GELF::FATAL, 'gelf_short_message' => 'will be hidden by exception'}
+        e, h = RuntimeError.new('message'), {'param' => 1, '_level' => GELF::FATAL, '_short_message' => 'will be hidden by exception'}
         hash = @notifier.__send__(:extract_hash, e, h)
-        assert_equal 'RuntimeError: message', hash['gelf_short_message']
-        assert_equal GELF::FATAL, hash['gelf_level']
+        assert_equal 'RuntimeError: message', hash['_short_message']
+        assert_equal GELF::FATAL, hash['_level']
         assert_equal 1, hash['param']
       end
 
       should "work with plain text" do
         hash = @notifier.__send__(:extract_hash, 'message')
-        assert_equal 'message', hash['gelf_short_message']
-        assert_equal GELF::INFO, hash['gelf_level']
+        assert_equal 'message', hash['_short_message']
+        assert_equal GELF::INFO, hash['_level']
       end
 
       should "work with plain text and hash" do
-        hash = @notifier.__send__(:extract_hash, 'message', 'gelf_level' => GELF::WARN)
-        assert_equal 'message', hash['gelf_short_message']
-        assert_equal GELF::WARN, hash['gelf_level']
+        hash = @notifier.__send__(:extract_hash, 'message', '_level' => GELF::WARN)
+        assert_equal 'message', hash['_short_message']
+        assert_equal GELF::WARN, hash['_level']
       end
 
       should "covert hash keys to strings" do
-        hash = @notifier.__send__(:extract_hash, :gelf_short_message => :message)
-        assert hash.has_key?('gelf_short_message')
-        assert !hash.has_key?(:gelf_short_message)
+        hash = @notifier.__send__(:extract_hash, :_short_message => :message)
+        assert hash.has_key?('_short_message')
+        assert !hash.has_key?(:_short_message)
       end
 
       should "not overwrite keys on convert" do
-        assert_raise(ArgumentError) { @notifier.__send__(:extract_hash, :gelf_short_message => :message1, 'gelf_short_message' => 'message2') }
+        assert_raise(ArgumentError) { @notifier.__send__(:extract_hash, :_short_message => :message1, '_short_message' => 'message2') }
       end
 
       should "use default_options" do
-        @notifier.default_options = {:foo => 'bar', 'gelf_short_message' => 'will be hidden by explicit argument'}
+        @notifier.default_options = {:foo => 'bar', '_short_message' => 'will be hidden by explicit argument'}
         hash = @notifier.__send__(:extract_hash, HASH)
         assert_equal 'bar', hash['foo']
-        assert_not_equal 'will be hidden by explicit argument', hash['gelf_short_message']
+        assert_not_equal 'will be hidden by explicit argument', hash['_short_message']
       end
 
       should "be compatible with HoptoadNotifier" do
         # https://github.com/thoughtbot/hoptoad_notifier/blob/master/README.rdoc, section Going beyond exceptions
         hash = @notifier.__send__(:extract_hash, :error_class => 'Class', :error_message => 'Message')
-        assert_equal 'Class: Message', hash['gelf_short_message']
+        assert_equal 'Class: Message', hash['_short_message']
       end
 
       should "set file and line" do
         line = __LINE__
         hash = @notifier.__send__(:extract_hash, HASH)
-        assert_match /test_notifier.rb/, hash['gelf_file']
-        assert_equal line + 1, hash['gelf_line']
+        assert_match /test_notifier.rb/, hash['_file']
+        assert_equal line + 1, hash['_line']
       end
     end
 
@@ -137,11 +137,9 @@ class TestNotifier < Test::Unit::TestCase
         datagrams.each_index do |i|
           datagram = datagrams[i]
           assert datagram[0..1] == "\x1e\x0f" # chunked GELF magic number
-          # datagram[2..33] is a message id
-          assert_equal 0, datagram[34].ord
-          assert_equal i, datagram[35].ord
-          assert_equal 0, datagram[36].ord
-          assert_equal datagrams.count, datagram[37].ord
+          # datagram[2..9] is a message id
+          assert_equal i, datagram[10].ord
+          assert_equal datagrams.count, datagram[11].ord
         end
       end
     end
@@ -160,12 +158,12 @@ class TestNotifier < Test::Unit::TestCase
 
       should "not send notifications with level below threshold" do
         @sender.expects(:send_datagrams).never
-        @notifier.notify!(HASH.merge('gelf_level' => GELF::DEBUG))
+        @notifier.notify!(HASH.merge('_level' => GELF::DEBUG))
       end
 
       should "not notifications with level equal or above threshold" do
         @sender.expects(:send_datagrams).once
-        @notifier.notify!(HASH.merge('gelf_level' => GELF::WARN))
+        @notifier.notify!(HASH.merge('_level' => GELF::WARN))
       end
     end
 

data/test/test_ruby_sender.rb

@@ -1,10 +1,10 @@
 require 'helper'
 
-class TestRubySender < Test::Unit::TestCase
+class TestRubyUdpSender < Test::Unit::TestCase
   context "with ruby sender" do
     setup do
       @host, @port = 'localhost', 12201
-      @sender = GELF::RubySender.new('localhost', 12201)
+      @sender = GELF::RubyUdpSender.new('localhost', 12201)
       @datagrams = %w(d1 d2 d3)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: gelf
 version: !ruby/object:Gem::Version 
-  hash: -1848230064
+  hash: -1848230050
   prerelease: true
   segments: 
   - 1
   - 1
   - 0
-  - beta4
-  version: 1.1.0.beta4
+  - beta6
+  version: 1.1.0.beta6
 platform: ruby
 authors: 
 - Aleksey Palazhchenko
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-02 00:00:00 +03:00
+date: 2010-12-03 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency