la_logger 0.0.2 → 0.1.0

data/README.md

@@ -4,12 +4,13 @@ Require: ruby 1.9.x, fluent-logger (not working on JRuby without modification).
 
 ## Concepts
 
-- Initialize a logger object with `label` and log level:
+- Initialize a logger object with `tag` (which becomings collection name for `tag_mapped`
+  setting in `fluent.conf`) and log level:
 
     class LoggerUser
       def logger
         # initialize tag and log level, default level is 'WARN'
-        LaLogger.new('la.logger.tag', LaLogger::ERROR)
+        LaLogger.new('specific_tag', LaLogger::ERROR)
       end
 
       def logger_this

data/benchmark/singleton.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'benchmark'
 
 require 'fluent-logger'
@@ -11,17 +12,17 @@ Benchmark.bm do |x|
   x.report('FluentLogger.new') do
     n.times do
       Fluent::Logger::FluentLogger.new(
-        nil, host: 'localhost', port: 24224
-      ).post('la.logger1', {error: 'test message'})
+        nil, host: 'localhost', port: 24_224
+      ).post('la.logger1', { error: 'test message' })
     end
   end
 
   x.report('FluentLogger preload') do
     logger = Fluent::Logger::FluentLogger.new(
-        nil, host: 'localhost', port: 24224
+        nil, host: 'localhost', port: 24_224
       )
     n.times do
-      logger.post('la.logger1', {error: 'test message'})
+      logger.post('la.logger1', { error: 'test message' })
     end
   end
 

data/la_logger.gemspec

@@ -2,8 +2,8 @@ $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
 require 'la_logger/version'
 
 Gem::Specification.new 'la_logger', LaLogger::VERSION do |s|
-  s.description       = 'A singleton wrapper for fluent logger object.'
-  s.summary           = 'Wrap fluent logger as a singleton object, silently fail-over to STDOUT if fluentd service not defined.'
+  s.description       = 'A singleton wrapper for fluent logger.'
+  s.summary           = 'Wrap fluent logger as a singleton object, silently fail-over to STDERR if fluentd service not defined.'
   s.authors           = ['Huang Wei']
   s.email             = 'huangw@7lime.com'
   s.homepage          = 'https://github.com/7lime/la_logger-gem'
@@ -12,9 +12,9 @@ Gem::Specification.new 'la_logger', LaLogger::VERSION do |s|
   s.test_files        = Dir.glob('{spec,test}/**/*.rb')
 
   s.add_dependency 'fluent-logger'
+  s.add_dependency 'activesupport', '~> 3.2'
   s.add_development_dependency 'rspec', '~> 2.5'
   s.add_development_dependency 'mongo'
   s.add_development_dependency 'bson_ext'
   s.add_development_dependency 'simplecov', '~> 2.5'
 end
-

data/lib/la_logger/version.rb

@@ -2,5 +2,5 @@
 
 # Define version of the module
 module LaLogger
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/lib/la_logger.rb

@@ -4,6 +4,8 @@ require 'forwardable'
 require 'singleton'
 require 'fluent-logger'
 require 'logger'
+require 'active_support/backtrace_cleaner'
+require 'active_support/inflector' # :underscore
 
 # LaLogger: wraper for fluent-logger
 class LaLogger
@@ -20,8 +22,8 @@ class LaLogger
     def initialize
       if ENV['FLUENTD']
         host_, port_, tag_ = ENV['FLUENTD'].split ':'
-        host_ = 'localhost' unless host_ and host_.size > 0
-        port_ = 24224 unless port_ and port_.size > 0
+        host_ = 'localhost' unless host_ && host_.size > 0
+        port_ = 24_224 unless port_ && port_.size > 0
         @logger = Fluent::Logger::FluentLogger.new(
           tag_, host: host_.to_s, port: port_.to_i
         )
@@ -43,15 +45,42 @@ class LaLogger
   end
 
   # define 6 log methods
-  [:debug, :info, :warn, :error,
-                  :fatal, :unknown].each_with_index do |met, lvl|
-    define_method(met) do |message, tag = nil, data = {}|
-      data[met] = message || ''
-      tag ||= @tag
-      logger.post(tag, data) if @level <= lvl
+  [:debug, :info, :warn,
+   :error, :fatal, :unknown].each_with_index do |met, lvl|
+    define_method(met) do |message, data = {}|
+      tag = data['tag'] || @tag
+      logger.post(tag, get_data(met, message, data)) if @level <= lvl
     end
   end
 
   # use LaLogger.new.post() directly.
   def_delegator :logger, :post
+
+  private
+
+  # initialize a default error message back trace cleaner
+  def bc
+    unless @bc
+      @bc = ActiveSupport::BacktraceCleaner.new
+      if ENV['APP_ROOT']
+        @bc.add_filter   { |line| line.gsub(ENV['APP_ROOT'], '') }
+      end
+      @bc.add_silencer { |line| line =~ /ruby|gems/ }
+    end
+    @bc
+  end
+
+  # set up data hash to feed the fluent-logger object
+  def get_data(met, message, data)
+    # message also can be omitted:
+    data = message if message.is_a?(Hash) && data.keys.size == 0
+    data[met] = message if message.is_a?(String)
+    data[met] = message.class.name.underscore if message.is_a?(Exception)
+
+    # handle exception object
+    data['message'] ||= message.message if message.respond_to?(:message)
+    data['backtrace'] ||=
+      bc.clean(message.backtrace) if message.respond_to?(:backtrace)
+    data
+  end
 end

data/spec/helpers/mongo_helper.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'mongo'
 include Mongo
 
@@ -5,11 +6,11 @@ include Mongo
 
 module MongoHelper
   def db
-    MongoClient.new('localhost', 27017).db('lalogger_test')
+    MongoClient.new('localhost', 27_017).db('lalogger_test')
   end
 
-  def get_last_logs(col)
-    db.collection(col).find({}, { limit: 5 }).sort(time: :desc).to_a
+  def get_last_logs(col, size = 5)
+    db.collection(col).find({}, { limit: size }).sort(time: :desc).to_a
   end
 
   def cleanup

data/spec/la_logger_spec.rb

@@ -1,11 +1,7 @@
 # encoding: utf-8
-ENV['FLUENTD'] = 'localhost'
 require 'spec_helper'
 require 'la_logger'
 
-#require 'helpers/io_helper'
-#include IOHelper
-
 require 'helpers/mongo_helper'
 include MongoHelper
 
@@ -39,6 +35,13 @@ class UserB
   end
 end
 
+# mix-in la-logger, expose private methods
+class LaLogger
+  def expose_data(message, data = {})
+    get_data('error', message, data)
+  end
+end
+
 describe LaLogger do
   describe 'singleton' do
     it 'same logger globally' do
@@ -48,6 +51,29 @@ describe LaLogger do
     end
   end
 
+  describe 'adjust message data' do
+    it 'can omitt message' do
+      data = LaLogger.new.expose_data('message' => 'info')
+      data['message'].should eq('info')
+    end
+
+    it 'handles error object' do
+      class SomeExceptionClass < RuntimeError; end
+      begin
+        fail SomeExceptionClass, 'raise me!'
+      rescue SomeExceptionClass => e
+        data = LaLogger.new.expose_data(e)
+        data['error'].should eq('some_exception_class')
+        data['message'].should eq('raise me!')
+      end
+    end
+
+    it 'handle string message' do
+      data = LaLogger.new.expose_data('send out message')
+      data['error'].should eq('send out message')
+    end
+  end
+
   describe 'default level' do
     it 'log error messages' do
       LaLogger.new('global').error('error message from global')
@@ -71,5 +97,5 @@ describe LaLogger do
     end
   end
 
-  after(:all) { cleanup }
+  after(:each) { cleanup }
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: la_logger
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-08 00:00:00.000000000 Z
+date: 2013-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluent-logger
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -91,7 +107,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.5'
-description: A singleton wrapper for fluent logger object.
+description: A singleton wrapper for fluent logger.
 email: huangw@7lime.com
 executables: []
 extensions: []
@@ -107,7 +123,6 @@ files:
 - la_logger.gemspec
 - lib/la_logger.rb
 - lib/la_logger/version.rb
-- spec/helpers/io_helper.rb
 - spec/helpers/mongo_helper.rb
 - spec/la_logger_spec.rb
 - spec/spec_helper.rb
@@ -135,10 +150,9 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Wrap fluent logger as a singleton object, silently fail-over to STDOUT if
+summary: Wrap fluent logger as a singleton object, silently fail-over to STDERR if
   fluentd service not defined.
 test_files:
-- spec/helpers/io_helper.rb
 - spec/helpers/mongo_helper.rb
 - spec/la_logger_spec.rb
 - spec/spec_helper.rb

data/spec/helpers/io_helper.rb

@@ -1,30 +0,0 @@
-# encoding: utf-8
-
-# record stdout and stderr output as strings for testing against expectation
-module IOHelper
-  def capture_stdout(&block)
-    original_stdout = $stdout
-    $stdout = fake = StringIO.new
-    begin
-      yield
-    rescue SystemExit
-      $stdout = original_stdout # fake rubocop
-    ensure
-      $stdout = original_stdout
-    end
-    fake.string
-  end
-
-  def capture_stderr(&block)
-    original_stdout = $stderr
-    $stderr = fake = StringIO.new
-    begin
-      yield
-    rescue SystemExit
-      $stdout = original_stdout # fake rubocop
-    ensure
-      $stderr = original_stdout
-    end
-    fake.string
-  end
-end