gelf 1.1.0.beta6 → 1.1.0.gamma1

data/CHANGELOG

@@ -1,9 +1,10 @@
 1.1.0 (not yet released), 2010-12-xx:
  + compatibility with GELF specification 1.0:
-   * requires graylog2-server version 0.9.XXXXXXXXXXXX or graylog2-server-twisted;
+   * requires graylog2-server version after 0.9.XXXXXXXXXXXX or graylog2-server-twisted;
+   * requires graylog2-web-interface version XXXXXXXXXXXX;
  + Notifier#default_options;
  + severity (level) threshold;
- + automatically set 'file' and 'line' fields;
+ + automatically set '_file', '_line' and '_timestamp', fields;
  + wrappers for GELF::Notifier#notify with severity:
    + GELF::Notifier.debug
    + GELF::Notifier.info

data/VERSION

@@ -1 +1 @@
-1.1.0.beta6
+1.1.0.gamma1

data/gelf.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gelf}
-  s.version = "1.1.0.beta6"
+  s.version = "1.1.0.gamma1"
 
   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-03}
+  s.date = %q{2010-12-09}
   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/logger.rb

@@ -25,6 +25,7 @@ module GELF
       notify_with_level(level, 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)

data/lib/gelf/notifier.rb

@@ -117,6 +117,7 @@ module GELF
       stringify_hash_keys
       convert_hoptoad_keys_to_graylog2
       set_file_and_line
+      set_timestamp
       check_presence_of_mandatory_attributes
       @hash
     end
@@ -138,17 +139,22 @@ module GELF
     end
 
     CALLER_REGEXP = /^(.*):(\d+).*/
+    LIB_GELF_PATTERN = File.join('lib', 'gelf')
 
     def set_file_and_line
       stack = caller
       begin
         frame = stack.shift
-      end while frame.include?(__FILE__)
+      end while frame.include?(LIB_GELF_PATTERN)
       match = CALLER_REGEXP.match(frame)
       @hash['_file'] = match[1]
       @hash['_line'] = match[2].to_i
     end
 
+    def set_timestamp
+      @hash['_timestamp'] = Time.now.utc.to_f
+    end
+
     def check_presence_of_mandatory_attributes
       %w(_version _short_message _host).each do |attribute|
         if @hash[attribute].to_s.empty?

data/test/test_notifier.rb

@@ -1,11 +1,5 @@
 require 'helper'
 
-HASH = { '_version' => '1.0',
-         '_short_message' => 'message',
-         '_host' => 'somehost',
-         '_level' => GELF::WARN,
-         '_facility' => 'test' }
-
 RANDOM_DATA = ('A'..'Z').to_a
 
 class TestNotifier < Test::Unit::TestCase
@@ -39,19 +33,17 @@ class TestNotifier < Test::Unit::TestCase
       end
 
       should "work with hash" do
-        hash = @notifier.__send__(:extract_hash, HASH)
-        hash.delete('_file')
-        hash.delete('_line')
-        assert_equal HASH, hash
+        hash = @notifier.__send__(:extract_hash, { '_version' => '1.0', '_short_message' => 'message' })
+        assert_equal '1.0', hash['_version']
+        assert_equal 'message', hash['_short_message']
       end
 
       should "work with any object which responds to #to_hash" do
         o = Object.new
-        o.expects(:to_hash).returns(HASH)
+        o.expects(:to_hash).returns({ '_version' => '1.0', '_short_message' => 'message' })
         hash = @notifier.__send__(:extract_hash, o)
-        hash.delete('_file')
-        hash.delete('_line')
-        assert_equal HASH, hash
+        assert_equal '1.0', hash['_version']
+        assert_equal 'message', hash['_short_message']
       end
 
       should "work with exception with backtrace" do
@@ -100,10 +92,10 @@ class TestNotifier < Test::Unit::TestCase
       end
 
       should "use default_options" do
-        @notifier.default_options = {:foo => 'bar', '_short_message' => 'will be hidden by explicit argument'}
-        hash = @notifier.__send__(:extract_hash, HASH)
+        @notifier.default_options = {:foo => 'bar', '_short_message' => 'will be hidden by explicit argument', '_host' => 'some_host'}
+        hash = @notifier.__send__(:extract_hash, { '_version' => '1.0', '_short_message' => 'message' })
         assert_equal 'bar', hash['foo']
-        assert_not_equal 'will be hidden by explicit argument', hash['_short_message']
+        assert_equal 'message', hash['_short_message']
       end
 
       should "be compatible with HoptoadNotifier" do
@@ -114,15 +106,21 @@ class TestNotifier < Test::Unit::TestCase
 
       should "set file and line" do
         line = __LINE__
-        hash = @notifier.__send__(:extract_hash, HASH)
+        hash = @notifier.__send__(:extract_hash, { '_version' => '1.0', '_short_message' => 'message' })
         assert_match /test_notifier.rb/, hash['_file']
         assert_equal line + 1, hash['_line']
       end
+
+      should "set timestamp" do
+        hash = @notifier.__send__(:extract_hash, { '_version' => '1.0', '_short_message' => 'message' })
+        now = Time.now.utc.to_i
+        assert ((now - 1)..(now + 1)).include?(hash['_timestamp'])
+      end
     end
 
     context "datagrams_from_hash" do
       should "not split short data" do
-        @notifier.instance_variable_set('@hash', HASH)
+        @notifier.instance_variable_set('@hash', { '_version' => '1.0', '_short_message' => 'message' })
         datagrams = @notifier.__send__(:datagrams_from_hash)
         assert_equal 1, datagrams.count
         assert_equal "\x78\x9c", datagrams[0][0..1] # zlib header
@@ -130,7 +128,8 @@ class TestNotifier < Test::Unit::TestCase
 
       should "split long data" do
         srand(1) # for stable tests
-        hash = HASH.merge('something' => (0..3000).map { RANDOM_DATA[rand(RANDOM_DATA.count)] }.join) # or it will be compressed too good
+        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
@@ -147,6 +146,7 @@ class TestNotifier < Test::Unit::TestCase
     context "level threshold" do
       setup do
         @notifier.level = GELF::WARN
+        @hash = { '_version' => '1.0', '_short_message' => 'message' }
       end
 
       ['debug', 'DEBUG', :debug].each do |l|
@@ -158,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('_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('_level' => GELF::WARN))
+        @notifier.notify!(@hash.merge('_level' => GELF::WARN))
       end
     end
 
@@ -175,7 +175,7 @@ class TestNotifier < Test::Unit::TestCase
       should "not send datagrams" do
         @sender.expects(:send_datagrams).never
         @notifier.expects(:extract_hash).never
-        @notifier.notify!(HASH)
+        @notifier.notify!({ '_version' => '1.0', '_short_message' => 'message' })
       end
 
       context "and enabled again" do
@@ -185,7 +185,7 @@ class TestNotifier < Test::Unit::TestCase
 
         should "send datagrams" do
           @sender.expects(:send_datagrams)
-          @notifier.notify!(HASH)
+          @notifier.notify!({ '_version' => '1.0', '_short_message' => 'message' })
         end
       end
     end
@@ -194,13 +194,13 @@ class TestNotifier < Test::Unit::TestCase
       @sender.expects(:send_datagrams).with do |datagrams|
         datagrams.is_a?(Array) && datagrams[0].is_a?(String)
       end
-      @notifier.notify!(HASH)
+      @notifier.notify!({ '_version' => '1.0', '_short_message' => 'message' })
     end
 
     GELF::Levels.constants.each do |const|
       should "call notify with level #{const} from method name" do
-        @notifier.expects(:notify_with_level).with(GELF.const_get(const), HASH)
-        @notifier.__send__(const.downcase, HASH)
+        @notifier.expects(:notify_with_level).with(GELF.const_get(const), { '_version' => '1.0', '_short_message' => 'message' })
+        @notifier.__send__(const.downcase, { '_version' => '1.0', '_short_message' => 'message' })
       end
     end
 

metadata

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