vx-lib-logger 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3126654f08b375c07b2f7ee34c7b00fcc5f18925
-  data.tar.gz: a61a2a2730ac7978a294156fdf286e79c3191b4f
+  metadata.gz: 64c86508190e0c1df39d9df46c9a0914c4494b14
+  data.tar.gz: 67a98127683d996e8f4eae7412ef93871b40bdab
 SHA512:
-  metadata.gz: 5473e79262d2851f91cb2c07711d6320f8e9a450ec7a1e98f27a3d661059be1d332d2ec8ad777342ea0ce7591dc1e820694ac05f95071c9c05cd7e961906cbad
-  data.tar.gz: bba481584c45077e8563fecb3112b4bee9ea1118b7d38576d76db658b484ecdafdd75208c2f994860eb1cf2b7687417fa138cf3f91f6402c8ed3778eafa17e93
+  metadata.gz: 0ac21b0568bc6111366d950189fde48ff664f03b7e5c154f041ec25c1d15d54a40bd7c7a26e081f61f9b01fff3c6d7c60a62b25d8f671980edf74e870c1c756f
+  data.tar.gz: 983a53898174f7446157eca899a6c997b1a6c4ffde45f34a4bfae3db7adb3a671a95859a8efba04b595238a7544dfd7597e47ff0bf74e8c23105f6330715f57f

data/lib/vx/lib/logger.rb

@@ -4,25 +4,41 @@ require File.expand_path("../logger/version", __FILE__)
 module Vx ; module Lib
   module Logger
 
-    autoload :Instance,         File.expand_path("../logger/instance",          __FILE__)
+    autoload :LogstashDevice,   File.expand_path("../logger/logstash_device",   __FILE__)
     autoload :StdoutFormatter,  File.expand_path("../logger/stdout_formatter",  __FILE__)
-    autoload :JournalFormatter, File.expand_path("../logger/journal_formatter", __FILE__)
-    autoload :Logstash,         File.expand_path("../logger/logstash",          __FILE__)
-    autoload :Sanitizer,        File.expand_path("../logger/sanitizer",         __FILE__)
+    autoload :LogstashFormatter,File.expand_path("../logger/logstash_formatter",__FILE__)
+    autoload :BaseLogger,       File.expand_path("../logger/base_logger",       __FILE__)
+    autoload :StdoutLogger,     File.expand_path("../logger/stdout_logger",     __FILE__)
+    autoload :LogstashLogger,   File.expand_path("../logger/logstash_logger",   __FILE__)
 
     module Rack
       autoload :HandleExceptions, File.expand_path("../logger/rack/handle_exceptions", __FILE__)
     end
 
-    @@logstash = Logstash.new
-    @@default  = Instance.new(STDOUT, logstash: @@logstash)
+    @@progname        = $0 && File.basename($0)
+    @@default         = nil
+    @@logstash_device = nil
 
-    def self.get(io = nil, options = {})
-      Instance.new(io || STDOUT, options.merge(logstash: @@logstash))
+    def self.progname=(value)
+      @@progname = value
     end
 
-    def self.default
-      @@default
+    def self.progname
+      @@progname
+    end
+
+    def self.logstash_device
+      @@logstash_device ||= LogstashDevice.new
+    end
+
+    def self.get
+      @@default ||= begin
+        if logstash_device.enabled?
+          LogstashLogger.new
+        else
+          StdoutLogger.new(STDOUT)
+        end
+      end
     end
 
     def self.install_handle_exceptions_middleware

data/lib/vx/lib/logger/base_logger.rb

@@ -0,0 +1,111 @@
+module Vx ; module Lib ; module Logger
+
+  class BaseLogger
+
+    def formatter
+      @formatter ||= ->(_,_,_,m) { m }
+    end
+
+    def formatter=(val) ; end
+
+    def progname
+      Lib::Logger.progname
+    end
+
+    def progname=(val)
+      Lib::Logger.progname = val
+    end
+
+    def level
+      @logger.level
+    end
+
+    def level=(new_val)
+      @logger.level = new_val
+    end
+
+    [:fatal, :warn, :debug, :error, :info].each do |m|
+      define_method m do |*args|
+        process_message(m, *args)
+      end
+
+      define_method :"#{m}?" do
+        @logger.public_send :"#{m}?"
+      end
+    end
+
+    def handle(message, options = {})
+      be = Time.now.to_f
+      re = nil
+      ex = nil
+
+      begin
+        re = yield options
+      rescue Exception => e
+        ex = e
+      end
+
+      en = Time.now.to_f
+      options.merge!(duration: (en - be))
+
+      if ex
+        error message, options.merge!(exception: ex) if ex
+        raise ex
+      else
+        info message, options
+      end
+
+      re
+    end
+
+    private
+
+      def process_message(level, message, fields = {})
+
+        if fields[:exception] && fields[:exception].is_a?(Exception)
+          ex = fields.delete(:exception)
+          fields.merge!(
+            exception:   [ex.class.to_s, ex.message].join(" - "),
+            backtrace:   (ex.backtrace || []).map(&:to_s).join("\n"),
+          )
+        end
+
+        payload = {
+          thread_id: ::Thread.current.object_id,
+        }
+
+        if fields && fields != {}
+
+          duration = fields.delete(:duration)
+          if duration && duration.respond_to?(:to_f)
+            payload.merge!(duration: duration.to_f)
+          end
+
+          payload.merge!(
+            fields: sanitize_hash(fields)
+          )
+        end
+
+        @logger.public_send level, format_message(level, message, payload)
+      end
+
+      def sanitize_hash(payload)
+        payload = {} unless payload.is_a?(Hash)
+
+        payload.keys.each do |key_name|
+          value = payload[key_name]
+          unless value.is_a?(String)
+            payload[key_name] = value.to_s
+          end
+        end
+
+        payload
+      end
+
+      def format_message(level, message, payload)
+        raise NotImplementedError
+      end
+
+  end
+
+end ; end ; end

data/lib/vx/lib/logger/{logstash.rb → logstash_device.rb}

@@ -4,7 +4,7 @@ require 'thread'
 
 module Vx ; module Lib ; module Logger
 
-  class Logstash
+  class LogstashDevice
 
     def initialize
       @mutex = Mutex.new
@@ -58,7 +58,7 @@ module Vx ; module Lib ; module Logger
       end
 
       def warn(msg)
-        $stderr.puts msg
+        $stderr.puts "[warn ] #{msg}"
       end
 
       def with_connection(&block)
@@ -77,7 +77,6 @@ module Vx ; module Lib ; module Logger
 
       def connect
         @io = TCPSocket.new(host, port).tap do |socket|
-          warn "#{self.class} - connect to #{uri.to_s}"
           socket.sync = true
         end
       end

data/lib/vx/lib/logger/{journal_formatter.rb → logstash_formatter.rb}

@@ -2,7 +2,7 @@ require 'oj'
 
 module Vx ; module Lib ; module Logger
 
-  module JournalFormatter
+  module LogstashFormatter
 
     @@exe   = $PROGRAM_NAME
     @@gid   = ::Process.gid

data/lib/vx/lib/logger/logstash_logger.rb

@@ -0,0 +1,35 @@
+require 'json'
+require 'thread'
+require 'socket'
+
+module Vx ; module Lib ; module Logger
+
+  class LogstashLogger < BaseLogger
+
+    attr_reader :params, :logger, :logstash
+
+    def initialize(params = {})
+      @params = params
+
+      @logger  = ::Logger.new(logstash_device)
+      @logger.formatter = self.formatter
+      @logger.progname  = self.progname
+    end
+
+    def close
+      logstash_device.close
+    end
+
+    private
+
+      def logstash_device
+        Lib::Logger.logstash_device
+      end
+
+      def format_message(level, message, payload)
+        LogstashFormatter.call(level, progname, message, payload)
+      end
+
+  end
+
+end ; end ; end

data/lib/vx/lib/logger/rack/handle_exceptions.rb

@@ -16,7 +16,7 @@ module Vx ; module Lib ; module Logger
 
       def notify(exception, env)
         unless ignore?(exception)
-          Lib::Logger.default.fatal(
+          Lib::Logger.get.fatal(
             "Unhandled exception: #{exception.class} - #{exception.message}",
             clean_env(env).merge(exception: exception)
           )

data/lib/vx/lib/logger/sanitizer.rb

@@ -2,18 +2,6 @@ module Vx ; module Lib ; module Logger
 
   module Sanitizer
 
-    def self.hash(payload)
-      payload = {} unless payload.is_a?(Hash)
-
-      payload.keys.each do |key_name|
-        value = payload[key_name]
-        unless value.is_a?(String)
-          payload[key_name] = value.to_s
-        end
-      end
-
-      payload
-    end
 
   end
 

data/lib/vx/lib/logger/stdout_formatter.rb

@@ -5,8 +5,17 @@ module Vx ; module Lib ; module Logger
   module StdoutFormatter
 
     def self.call(level, message, payload)
-      payload = ::Oj.dump(payload, mode: :compat)
-      "[#{level}] #{message} :--: #{payload}\n"
+      if payload[:fields] && payload[:fields] != {}
+        payload = " " + ::Oj.dump(payload[:fields], mode: :compat)
+      else
+        payload = ""
+      end
+
+      if level.length < 5
+        level = "#{level} "
+      end
+
+      "[#{level}] #{message}#{payload}\n"
     end
 
   end

data/lib/vx/lib/logger/stdout_logger.rb

@@ -0,0 +1,27 @@
+require 'json'
+require 'thread'
+require 'socket'
+
+module Vx ; module Lib ; module Logger
+
+  class StdoutLogger < BaseLogger
+
+    attr_reader :params, :logger, :logstash
+
+    def initialize(io, params = {})
+      @params = params
+
+      @logger           = ::Logger.new(io, 7, 50_000_000)
+      @logger.formatter = self.formatter
+      @logger.progname  = self.progname
+    end
+
+    private
+
+      def format_message(level, message, payload)
+        StdoutFormatter.call(level, message, payload)
+      end
+
+  end
+
+end ; end ; end

data/lib/vx/lib/logger/version.rb

@@ -1,7 +1,7 @@
 module Vx
   module Lib
     module Logger
-      VERSION = "0.2.2"
+      VERSION = "0.3.0"
     end
   end
 end

data/spec/lib/logger_spec.rb

@@ -1,14 +1,9 @@
 require 'spec_helper'
 
 describe Vx::Lib::Logger do
-  it "should get a new instance" do
+  it "should get a new instance of stdout logger" do
     inst = Vx::Lib::Logger.get
     assert inst
   end
 
-  it "should get default instance" do
-    inst = Vx::Lib::Logger.default
-    assert inst
-  end
-
 end

data/spec/lib/{logstash_spec.rb → logstash_device_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Vx::Lib::Logger::Logstash do
+describe Vx::Lib::Logger::LogstashDevice do
 
   before do
     ENV['LOGSTASH_HOST'] = 'localhost:9999'
@@ -12,7 +12,7 @@ describe Vx::Lib::Logger::Logstash do
 
   it "should successfuly connect" do
     re = with_socket do
-      log = Vx::Lib::Logger::Logstash.new
+      log = Vx::Lib::Logger::LogstashDevice.new
       log.write("Hello\n")
       log.close
     end
@@ -20,7 +20,7 @@ describe Vx::Lib::Logger::Logstash do
   end
 
   it "should successfuly lost connection" do
-    log = Vx::Lib::Logger::Logstash.new
+    log = Vx::Lib::Logger::LogstashDevice.new
 
     re = with_socket do
       log.write("Hello\n")

data/spec/lib/logstash_logger_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Vx::Lib::Logger::LogstashLogger do
+
+  before do
+    ENV['LOGSTASH_HOST'] = 'localhost:9999'
+
+    @log = Vx::Lib::Logger::LogstashLogger.new
+    assert @log
+  end
+
+  after do
+    ENV['LOGSTASH_HOST'] = nil
+  end
+
+  [:fatal, :warn, :debug, :error, :info].each do |m|
+    it "should write #{m} message" do
+      re = with_socket do
+        @log.public_send(m, "send #{m}")
+        @log.close
+      end
+      assert_match(/send #{m}/, re)
+    end
+  end
+
+  it "should write message with params" do
+    re = with_socket do
+      @log.info "text message", param: :value
+      @log.close
+    end
+    assert_match(/text message/, re)
+    assert_match(/"param":/, re)
+    assert_match(/:"value"/, re)
+  end
+
+  it "should write message with exception in params" do
+    re = with_socket do
+      @log.info "text message", exception: Exception.new("got!")
+      @log.close
+    end
+    assert_match(/text message/, re)
+    assert_match(/"exception":/, re)
+    assert_match(/:"Exception - got!"/, re)
+  end
+
+  it "should dump invalid unicode key" do
+    re = with_socket do
+      @log.info "Le Caf\xc3\xa9 \xa9", key: "Le Caf\xc3\xa9 \xa9"
+      @log.close
+    end
+    assert_match(/Le Caf/, re)
+  end
+
+end

data/spec/lib/{instance_spec.rb → stdout_logger_spec.rb}

@@ -2,25 +2,26 @@ require 'spec_helper'
 
 require 'stringio'
 
-describe Vx::Lib::Logger::Instance do
+describe Vx::Lib::Logger::StdoutLogger do
 
   before do
     @out = StringIO.new
-    @log = Vx::Lib::Logger.get(@out)
+    @log = Vx::Lib::Logger::StdoutLogger.new(@out)
     assert @log
   end
 
   [:fatal, :warn, :debug, :error, :info].each do |m|
     it "should write #{m} message" do
       @log.public_send(m, "send #{m}")
-      text = "[#{m}] send #{m} :--: {\"thread_id\":#{tid}}\n"
+      level = m.length < 5 ? "#{m} " : m
+      text = "[#{level}] send #{m}\n"
       assert_equal text, get_out
     end
   end
 
   it "should write message with params" do
     @log.info "text message", param: :value
-    text = "[info] text message :--: {\"thread_id\":#{tid},\"fields\":{\"param\":\"value\"}}\n"
+    text = "[info ] text message {\"param\":\"value\"}\n"
     assert_equal text, get_out
   end
 
@@ -31,7 +32,7 @@ describe Vx::Lib::Logger::Instance do
 
   it "should write message with exception in params" do
     @log.info "text message", exception: Exception.new("got!")
-    text = "[info] text message :--: {\"thread_id\":#{tid},\"fields\":{\"exception\":\"Exception - got!\",\"backtrace\":\"\"}}\n"
+    text = "[info ] text message {\"exception\":\"Exception - got!\",\"backtrace\":\"\"}\n"
     assert_equal text, get_out
   end
 
@@ -39,7 +40,7 @@ describe Vx::Lib::Logger::Instance do
     @log.handle "text message" do
       sleep 0.1
     end
-    assert_match(/duration/, get_out)
+    assert_match(/text message/, get_out)
 
     begin
       @log.handle "text message", key: :value do
@@ -49,7 +50,6 @@ describe Vx::Lib::Logger::Instance do
     end
 
     body = get_out
-    assert_match(/duration/, body)
     assert_match(/key/, body)
     assert_match(/value/, body)
     assert_match(/got\!/, body)
@@ -58,24 +58,10 @@ describe Vx::Lib::Logger::Instance do
 
   it "should dump invalid unicode key" do
     @log.info "Le Caf\xc3\xa9 \xa9", key: "Le Caf\xc3\xa9 \xa9"
-    text = "[info] Le Café \xA9 :--: {\"thread_id\":#{tid},\"fields\":{\"key\":\"Le Café \xA9\"}}\n"
+    text = "[info ] Le Café \xA9 {\"key\":\"Le Café \xA9\"}\n"
     assert_equal text, get_out
   end
 
-  it "should write message with logstash" do
-    begin
-      ENV['LOGSTASH_HOST'] = 'localhost:9999'
-      log = Vx::Lib::Logger.get(@out)
-      re = with_socket do
-        log.info "Hello"
-      end
-      assert_match(/Hello/, re)
-      assert_match(/Hello/, get_out)
-    ensure
-      ENV['LOGSTASH_HOST'] = nil
-    end
-  end
-
   def get_out
     @out.rewind
     body = @out.read

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vx-lib-logger
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Dmitry Galinsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-04 00:00:00.000000000 Z
+date: 2015-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -65,17 +65,20 @@ files:
 - README.md
 - Rakefile
 - lib/vx/lib/logger.rb
-- lib/vx/lib/logger/instance.rb
-- lib/vx/lib/logger/journal_formatter.rb
-- lib/vx/lib/logger/logstash.rb
+- lib/vx/lib/logger/base_logger.rb
+- lib/vx/lib/logger/logstash_device.rb
+- lib/vx/lib/logger/logstash_formatter.rb
+- lib/vx/lib/logger/logstash_logger.rb
 - lib/vx/lib/logger/rack/handle_exceptions.rb
 - lib/vx/lib/logger/sanitizer.rb
 - lib/vx/lib/logger/stdout_formatter.rb
+- lib/vx/lib/logger/stdout_logger.rb
 - lib/vx/lib/logger/version.rb
-- spec/lib/instance_spec.rb
 - spec/lib/logger_spec.rb
-- spec/lib/logstash_spec.rb
+- spec/lib/logstash_device_spec.rb
+- spec/lib/logstash_logger_spec.rb
 - spec/lib/rack_handle_exceptions_spec.rb
+- spec/lib/stdout_logger_spec.rb
 - spec/spec_helper.rb
 - vexor.yml
 - vx-lib-logger.gemspec
@@ -104,8 +107,9 @@ signing_key:
 specification_version: 4
 summary: summary
 test_files:
-- spec/lib/instance_spec.rb
 - spec/lib/logger_spec.rb
-- spec/lib/logstash_spec.rb
+- spec/lib/logstash_device_spec.rb
+- spec/lib/logstash_logger_spec.rb
 - spec/lib/rack_handle_exceptions_spec.rb
+- spec/lib/stdout_logger_spec.rb
 - spec/spec_helper.rb

data/lib/vx/lib/logger/instance.rb

@@ -1,134 +0,0 @@
-require 'json'
-require 'thread'
-require 'socket'
-
-module Vx ; module Lib ; module Logger
-
-  class Instance
-
-    attr_reader :params, :logger, :logstash
-
-    def initialize(io, params = {})
-      @logstash = params.delete(:logstash)
-      @params   = params
-
-      @progname = @params.delete(:progname)
-
-      @progname ||= begin
-        pname = $PROGRAM_NAME
-        pname && File.basename(pname)
-      end
-
-      @formatter = ->(_,_,_,m) { m }
-
-      @logger           = ::Logger.new(io, 7, 50_000_000)
-      @logger.formatter = @formatter
-      @logger.progname  = @progname
-
-      @logstash_logger  = ::Logger.new(logstash)
-      @logstash_logger.formatter = @formatter
-      @logstash_logger.progname  = @progname
-    end
-
-    [:fatal, :warn, :debug, :error, :info].each do |m|
-      define_method m do |*args|
-        process_message(m, *args)
-      end
-
-      define_method :"#{m}?" do
-        @logger.public_send :"#{m}?"
-      end
-    end
-
-    def level
-      @logger.level
-    end
-
-    def level=(new_val)
-      @logger.level = new_val
-      @logstash_logger.level = new_val
-    end
-
-    def progname=(new_val)
-      @progname = new_val
-    end
-
-    def formatter ; nil ; end
-    def formatter=(val) ; nil ; end
-
-    def handle(message, options = {})
-      be = Time.now.to_f
-      re = nil
-      ex = nil
-
-      begin
-        re = yield options
-      rescue Exception => e
-        ex = e
-      end
-
-      en = Time.now.to_f
-      options.merge!(duration: (en - be))
-
-      if ex
-        error message, options.merge!(exception: ex) if ex
-        raise ex
-      else
-        info message, options
-      end
-
-      re
-    end
-
-    private
-
-      def process_message(level, message, options = {})
-
-        if level.to_s == 'fatal'
-          puts caller.inspect
-        end
-
-        if options[:exception] && options[:exception].is_a?(Exception)
-          ex = options.delete(:exception)
-          options.merge!(
-            exception:   [ex.class.to_s, ex.message].join(" - "),
-            backtrace:   (ex.backtrace || []).map(&:to_s).join("\n"),
-          )
-        end
-
-        body = {
-          thread_id:  ::Thread.current.object_id,
-        }
-
-        if options && options != {}
-
-          duration = options.delete(:duration)
-          if duration && duration.respond_to?(:to_f)
-            body.merge!(duration: duration.to_f)
-          end
-
-          body.merge!(
-            fields: Sanitizer.hash(options)
-          )
-        end
-
-
-        @logger.public_send level, format_stdout(level, message, body)
-
-        if logstash.enabled?
-          @logstash_logger.public_send level, format_journal(level, message, body)
-        end
-      end
-
-      def format_stdout(level, message, payload)
-        StdoutFormatter.call(level, message, payload)
-      end
-
-      def format_journal(level, message, payload)
-        JournalFormatter.call(level, @progname, message, payload)
-
-      end
-
-  end
-
-end ; end ; end