syslogger5424 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb72907be740aa357f6e75ec6b6991e411495f61
-  data.tar.gz: 3623fb6277835cf58248194a2f88ca35759d7f6a
+  metadata.gz: 5497cc4321c203d2828c59d18d79ed8e35d6ec69
+  data.tar.gz: 2610975569418bbed14c8d2dfe61e525fef5a936
 SHA512:
-  metadata.gz: 54ba31de3c9cfaeb31f3efdd263bec371a339c4706d1ba6583a970dcbc5f687fd06b87d0a5ac5dcfa498579a3044b1726b58ea8361d17728b370a53df0345529
-  data.tar.gz: c5c13c7e1d8fbcab763654ec95fb73d2ce63593ac4e35a1a82917dbeff3f803a3c11287c15388eb8594b41beb49090d425062e1f63f2fdf9446848b9ca7051b2
+  metadata.gz: 66105d5582b22820a619208cf844a9c97ca3156000b374aa77626f15fc1a848657cab6b6f3edb759e76f02f2ccfac8c0c3be7c7ab7f9411e66d93b5c82d06dce
+  data.tar.gz: a78949220b3e2e422ff6b5fc10dff8568a296e50a16c312bbf2700898b04901ddc5fc004cd8c3f6987862b4f134b9fd8a8960bda76ff0ba82e015c2efd6a0daa

data/lib/syslogger/formatter/rfc5424.rb

@@ -1,7 +1,8 @@
 module SysLogger
   module Formatter
     class RFC5424 < ::Logger::Formatter
-      attr_reader :msgid, :procid, :appname
+      attr_reader :msgid
+      attr_accessor :procid, :appname
 
       Format = "<%s>1 %s %s %s %s %s %s %s\n"
 
@@ -53,8 +54,7 @@ module SysLogger
         @hostname = Socket.gethostname
         @msgid = format_field(msgid, 32)
         @procid = procid
-        @procid = format_field(procid || Process.pid.to_s, 128)
-        @appname = format_field(appname, 48)
+        @appname = appname
 
         self.facility = facility || :local7
       end
@@ -88,7 +88,7 @@ module SysLogger
           structured_data["meta"]["x-counter"] = @counter
           sd = format_sdata(structured_data)
           Format % [pri, datetime.strftime("%FT%T.%6N%:z"), @hostname,
-                    @appname, format_field(@procid || Process.pid.to_s, 128),
+                    format_field(@appname, 48), format_field(@procid || Process.pid.to_s, 128),
                     message_id, sd, line]
         end
         if lines.size == 1

data/lib/syslogger/logger.rb

@@ -16,6 +16,22 @@ module SysLogger
       @default_formatter = SysLogger::Formatter::RFC5424.new
     end
 
+    def appname=(appname)
+      @default_formatter.appname = appname
+    end
+
+    def appname
+      @default_formatter.appname
+    end
+
+    def procid=(procid)
+      @default_formatter.procid = procid
+    end
+
+    def procid
+      @default_formatter.appname
+    end
+
     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

data/spec/syslogger/formatter/rfc5424_spec.rb

@@ -3,10 +3,17 @@ require 'date'
 
 describe SysLogger::Formatter::RFC5424 do
   its(:msgid)    { is_expected.to eq "-" }
-  its(:procid)   { is_expected.to eq Process.pid.to_s }
-  its(:appname)  { is_expected.to eq "-" }
+  its(:procid)   { is_expected.to eq nil }
+  its(:appname)  { is_expected.to eq nil }
   its(:facility) { is_expected.to eq 23 }
 
+  let(:test_date) { DateTime.new(2019, 10, 31, 20, 8) }
+  let(:test_hostname) { "host1sf" }
+
+  before do
+    allow(Socket).to receive(:gethostname).and_return(test_hostname)
+  end
+
   describe "#call" do
     it "generates Format" do
       expect(subject.call(::Logger::INFO, DateTime.now, "Prog", "Message")).
@@ -28,5 +35,33 @@ describe SysLogger::Formatter::RFC5424 do
       end
       expect(counter2).to be > counter1
     end
+
+    context "nil appname" do
+      it "formats correctly" do
+        expect(Socket).to receive(:gethostname).and_return(test_hostname)
+        expect(subject).to receive(:gen_xgroup).and_return(74901736)
+        expect(subject.call(::Logger::INFO, test_date, "Prog", "Message")).to eq (
+          "<190>1 2019-10-31T20:08:00.000000+00:00 host1sf - #{Process.pid.to_s} Prog [meta x-group=\"74901736\" x-counter=\"1\"] Message\n"
+        )
+      end
+    end
+
+    context "custom appname" do
+      it "formats correctly" do
+        subject.appname = "short-appname"
+        expect(subject).to receive(:gen_xgroup).and_return(74901736)
+        expect(subject.call(::Logger::INFO, test_date, "Prog", "Message")).to eq (
+          "<190>1 2019-10-31T20:08:00.000000+00:00 host1sf short-appname #{Process.pid.to_s} Prog [meta x-group=\"74901736\" x-counter=\"1\"] Message\n"
+        )
+      end
+
+      it "truncates to 48 bytes" do
+        subject.appname = "this-is-a-very-long-appname-with-many-parts-in-it-for-sure-yep"
+        expect(subject).to receive(:gen_xgroup).and_return(74901736)
+        expect(subject.call(::Logger::INFO, test_date, "Prog", "Message")).to eq (
+          "<190>1 2019-10-31T20:08:00.000000+00:00 host1sf this-is-a-very-long-appname-with-many-parts-in-it #{Process.pid.to_s} Prog [meta x-group=\"74901736\" x-counter=\"1\"] Message\n"
+        )
+      end
+    end
   end
 end

data/spec/syslogger_spec.rb

@@ -1,9 +1,28 @@
 describe SysLogger do
-  let(:logger) { SysLogger.new(StringIO.new) }
+  let(:io)     { StringIO.new }
+  let(:logger) { SysLogger.new(io) }
 
   describe '#new' do
     it 'creates a Logger' do
       expect(logger).to be_a SysLogger::Logger
     end
   end
+
+  describe "#appname" do
+    it 'returns nil if appname is nil' do
+      expect(logger.appname).to be_nil
+      logger.info('test')
+      expect(io.string).to match(
+        /<190>1.* #{Socket.gethostname} - #{Process.pid} - \[meta.*/
+      )
+    end
+
+    it 'overrides the appname' do
+      logger.appname = 'an-appname'
+      logger.info('test')
+      expect(io.string).to match(
+        /<190>1.* #{Socket.gethostname} an-appname #{Process.pid} - \[meta.*/
+      )
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syslogger5424
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - EasyPost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-29 00:00:00.000000000 Z
+date: 2019-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mono_logger