syslog-sd 1.2.4 → 1.3.1

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.8.7
+  - ree
+  - 1.9.2
+  - 1.9.3
+  - jruby
+
+notifications:
+  irc: "irc.freenode.org#graylog2"

data/CHANGELOG

@@ -1,12 +1,17 @@
-1.2.4, 2010-05-20:
+1.3.1, 2011-11-03:
+++ Merge with `gelf` gem, synchronize versions.
+ + allow to rescue from network errors.
+ + allow to set timestamp manually.
+
+1.2.4, 2011-05-20:
  * Fix a bug with SD-ID.
 
-1.2.3, 2010-05-18:
+1.2.3, 2011-05-18:
  + Allow to send timestamp as float if desired. It may improve server's parsing speed.
 
-1.2.2, 2010-05-17:
+1.2.2, 2011-05-17:
  * Minor metadata update. Moved to http://github.com/Graylog2/syslog-sd-rb
  * Return actual message from SyslogSD::Notifier#notify.
 
-1.2.0, 2010-05-17:
+1.2.0, 2011-05-17:
  + Initial version, based on master branch of `gelf` gem.

data/README.rdoc

@@ -3,6 +3,8 @@
 Super-Duper library to send syslog messages over UDP to logging server such as Graylog2 (http://graylog2.org).
 Supports Structured Data elements as defined by RFC 5424.
 
+API documentation: http://rubydoc.info/github/Graylog2/syslog-sd-rb/master/frames
+
 Based on GELF gem (https://github.com/graylog2/gelf-rb).
 
 Works with Ruby 1.8.7 and 1.9.2. 1.8.6 is not supported.

data/VERSION

@@ -1 +1 @@
-1.2.4
+1.3.1

data/lib/syslog-sd/notifier.rb

@@ -1,7 +1,7 @@
 module SyslogSD
   # syslog notifier.
   class Notifier
-    attr_accessor :enabled, :collect_file_and_line, :timestamp_as_float
+    attr_accessor :enabled, :collect_file_and_line, :rescue_network_errors, :timestamp_as_float
     attr_reader :level, :default_options, :level_mapping
 
     # +host+ and +port+ are host/ip and port of syslog server.
@@ -13,6 +13,7 @@ module SyslogSD
 
       self.level = SyslogSD::DEBUG
       self.timestamp_as_float = false
+      self.rescue_network_errors = false
 
       self.default_options = default_options
       self.default_options['host'] ||= Socket.gethostname
@@ -110,8 +111,11 @@ module SyslogSD
   private
     def notify_with_level(message_level, *args)
       notify_with_level!(message_level, *args)
+    rescue SocketError
+      raise unless self.rescue_network_errors
     rescue Exception => exception
       notify_with_level!(SyslogSD::UNKNOWN, exception)
+      exception
     end
 
     def notify_with_level!(message_level, *args)
@@ -139,6 +143,7 @@ module SyslogSD
       @hash = default_options.merge(self.class.stringify_keys(args.merge(primary_data)))
       convert_hoptoad_keys_to_graylog2
       set_file_and_line if @collect_file_and_line
+      set_timestamp
       check_presence_of_mandatory_attributes
       @hash
     end
@@ -170,6 +175,10 @@ module SyslogSD
       @hash['line'] = match[2].to_i
     end
 
+    def set_timestamp
+      @hash['timestamp'] = Time.now.utc.to_f if @hash['timestamp'].nil?
+    end
+
     def check_presence_of_mandatory_attributes
       %w(short_message host).each do |attribute|
         if @hash[attribute].to_s.empty?

data/syslog-sd.gemspec

@@ -4,19 +4,20 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{syslog-sd}
-  s.version = "1.2.4"
+  s.name = "syslog-sd"
+  s.version = "1.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Alexey Palazhchenko}, %q{Lennart Koopmann}]
-  s.date = %q{2011-05-20}
-  s.description = %q{Super-Duper library to send syslog messages over UDP to logging server such as Graylog2. Supports Structured Data elements as defined by RFC 5424.}
-  s.email = %q{alexey.palazhchenko@gmail.com}
+  s.authors = ["Alexey Palazhchenko", "Lennart Koopmann"]
+  s.date = "2011-11-03"
+  s.description = "Super-Duper library to send syslog messages over UDP to logging server such as Graylog2. Supports Structured Data elements as defined by RFC 5424."
+  s.email = "alexey.palazhchenko@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE",
     "README.rdoc"
   ]
   s.files = [
+    ".travis.yml",
     "CHANGELOG",
     "LICENSE",
     "README.rdoc",
@@ -35,10 +36,10 @@ Gem::Specification.new do |s|
     "test/test_ruby_sender.rb",
     "test/test_severity.rb"
   ]
-  s.homepage = %q{http://github.com/Graylog2/syslog-sd-rb}
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.2}
-  s.summary = %q{Library to send syslog messages over UDP to logging server such as Graylog2. Supports Structured Data elements as defined by RFC 5424.}
+  s.homepage = "http://github.com/Graylog2/syslog-sd-rb"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.11"
+  s.summary = "Library to send syslog messages over UDP to logging server such as Graylog2. Supports Structured Data elements as defined by RFC 5424."
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/test/test_notifier.rb

@@ -108,6 +108,19 @@ class TestNotifier < Test::Unit::TestCase
         assert_match /test_notifier.rb/, hash['file']
         assert_equal line + 1, hash['line']
       end
+
+      should "set timestamp to current time if not set" do
+        hash = @notifier.__send__(:extract_hash, { 'version' => '1.0', 'short_message' => 'message' })
+        assert_instance_of Float, hash['timestamp']
+        now = Time.now.utc.to_f
+        assert ((now - 1)..(now + 1)).include?(hash['timestamp'])
+      end
+
+      should "set timestamp to specified time" do
+        timestamp = 1319799449.13765
+        hash = @notifier.__send__(:extract_hash, { 'version' => '1.0', 'short_message' => 'message', 'timestamp' => timestamp })
+        assert_equal timestamp, hash['timestamp']
+      end
     end
 
     context "serialize_hash" do
@@ -164,12 +177,12 @@ class TestNotifier < Test::Unit::TestCase
 
       should "not send notifications with level below threshold" do
         @sender.expects(:send_datagram).never
-        @notifier.notify!(@hash.merge('level' => SyslogSD::DEBUG))
+        assert_nil @notifier.notify!(@hash.merge('level' => SyslogSD::DEBUG))
       end
 
       should "not notifications with level equal or above threshold" do
         @sender.expects(:send_datagram).once
-        @notifier.notify!(@hash.merge('level' => SyslogSD::WARN))
+        assert_kind_of String, @notifier.notify!(@hash.merge('level' => SyslogSD::WARN))
       end
     end
 
@@ -181,7 +194,7 @@ class TestNotifier < Test::Unit::TestCase
       should "not send datagram" do
         @sender.expects(:send_datagram).never
         @notifier.expects(:extract_hash).never
-        @notifier.notify!({ 'version' => '1.0', 'short_message' => 'message' })
+        assert_nil @notifier.notify!({ 'version' => '1.0', 'short_message' => 'message' })
       end
 
       context "and enabled again" do
@@ -191,7 +204,7 @@ class TestNotifier < Test::Unit::TestCase
 
         should "send datagram" do
           @sender.expects(:send_datagram)
-          @notifier.notify!({ 'version' => '1.0', 'short_message' => 'message' })
+          assert_kind_of String, @notifier.notify!({ 'version' => '1.0', 'short_message' => 'message' })
         end
       end
     end
@@ -200,7 +213,7 @@ class TestNotifier < Test::Unit::TestCase
       @sender.expects(:send_datagram).with do |datagram|
         datagram.is_a?(String)
       end
-      @notifier.notify!({ 'version' => '1.0', 'short_message' => 'message' })
+      assert_kind_of String, @notifier.notify!({ 'version' => '1.0', 'short_message' => 'message' })
     end
 
     SyslogSD::Levels.constants.each do |const|
@@ -217,7 +230,22 @@ class TestNotifier < Test::Unit::TestCase
     should "rescue from invalid invocation of #notify" do
       @notifier.expects(:notify_with_level!).with(nil, instance_of(Hash)).raises(ArgumentError)
       @notifier.expects(:notify_with_level!).with(SyslogSD::UNKNOWN, instance_of(ArgumentError))
-      assert_nothing_raised { @notifier.notify(:no_short_message => 'too bad') }
+      assert_kind_of ArgumentError, @notifier.notify(:no_short_message => 'too bad')
+    end
+  end
+
+  context "with notifier with real sender" do
+    setup do
+      @notifier = SyslogSD::Notifier.new('no_such_host_321')
+    end
+
+    should "raise exception" do
+      assert_raise(SocketError) { @notifier.notify('Hello!') }
+    end
+
+    should "not raise exception if asked" do
+      @notifier.rescue_network_errors = true
+      assert_nothing_raised { @notifier.notify('Hello!') }
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: syslog-sd
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 25
   prerelease: 
   segments: 
   - 1
-  - 2
-  - 4
-  version: 1.2.4
+  - 3
+  - 1
+  version: 1.3.1
 platform: ruby
 authors: 
 - Alexey Palazhchenko
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-20 00:00:00 Z
+date: 2011-11-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: shoulda
@@ -70,6 +70,7 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
+- .travis.yml
 - CHANGELOG
 - LICENSE
 - README.rdoc
@@ -116,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.2
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Library to send syslog messages over UDP to logging server such as Graylog2. Supports Structured Data elements as defined by RFC 5424.