logglier 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c076d61e02f5315d0d32d884c88182f91a2d8530
-  data.tar.gz: 32f4d8efc429ecf94044bd44196e7017e100687f
+  metadata.gz: 1dcb0781ee2e961054577527a6105aa85fd6e02c
+  data.tar.gz: 75437a8852a4b155379c9e9b1876d26ff14e6023
 SHA512:
-  metadata.gz: 0f0cf90945e35b9842247b32e77c624338ae94b78a18e6e8ac942a49cbdb8e85d78b11846fa81e7ea629b67f3874336311318241361f2e76e34e9ad0856c31ef
-  data.tar.gz: 3e4ce0f615faf8c7b4b2e18c896bc39c1c1c1b551de3d0cdcba6f80ac4df98026702f55bb57573a20eb920d7944771ade59e8d4ecff76e9738b5ccbd342a84dd
+  metadata.gz: 92d4f3c3eaf6d65a6670d6f8178988b615df3d838a7223affcaefe88c4c5b2c47c2837a6f3a6f68c98ffd460788468b3438a246fa8ef0fd3212e6ac8e24c4f6a
+  data.tar.gz: 16cced1160ddb78a516b9655ce1bff2d97aeba9c252befe390d1c3f99949bb810bc0a2bdb99f066b88961255daa24f56e6d3dad575c8e5ed90df07c3dd3634da

data/lib/logglier/client.rb

@@ -74,7 +74,14 @@ module Logglier
 
       def massage_message(incoming_message, severity, processid)
         outgoing_message = ""
-        outgoing_message << "pid=#{processid}, severity=#{severity}, "
+
+        # Append PID and severity to message, unless we're a Syslog
+        # client. If we're a Syslog client, that information is already
+        # in the Syslog packet.
+        unless self.is_a?(Logglier::Client::Syslog)
+          outgoing_message << "pid=#{processid}, severity=#{severity}, "
+        end
+
         case incoming_message
         when Hash
           outgoing_message << masher(incoming_message)

data/lib/logglier/client/syslog.rb

@@ -9,7 +9,7 @@ module Logglier
     class Syslog
       include Logglier::Client::InstanceMethods
 
-      attr_reader :input_uri, :facility, :syslog
+      attr_reader :input_uri, :facility, :format, :syslog
 
       def initialize(opts={})
         setup_input_uri(opts)
@@ -35,6 +35,7 @@ module Logglier
           @facility = 16
         end
 
+        @format = opts[:format]
         @hostname = opts[:hostname] || Socket.gethostname.split('.').first
       end
 
@@ -81,12 +82,21 @@ module Logglier
         proc do |severity, datetime, progname, msg|
           processid=Process.pid
           message = "<#{pri(severity)}>#{datetime.strftime(datetime_format)} #{@hostname} "
+
+          # Include process ID in progname/log tag - RFC3164 § 5.3
           if progname
-            message << "#{progname}: "
+            message << "#{progname}[#{processid}]: "
           else
-            message << "#{$0}: "
+            message << "#{$0}[#{processid}]: "
           end
-          message << massage_message(msg,severity,processid)
+
+          # Support logging JSON to Syslog
+          if @format == :json && msg.is_a?(Hash)
+            message << MultiJson.dump(msg)
+          else
+            message << massage_message(msg,severity,processid)
+          end
+
           if @input_uri.scheme == 'tcp'
             message << "\r\n"
           end

data/lib/logglier/version.rb

@@ -1,3 +1,3 @@
 module Logglier
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/spec/client/syslog_spec.rb

@@ -11,4 +11,32 @@ describe Logglier::Client::Syslog do
       client.pri("WARN").should == (17 << 3) + 4
     end
   end
-end
+
+  describe '#formatter' do
+    before do
+      UDPSocket.stub(:new).and_return(mock('socket').as_null_object)
+      TCPSocket.stub(:new).and_return(mock('Socket').as_null_object)
+    end
+
+    let(:client)      { described_class.new(input_url: 'udp://127.0.0.1:514/17') }
+    let(:json_client) { described_class.new(input_url: 'udp://127.0.0.1:514/17', format: :json) }
+
+    it 'includes the PID in the progname' do
+      message = client.formatter.call 'INFO', Time.now, 'banana', 'test message'
+
+      message.should match(/banana\[#{Process.pid}\]: /)
+    end
+
+    context 'when you pass a Hash' do
+      it 'formats as JSON when the format is JSON' do
+        message = json_client.formatter.call 'INFO', Time.now, 'banana', testing_json: true
+        message.should match(/: {"testing_json":true}\z/)
+      end
+
+      it 'formats as a massaged message when the format is not JSON' do
+        message = client.formatter.call 'INFO', Time.now, 'banana', testing_json: false
+        message.should match(/: testing_json=false\z/)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -38,21 +38,35 @@ shared_examples_for "a logglier enhanced Logger instance" do
   context "#add" do
     context "with a string" do
       it "should send a message via the logdev" do
-        subject.logdev.dev.should_receive(:write).with(/severity=WARN, foo/)
+        if subject.logdev.dev.is_a?(Logglier::Client::Syslog)
+          subject.logdev.dev.should_receive(:write).with(/foo/)
+        else
+          subject.logdev.dev.should_receive(:write).with(/severity=WARN, foo/)
+        end
+
         subject.add(Logger::WARN) { 'foo' }
       end
     end
 
     context "with a hash" do
       it "should send a message via the logdev" do
-        subject.logdev.dev.should_receive(:write).with(/severity=WARN/)
-        subject.logdev.dev.should_receive(:write).with(/foo=bar/)
-        subject.logdev.dev.should_receive(:write).with(/man=pants/)
+        # expect count is the number of times we need to
+        # repeat the log message to test all of the possibilities
+        if subject.logdev.dev.is_a?(Logglier::Client::Syslog)
+          expect_count = 2
+        else
+          expect_count = 3
+          subject.logdev.dev.should_receive(:write).with(/severity=WARN/)
+        end
+
+        expect(subject.logdev.dev).to receive(:write).with(/foo=bar/)
+        expect(subject.logdev.dev).to receive(:write).with(/man=pants/)
+
         # The following is equiv to:
         # subject.warn :foo => :bar, :man => :pants
-        subject.add(Logger::WARN) { {:foo => :bar, :man => :pants} }
-        subject.add(Logger::WARN) { {:foo => :bar, :man => :pants} }
-        subject.add(Logger::WARN) { {:foo => :bar, :man => :pants} }
+        expect_count.times do
+          subject.add(Logger::WARN) { {:foo => :bar, :man => :pants} }
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logglier
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Edward Muller (aka freeformz)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-21 00:00:00.000000000 Z
+date: 2015-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json