vx-lib-logger 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d28721e11382b1f0383f2cf07b19fc9098312b1
-  data.tar.gz: 2d0c3698efe175863557797b011ba0d39c921ec1
+  metadata.gz: 3cd5b9c66ac3665ca6ec8c71115a1a0c92a75a49
+  data.tar.gz: 580fad2cf11354a4f0712482cf3a2074b04b2578
 SHA512:
-  metadata.gz: ca6ce7efc36837cd479a8e54f724063014bba8eeacf66bb6dc26883e23f9e1af18366873292b9ad1632da06099ed869a0fcf58530b11e657fb9e2da004867409
-  data.tar.gz: a8ef47f348bffb01310cb89c80d8a45bda8e0d537c3e0bb01779a304ed733b767895f92219ec7d994a8c57e17ba8a08091e45a9c1d4627cd7e7f166d63e8521e
+  metadata.gz: bdfabb6e1f5ea36ef83d26b3af50c44004174937bbd23a474c26cfb7b9f9d3c4422fe51d6182f7170e86d4803ae3f03e72719a1e545bd29bd6816e419b8f741a
+  data.tar.gz: f9610c3f29159002a469e8ab2edd16ca5fed2326bea24ed7f28cfdd52c579ed088fd5f8731c709b5ea5d46c1eb07266f1c2f1b283ee98b6a93876c66a8169138

data/lib/vx/lib/logger.rb

@@ -5,17 +5,20 @@ module Vx ; module Lib
   module Logger
 
     autoload :Instance,         File.expand_path("../logger/instance",          __FILE__)
-    autoload :JsonFormatter,    File.expand_path("../logger/json_formatter",    __FILE__)
-    autoload :RawFormatter,     File.expand_path("../logger/raw_formatter",     __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__)
 
     module Rack
       autoload :HandleExceptions, File.expand_path("../logger/rack/handle_exceptions", __FILE__)
     end
 
-    @@default = Instance.new(STDOUT)
+    @@logstash = Logstash.new
+    @@default  = Instance.new(STDOUT, logstash: @@logstash)
 
     def self.get(io = nil, options = {})
-      Instance.new(io || STDOUT, options)
+      Instance.new(io || STDOUT, options.merge(logstash: @@logstash))
     end
 
     def self.default

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

@@ -1,16 +1,33 @@
 require 'json'
 require 'thread'
+require 'socket'
 
 module Vx ; module Lib ; module Logger
 
   class Instance
 
-    attr_reader :params, :logger
+    attr_reader :params, :logger, :logstash
 
     def initialize(io, params = {})
-      @params           = 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 = RawFormatter.new
+      @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|
@@ -32,7 +49,7 @@ module Vx ; module Lib ; module Logger
     end
 
     def progname=(new_val)
-      params[:progname] = new_val
+      @progname = new_val
     end
 
     def handle(message, options = {})
@@ -64,29 +81,44 @@ module Vx ; module Lib ; module Logger
       def process_message(level, message, options = {})
 
         if options[:exception] && options[:exception].is_a?(Exception)
-          ex = options[:exception]
+          ex = options.delete(:exception)
           options.merge!(
-            exception:   [ex.class.to_s, ex.message],
+            exception:   [ex.class.to_s, ex.message].join(" - "),
             backtrace:   (ex.backtrace || []).map(&:to_s).join("\n"),
           )
         end
 
         body = {
           thread_id:  ::Thread.current.object_id,
-          process_id: ::Process.pid,
         }
 
         if options && options != {}
+
+          duration = options.delete(:duration)
+          if duration && duration.respond_to?(:to_f)
+            body.merge!(duration: duration.to_f)
+          end
+
           body.merge!(
-            fields: options
+            fields: Sanitizer.hash(options)
           )
         end
 
-        @logger.public_send level, format_message(message, body)
+
+        @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_message(message, payload)
-        JsonFormatter.call(message, payload)
+      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

data/lib/vx/lib/logger/journal_formatter.rb

@@ -0,0 +1,31 @@
+require 'oj'
+
+module Vx ; module Lib ; module Logger
+
+  module JournalFormatter
+
+    @@exe   = $PROGRAM_NAME
+    @@gid   = ::Process.gid
+    @@uid   = ::Process.uid
+    @@pid   = ::Process.pid
+    @@host  = ::Socket.gethostname
+
+    def self.call(level, progname, message, payload)
+      m = ::Oj.dump(
+        payload.merge(
+          MESSAGE:           message.to_s,
+          SYSLOG_IDENTIFIER: progname,
+          _EXE:              @@exe,
+          _GID:              @@gid,
+          _UID:              @@uid,
+          _PID:              @@pid,
+          _HOSTNAME:         @@host,
+          level:             level,
+        ),
+        mode: :compat
+      )
+      m.encode("UTF-8", invalid: :replace, replace: "?") << "\n"
+    end
+  end
+
+end ; end ; end

data/lib/vx/lib/logger/logstash.rb

@@ -0,0 +1,87 @@
+require 'socket'
+require 'uri'
+require 'thread'
+
+module Vx ; module Lib ; module Logger
+
+  class Logstash
+
+    def initialize
+      @mutex = Mutex.new
+    end
+
+    def uri
+      @uri ||= begin
+        h = ENV['LOGSTASH_HOST']
+        URI("logstash://#{h}") if h
+      end
+    end
+
+    def enabled?
+      !!uri
+    end
+
+    def connected?
+      !!@io
+    end
+
+    def close
+      @io && @io.close
+    rescue Exception => e
+      warn "#{self.class} - #{e.class} - #{e.message}"
+    ensure
+      @io = nil
+    end
+
+    def write(message)
+      if enabled?
+        @mutex.synchronize do
+          with_connection do
+            @io.write message
+          end
+        end
+      end
+    end
+
+    def flush
+      @io && @io.flush
+    end
+
+    private
+
+      def host
+        uri.host
+      end
+
+      def port
+        @port ||= uri.port || 514
+      end
+
+      def warn(msg)
+        $stderr.puts msg
+      end
+
+      def with_connection(&block)
+        connect unless connected?
+        yield
+      rescue Exception => e
+        warn "#{self.class} - #{e.class} - #{e.message}"
+        close
+        @io = nil
+      end
+
+      def reconnect
+        @io = nil
+        connect
+      end
+
+      def connect
+        @io = TCPSocket.new(host, port).tap do |socket|
+          warn "#{self.class} - connect to #{uri.to_s}"
+          socket.sync = true
+        end
+      end
+
+  end
+
+end ; end ; end

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

@@ -0,0 +1,20 @@
+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
+
+end ; end ; end

data/lib/vx/lib/logger/{json_formatter.rb → stdout_formatter.rb}

@@ -2,11 +2,11 @@ require 'oj'
 
 module Vx ; module Lib ; module Logger
 
-  module JsonFormatter
+  module StdoutFormatter
 
-    def self.call(message, payload)
+    def self.call(level, message, payload)
       payload = ::Oj.dump(payload, mode: :compat)
-      "#{message} :--: #{payload}"
+      "[#{level}] #{message} :--: #{payload}\n"
     end
 
   end

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

@@ -1,7 +1,7 @@
 module Vx
   module Lib
     module Logger
-      VERSION = "0.1.1"
+      VERSION = "0.2.0"
     end
   end
 end

data/spec/lib/instance_spec.rb

@@ -4,77 +4,91 @@ require 'stringio'
 
 describe Vx::Lib::Logger::Instance do
 
-   before do
-     @out = StringIO.new
-     @log = Vx::Lib::Logger.get(@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.upcase}] send #{m} :--: {\"thread_id\":#{tid},\"process_id\":#{pid}}\n"
-       assert_equal get_out, text
-     end
-   end
-
-   it "should write message with params" do
-     @log.info "text message", param: :value
-     text = "[INFO] text message :--: {\"thread_id\":#{tid},\"process_id\":#{pid},\"fields\":{\"param\":\"value\"}}\n"
-     assert_equal get_out, text
-   end
-
-   it "should write message with object in params" do
-     @log.info "text message", param: self
-     assert get_out
-   end
-
-   it "should write message with exception in params" do
-     @log.info "text message", exception: Exception.new("got!")
-     text = "[INFO] text message :--: {\"thread_id\":#{tid},\"process_id\":#{pid},\"fields\":{\"exception\":[\"Exception\",\"got!\"],\"backtrace\":\"\"}}\n"
-     assert_equal get_out, text
-   end
-
-   it "should handle block" do
-     @log.handle "text message" do
-       sleep 0.1
-     end
-     assert_match(/duration/, get_out)
-
-     begin
-       @log.handle "text message", key: :value do
-         raise 'got!'
-       end
-     rescue Exception
-     end
-
-     body = get_out
-     assert_match(/duration/, body)
-     assert_match(/key/, body)
-     assert_match(/value/, body)
-     assert_match(/got\!/, body)
-     assert_match(/backtrace/, body)
-   end
-
-   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},\"process_id\":#{pid},\"fields\":{\"key\":\"Le Café \xA9\"}}\n"
-     assert_equal get_out, text
-   end
-
-   def get_out
-     @out.rewind
-     body = @out.read
-     @out.rewind
-     body
-   end
-
-   def tid
-     Thread.current.object_id
-   end
-
-   def pid
-     Process.pid
-   end
+  before do
+    @out = StringIO.new
+    @log = Vx::Lib::Logger.get(@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"
+      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"
+    assert_equal text, get_out
+  end
+
+  it "should write message with object in params" do
+    @log.info "object message", param: Exception.new("foo")
+    assert get_out
+  end
+
+  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"
+    assert_equal text, get_out
+  end
+
+  it "should handle block" do
+    @log.handle "text message" do
+      sleep 0.1
+    end
+    assert_match(/duration/, get_out)
+
+    begin
+      @log.handle "text message", key: :value do
+        raise 'got!'
+      end
+    rescue Exception
+    end
+
+    body = get_out
+    assert_match(/duration/, body)
+    assert_match(/key/, body)
+    assert_match(/value/, body)
+    assert_match(/got\!/, body)
+    assert_match(/backtrace/, body)
+  end
+
+  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"
+    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
+    @out.rewind
+    body
+  end
+
+  def tid
+    Thread.current.object_id
+  end
+
+  def pid
+    Process.pid
+  end
 
 end

data/spec/lib/logstash_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Vx::Lib::Logger::Logstash do
+
+  before do
+    ENV['LOGSTASH_HOST'] = 'localhost:9999'
+  end
+
+  after do
+    ENV['LOGSTASH_HOST'] = nil
+  end
+
+  it "should successfuly connect" do
+    re = with_socket do
+      log = Vx::Lib::Logger::Logstash.new
+      log.write("Hello\n")
+      log.close
+    end
+    assert_equal re, "Hello\n"
+  end
+
+  it "should successfuly lost connection" do
+    log = Vx::Lib::Logger::Logstash.new
+
+    re = with_socket do
+      log.write("Hello\n")
+      log.close
+    end
+
+    log.write("Lost\n")
+
+    re << with_socket do
+      log.write("World\n")
+    end
+
+    log.close
+
+    assert_equal re, "Hello\nWorld\n"
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -2,3 +2,25 @@ require File.expand_path("../../lib/vx/lib/logger", __FILE__)
 
 require 'minitest/spec'
 require 'minitest/autorun'
+
+def with_socket
+  out  = ""
+  server = TCPServer.new 9999
+
+  th = Thread.new do
+    loop do
+      client = server.accept
+      out << client.gets
+      client.close
+    end
+  end
+
+  begin
+    yield
+    sleep 0.2
+    out
+  ensure
+    th.kill
+    server.close
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vx-lib-logger
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Dmitry Galinsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2015-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -66,12 +66,15 @@ files:
 - Rakefile
 - lib/vx/lib/logger.rb
 - lib/vx/lib/logger/instance.rb
-- lib/vx/lib/logger/json_formatter.rb
+- lib/vx/lib/logger/journal_formatter.rb
+- lib/vx/lib/logger/logstash.rb
 - lib/vx/lib/logger/rack/handle_exceptions.rb
-- lib/vx/lib/logger/raw_formatter.rb
+- lib/vx/lib/logger/sanitizer.rb
+- lib/vx/lib/logger/stdout_formatter.rb
 - lib/vx/lib/logger/version.rb
 - spec/lib/instance_spec.rb
 - spec/lib/logger_spec.rb
+- spec/lib/logstash_spec.rb
 - spec/lib/rack_handle_exceptions_spec.rb
 - spec/spec_helper.rb
 - vexor.yml
@@ -103,6 +106,6 @@ summary: summary
 test_files:
 - spec/lib/instance_spec.rb
 - spec/lib/logger_spec.rb
+- spec/lib/logstash_spec.rb
 - spec/lib/rack_handle_exceptions_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/lib/vx/lib/logger/raw_formatter.rb

@@ -1,10 +0,0 @@
-module Vx ; module Lib ; module Logger
-
-  RawFormatter = Struct.new(:parent) do
-
-    def call(severity, datetime, progname, msg)
-      "[#{severity}] #{msg.to_s}\n"
-    end
-  end
-
-end ; end ; end