syslogger5424 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3abf248dd903f96ba27cb315cfe45894ec6b1c31
-  data.tar.gz: 352eb7acd93d6a73707d72badbef8086a56030b6
+  metadata.gz: a5aca48fbb6352b4a7a4bc1c8efc5f02a98b532b
+  data.tar.gz: 6aa5cb54e9e791362bbb2e8f63fd4f383cc8b259
 SHA512:
-  metadata.gz: dc7dd918ef546c5063e3dea450519282c85c4387a49101bc8d00b13b4399024b8b0ec02c9f87526e3c3f12d73a408b4f94804f6d0396a2cfececa89e81f786a8
-  data.tar.gz: 1a520cb2224f81e34bdd5f4988d4fd36662b4a6c4b9f4fd1cbf2623e415821698a255ee2e23c492acccf4fc3283b29a6a8a5c620479239386f70a042ccf90462
+  metadata.gz: 7553cda8c414c9e79787c7af26c01cba6f8f9e43891c661d10dd0ccb1aa2be069df49ffa7d15dd76c46bf29b57a4040ac61f28eb0a44d15355b1663a26653504
+  data.tar.gz: 9a5cc28f8a00d500d2968f3194fc66a7d6fcc67f63d2169e837c1e0566fb734db3e1ff53bdbf2e453d3d1ef78e7ad31b7c1d5eac33115f75c5bc3db2b3c02bae

data/lib/syslogger/creators.rb

@@ -0,0 +1,20 @@
+require 'socket'
+
+
+module SysLogger
+  module Creators
+    def self.unix_dgram_socket(socket_path)
+      proc {
+        client = Socket.new(Socket::Constants::AF_LOCAL, Socket::Constants::SOCK_DGRAM, 0)
+        client.connect(Socket.pack_sockaddr_un(socket_path))
+        client
+      }
+    end
+
+    def self.unix_stream_socket(socket_path)
+      proc {
+        UnixSocket.new(socket_path)
+      }
+    end
+  end
+end

data/lib/syslogger/formatter/rfc5424.rb

@@ -3,7 +3,7 @@ module SysLogger
     class RFC5424 < ::Logger::Formatter
       attr_reader :msgid, :procid, :appname
 
-      Format = "<%s>1 %s %s %s %s %s [meta x-group=\"%s\"] %s\n"
+      Format = "<%s>1 %s %s %s %s %s %s %s\n"
 
       FACILITIES = {
         :kern     => 0,
@@ -48,43 +48,98 @@ module SysLogger
       def initialize(appname = nil, procid = nil, msgid = nil, facility = nil)
         super()
 
-        @msgid = format(msgid, 32)
-        @procid = format(procid || Process.pid.to_s, 128)
-        @appname = format(appname, 48)
+        @counter = 0
+
+        @hostname = Socket.gethostname
+        @msgid = format_field(msgid, 32)
+        @procid = procid
+        @procid = format_field(procid || Process.pid.to_s, 128)
+        @appname = format_field(appname, 48)
 
         self.facility = facility || :local7
       end
 
-      def facility; @facility; end
+      def facility
+        @facility
+      end
+
       def facility=(f)
         @facility = FACILITIES[f.to_s.downcase.to_sym] || @facility
       end
 
       def call(severity, datetime, progname, message)
         severity = SEVERITIES[severity.to_s.downcase.to_sym] || SEVERITIES[:info]
-        pri = (facility * 8) + severity
+        pri = (facility << 3) | severity
 
         # Since we're using RFC5424 format, it makes more sense to use the
         # passed in progname as the msgid rather than changing the appname when
         # a block was received to generate the message.
-        message_id = progname.nil? ? msgid : format(progname, 32)
+        message_id = progname.nil? ? msgid : format_field(progname, 32)
+
+        @counter = (@counter + 1) % 65536
+
+        structured_data = {
+          "meta" => {
+            "x-group" => rand(99999999),
+            "x-counter" => @counter
+          }
+        }
+
+        sd = format_sdata(structured_data)
 
-        x_group = rand(99999999)
         lines = msg2str(message).split(/\r?\n/).reject(&:empty?).map do |line|
-          Format % [pri, datetime.strftime("%FT%T.%6N%:z"), Socket.gethostname,
-                    appname, procid, message_id, x_group, line]
+          Format % [pri, datetime.strftime("%FT%T.%6N%:z"), @hostname,
+                    @appname, format_field(@procid || Process.pid.to_s, 128),
+                    message_id, sd, line]
         end
 
         lines.join
       end
 
-      def format(text, max_length)
+      private
+      def format_field(text, max_length)
         if text
           text[0..max_length].gsub(/\s+/, '')
         else
           '-'
         end
       end
+
+      def format_sdata(sdata)
+        if sdata.empty?
+          '-'
+        end
+        # TODO clean up of SD-NAMe and PARAM-VALUE is kind of brute force
+        #      here, could be done better per RFC5424
+        r = []
+        sdata.each { |sid, hash|
+          s = []
+          s.push(sid.to_s.gsub(/[^-\w]/, ""))
+          hash.each { |n, v|
+            paramname = n.to_s.gsub(/[^-\w]/, "")
+            paramvalue = v.to_s.gsub(/[\]"=]/, "")
+            s.push("#{paramname}=\"#{paramvalue}\"")
+          }
+          r.push("["+s.join(" ")+"]")
+        }
+        rx = []
+        r.each { |x|
+          rx.push("[#{x}]")
+        }
+        r.join("")
+      end
+
+      def msg2str(msg)
+        case msg
+          when ::String
+            msg
+          when ::Exception
+            "#{ msg.message } (#{ msg.class })\n" <<
+              (msg.backtrace || []).join("\n")
+          else
+            msg.inspect
+        end
+      end
     end
   end
 end

data/lib/syslogger/io.rb

@@ -3,10 +3,18 @@ module SysLogger
     def initialize(&file_creator)
       @file_creator = file_creator
       @file = @file_creator.call
+      @connect_pid = Process.pid
     end
 
     def file
-      @file.closed? ? @file = @file_creator.call : @file
+      # re-connect on fork
+      if Process.pid != @connect_pid
+        @file.close
+      end
+      if @file.nil? || @file.closed?
+        @file = @file_creator.call
+      end
+      @file
     end
 
     def write(message)

data/lib/syslogger/logger.rb

@@ -16,7 +16,18 @@ module SysLogger
       @default_formatter = SysLogger::Formatter::RFC5424.new
     end
 
-    alias_method :<<,    :info
-    alias_method :write, :info
+    def <<(msg)
+      # Logger's version of this just dumps the input without formatting. there
+      # is never a case where we don't want to format the content to the syslog
+      # server properly.
+      # default to a serverity of info.
+      msg.split(/\r?\n/).each { |line|
+          if line then
+              self.info(line)
+          end
+      }
+    end
+
+    alias_method :write, :<<
   end
 end

data/lib/syslogger.rb

@@ -1,6 +1,7 @@
 require "syslogger/logger"
 require "syslogger/io"
 require "syslogger/formatter/rfc5424"
+require "syslogger/creators"
 
 module SysLogger
   extend self

data/spec/syslogger/formatter/rfc5424_spec.rb

@@ -1,3 +1,6 @@
+require 'date'
+
+
 describe SysLogger::Formatter::RFC5424 do
   its(:msgid)    { is_expected.to eq "-" }
   its(:procid)   { is_expected.to eq Process.pid.to_s }
@@ -7,7 +10,23 @@ describe SysLogger::Formatter::RFC5424 do
   describe "#call" do
     it "generates Format" do
       expect(subject.call(::Logger::INFO, DateTime.now, "Prog", "Message")).
-        to match /<190>1.* - #{Process.pid} Prog \[meta x-group=".*"\] Message/
+        to match(/<190>1.* - #{Process.pid} Prog \[meta x-group="[^"]+" x-counter="[^"]+"\] Message/)
+    end
+
+    it "counts sequentially" do
+      line1 = subject.call(::Logger::INFO, DateTime.now, "Prog", "Message1")
+      if line1 =~ /.*x-counter="([^"]+)".*/
+        counter1 = $1.to_i
+      else
+        counter1 = 0
+      end
+      line2 = subject.call(::Logger::INFO, DateTime.now, "Prog", "Message2")
+      if line2 =~ /.*x-counter="([^"]+)".*/
+        counter2 = $1.to_i
+      else
+        counter2 = 0
+      end
+      expect(counter2).to be > counter1
     end
   end
 end

data/spec/syslogger/io_spec.rb

@@ -1,3 +1,8 @@
+require 'socket'
+require 'rspec/temp_dir'
+
+require 'syslogger/creators'
+
 describe SysLogger::IO do
   let(:io) { StringIO.new }
 
@@ -10,5 +15,22 @@ describe SysLogger::IO do
       subject.write("foobar")
       expect(io.string).to eq "foobar"
     end
+
+  end
+
+  describe "unix_dgram_socket" do
+    let(:socket_path) { "#{temp_dir}/listen.sock"  }
+    subject { SysLogger::IO.new(&SysLogger::Creators::unix_dgram_socket(socket_path))  }
+
+    describe "#write integration" do
+      include_context "uses temp dir"
+
+      it "actually can write to a domain socket" do
+        s = Socket.new(Socket::Constants::AF_LOCAL, Socket::Constants::SOCK_DGRAM, 0)
+        s.bind(Socket.pack_sockaddr_un(socket_path))
+        subject.write("foobar\n")
+        expect(s.recvfrom(1024)[0]).to eq "foobar\n"
+      end
+    end
   end
 end

metadata

@@ -1,83 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: syslogger5424
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - EasyPost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-30 00:00:00.000000000 Z
+date: 2016-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mono_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-temp_dir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -87,6 +101,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/syslogger.rb
+- lib/syslogger/creators.rb
 - lib/syslogger/formatter/rfc5424.rb
 - lib/syslogger/io.rb
 - lib/syslogger/logger.rb
@@ -104,17 +119,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Logging via syslog using RFC 5424 format