rumbrl 0.5.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2631d704e0e398c4c16f607f4a57301bac65aba7
-  data.tar.gz: fea322ed8b32b8273a958a4c14db0eae74ed4125
+  metadata.gz: cc82af5529740703aec6e83ed9b4464b81b2fb9f
+  data.tar.gz: f34cac33f367edb3a0831ab58d95cef6d83a05e2
 SHA512:
-  metadata.gz: 09eb688930ff8d487b0ea91f216e977bb46b84a0658d3383b17613fe5e3f0bc356e5c29edbdc8a10749fa7cacbea162011c965dcc4eaebc15709b94f00149ee0
-  data.tar.gz: 72c7635b743c847a58ef7770870251f438406a925edd4aeb2b7aa0a08e70b3ce04ffe968a53c5db8b103fec4146a941ff75b6f97d76af52b725b16a8137ab2b0
+  metadata.gz: f85a35b5aabadcfeef69b3a354e4c4a24f59cfcfe68ae5f891c9f7c6fae6ca91d63ee0af9f1bdb1dfe4574f221b22d48551ef06fc429f10f41b264d82435d2d1
+  data.tar.gz: 8f7bca73de095dd2fe4203410d5150ae20ee0929a4b0371b387303807249044c9fdd5137e5b922ae1c3fe0186e9e7adeba2b12d91b4052972144ab5a3d7c7f5c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rumbrl (0.5.1)
+    rumbrl (1.0.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/rumbrl.rb

@@ -5,5 +5,8 @@ require 'rumbrl/factory'
 require 'rumbrl/formatter'
 require 'rumbrl/grumble'
 require 'rumbrl/grumble_factory'
+require 'rumbrl/kv'
 require 'rumbrl/log'
+require 'rumbrl/logger'
 require 'rumbrl/smash'
+require 'rumbrl/sumologic'

data/lib/rumbrl/formatter.rb

@@ -4,10 +4,10 @@ require 'rumbrl/smash'
 module Rumbrl
   # Log4r formatter
   class Formatter < ::Logger::Formatter
-    def call(severity, _timestamp, prog, msg)
+    def call(_severity, _timestamp, _prog, msg)
       return '' if omit_empty? && empty?(msg)
 
-      "APP_NAME=#{appname(prog)} SEVERITY=#{severity} #{format_msg(msg)}\n"
+      "#{format_msg(msg)}\n"
     end
 
     def omit_empty(switch)
@@ -32,14 +32,5 @@ module Rumbrl
     def empty?(obj)
       obj.respond_to?(:empty?) && obj.empty?
     end
-
-    def app_namespace
-      ENV.fetch('LOG_APP_NAME', 'RubyApplication')
-    end
-
-    def appname(progname)
-      progname = (progname.nil? || progname.strip.empty?) ? '' : progname.strip
-      (progname.empty?) ? app_namespace : "#{app_namespace}::#{progname}"
-    end
   end
 end

data/lib/rumbrl/kv.rb

@@ -0,0 +1,2 @@
+require 'rumbrl/kv/formatter'
+require 'rumbrl/kv/logger'

data/lib/rumbrl/kv/formatter.rb

@@ -0,0 +1,26 @@
+require 'rumbrl/formatter'
+require 'rumbrl/smash'
+
+module Rumbrl
+  # Rumbrl KV module
+  module KV
+    # Log4r formatter that turns hashable objects into KV log entries
+    class Formatter < ::Rumbrl::Formatter
+      def format_msg(msg)
+        return "MESSAGE='#{super}'" unless msg.is_a?(Hash)
+
+        format_data ::Rumbrl::Smash.flatten(msg)
+      end
+
+      private
+
+      def format_data(data)
+        entry = ''
+        data.each do |k, v|
+          entry += " #{k.to_s.upcase}='#{v.to_s.gsub("'", '"')}'"
+        end
+        entry.strip
+      end
+    end
+  end
+end

data/lib/rumbrl/kv/logger.rb

@@ -0,0 +1,14 @@
+require 'logger'
+
+module Rumbrl
+  # Rumbrl KV module
+  module KV
+    # Log4r logger that uses the KV formatter
+    class Logger < ::Logger
+      def initialize(*args)
+        super
+        @formatter = ::Rumbrl::KV::Formatter.new
+      end
+    end
+  end
+end

data/lib/rumbrl/logger.rb

@@ -0,0 +1,11 @@
+require 'logger'
+
+module Rumbrl
+  # Default logger that uses Rumbrl::Formatter
+  class Logger < ::Logger
+    def initialize(*args)
+      super
+      @formatter = Formatter.new
+    end
+  end
+end

data/lib/rumbrl/sumologic.rb

@@ -0,0 +1,2 @@
+require 'rumbrl/sumologic/formatter'
+require 'rumbrl/sumologic/logger'

data/lib/rumbrl/sumologic/formatter.rb

@@ -0,0 +1,34 @@
+require 'rumbrl/kv/formatter'
+
+module Rumbrl
+  # Rumbrl Sumologic module
+  module Sumologic
+    # Log4r formatter that turns hashable objects into KV log entries
+    # with some decorations specifically for sumologic
+    class Formatter < ::Rumbrl::KV::Formatter
+      def call(severity, timestamp, prg, msg)
+        return super if empty?(msg)
+
+        format_entry appname(prg), severity, timestamp, format_msg(msg)
+      end
+
+      private
+
+      def format_entry(app, sev, time, msg)
+        format(
+          "APP_NAME='%s' SEVERITY='%s' TIMESTAMP='%s' %s\n",
+          app, sev, time, msg
+        )
+      end
+
+      def app_namespace
+        ENV.fetch('LOG_APP_NAME', 'RubyApplication')
+      end
+
+      def appname(prog)
+        prog = (prog.nil? || prog.strip.empty?) ? '' : prog.strip
+        (prog.empty?) ? app_namespace : "#{app_namespace}::#{prog}"
+      end
+    end
+  end
+end

data/lib/rumbrl/sumologic/logger.rb

@@ -0,0 +1,14 @@
+require 'logger'
+
+module Rumbrl
+  # Rumbrl Sumologic module
+  module Sumologic
+    # Log4r logger that uses the KV formatter
+    class Logger < ::Logger
+      def initialize(*args)
+        super
+        @formatter = ::Rumbrl::Sumologic::Formatter.new
+      end
+    end
+  end
+end

data/lib/rumbrl/version.rb

@@ -2,5 +2,5 @@
 
 # version const for gem
 module Rumbrl
-  VERSION = '0.5.1'
+  VERSION = '1.0.0'
 end

data/spec/rumbrl/formatter_spec.rb

@@ -3,10 +3,6 @@ require_relative '../spec_helper'
 describe Rumbrl::Formatter do
   let(:formatter) { Rumbrl::Formatter.new }
 
-  before :each do
-    allow(ENV).to receive(:fetch).and_return 'SPECDEFAULT'
-  end
-
   describe '#omit_empty?' do
     it 'defaults to true' do
       expect(formatter.omit_empty?).to be true
@@ -47,7 +43,7 @@ describe Rumbrl::Formatter do
 
       context 'and msg is a string' do
         it 'it returns a formatted string' do
-          expected = "APP_NAME=SPECDEFAULT::SPECS SEVERITY=INFO stuff\n"
+          expected = "stuff\n"
           res = formatter.call('INFO', nil, 'SPECS', 'stuff')
 
           expect(res).to eq expected

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rumbrl
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 1.0.0
 platform: ruby
 authors:
 - chr0n1x
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-07 00:00:00.000000000 Z
+date: 2015-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -100,8 +100,15 @@ files:
 - lib/rumbrl/formatter.rb
 - lib/rumbrl/grumble.rb
 - lib/rumbrl/grumble_factory.rb
+- lib/rumbrl/kv.rb
+- lib/rumbrl/kv/formatter.rb
+- lib/rumbrl/kv/logger.rb
 - lib/rumbrl/log.rb
+- lib/rumbrl/logger.rb
 - lib/rumbrl/smash.rb
+- lib/rumbrl/sumologic.rb
+- lib/rumbrl/sumologic/formatter.rb
+- lib/rumbrl/sumologic/logger.rb
 - lib/rumbrl/version.rb
 - rumbrl.gemspec
 - spec/rumbrl/factory_spec.rb