la_logger 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmMzNjQ0YTZhMWFmYTYxMDI3MmUzODYxM2VmNWZiNDFhMjBkZWY3NA==
+  data.tar.gz: !binary |-
+    ZmNiOTRjOGIyODdlYjdmMWI4NjIwMWZiYTJkNGJmNzA3MmVjMGNkMw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NTZhNmZkMmFkMzYzMTliNDMzYmUyNzQyYTg2N2YxN2ZiN2U2MTIzMWE5Nzkz
+    MmM5NmExYjljMTExNWM1YzI0NmY1YjA2NzUwZDVhNTM4ODBjMTk4NmQ0OWUw
+    ZWVmZjEwMzJhOGIyNTE4NmUwODdiMzRhY2Q4ZDYzNTgwYmRmYTU=
+  data.tar.gz: !binary |-
+    YzI2ZTA2YWMyNDdhMjFlM2Q1NGNiNjliMDY1Y2ZkMWYxZWYxMzJkNjFhYTYz
+    YzZmM2VmZjk3ZjAwOTEwYmJhYzVkZDBlNDdiNjE3MThlMDAxMGJmYTQxMDMw
+    MDhiYzY3MmFlYjUxODcyOWRlMjM1ODFkMTI5Yjk5ODc5NWJlYWI=

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,13 @@
+source 'http://ruby.taobao.org/'
+
+gem 'fluent-logger'
+
+group :development do
+  gem 'fluentd'
+  gem 'fluent-plugin-mongo'
+  gem 'foreman'
+  gem 'rspec'
+  gem 'rubocop'
+  gem 'mongo'
+  gem 'bson_ext'
+end

data/Procfile

@@ -0,0 +1 @@
+logger: fluentd -c config/fluent.conf

data/README.md

@@ -0,0 +1,35 @@
+# LaLogger: A general logger module wraps Fluentd-logger
+
+Require: ruby 1.9.x, fluent-logger (not working on JRuby without modification).
+
+## Concepts
+
+- Include into any class, expose a singleton logger object and `log_xxx` functions:
+
+    class LoggerUser
+      def logger
+        # initialize tag and log level, default level is 'WARN'
+        LaLogger.new('la.logger.tag', LaLogger::ERROR)
+      end
+
+      def logger_this
+        logger.error('oops! an error happend!', {extra: 'data'})
+        logger.post('custom.tag', {custom: 'message'})
+      end
+    end
+
+- Silently fails-over to `STDOUT` if `ENV['FLUENTD']` not defined.
+
+To use fluentd service, define: `ENV[FLUENTD] = 'localhost:24224'`
+somewhere in your code before use the logger. Default port `24224` is optional.
+
+You can use an additional `ENV['FLUENTD_TAG']` to initialize default tag for the
+fluent-logger.
+
+Note: as logger object is wrapped by a singleton class, there is no effect to
+change this setting after logger object has created.
+
+## Severities
+
+Imported from ruby's default `Logger::Severity`, namely: `debug, info, warn, error,
+fatal, unknown`.

data/benchmark/singleton.rb

@@ -0,0 +1,36 @@
+require 'benchmark'
+
+require 'fluent-logger'
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+ENV['FLUENTD'] = 'localhost'
+require 'la_logger'
+
+n = 5000
+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'})
+    end
+  end
+
+  x.report('FluentLogger preload') do
+    logger = Fluent::Logger::FluentLogger.new(
+        nil, host: 'localhost', port: 24224
+      )
+    n.times do
+      logger.post('la.logger1', {error: 'test message'})
+    end
+  end
+
+  x.report('LaLogger.new') do
+    n.times { LaLogger.new.error('la.logger3', 'test message') }
+  end
+
+  x.report('LaLogger preload') do
+    logger = LaLogger.new
+    n.times { logger.error('la.logger2', 'test message') }
+  end
+end

data/config/fluent.conf

@@ -0,0 +1,49 @@
+
+## built-in TCP input
+## $ echo <json> | fluent-cat <tag>
+<source>
+  type forward
+</source>
+
+## File input
+## read apache logs with tag=apache.access
+#<source>
+#  type tail
+#  format apache
+#  path /var/log/httpd-access.log
+#  tag apache.access
+#</source>
+
+# Listen HTTP for monitoring
+# http://localhost:24220/api/plugins
+# http://localhost:24220/api/plugins?type=TYPE
+# http://localhost:24220/api/plugins?tag=MYTAG
+<source>
+  type monitor_agent
+  port 24220
+</source>
+
+# Listen DRb for debug
+# <source>
+#   type debug_agent
+#   port 24230
+# </source>
+
+<match la.**>
+  # plugin type
+  type mongo
+  
+  # mongodb host + port
+  host localhost
+  port 27017
+  
+  # mongodb db + collection
+  database lamancha_log 
+  tag_mapped
+  collection default 
+  
+  remove_tag_prefix la.
+
+  # interval
+  flush_interval 1s
+</match>

data/la_logger.gemspec

@@ -0,0 +1,20 @@
+$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.authors           = ['Huang Wei']
+  s.email             = 'huangw@7lime.com'
+  s.homepage          = 'https://github.com/7lime/la_logger-gem'
+  s.files             = `git ls-files`.split("\n") - %w[.gitignore Rakefile]
+  s.license           = 'MIT'
+  s.test_files        = Dir.glob('{spec,test}/**/*.rb')
+
+  s.add_dependency 'fluent-logger'
+  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

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+# Define version of the module
+module LaLogger
+  VERSION = '0.0.1'
+end

data/lib/la_logger.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+require 'forwardable'
+require 'singleton'
+require 'fluent-logger'
+require 'logger'
+
+# LaLogger: wraper for fluent-logger
+class LaLogger
+  extend Forwardable
+  include Logger::Severity
+
+  attr_accessor :tag, :level
+
+  # singleton logger object
+  class Logger
+    include Singleton
+    attr_reader :logger
+
+    def initialize
+      if ENV['FLUENTD']
+        host_, port_ = ENV['FLUENTD'].split ':'
+        host_ ||= 'localhost'
+        port_ ||= 24224
+        @logger = Fluent::Logger::FluentLogger.new(
+          ENV['FLUENTD_TAG'], host: host_.to_s, port: port_.to_i
+        )
+      else
+        @logger = Fluent::Logger::ConsoleLogger.open($stderr)
+      end
+    end
+  end
+
+  # initialize a la_logger object, with a singleton internal @logger
+  def initialize(tag = nil, level = nil)
+    @tag = tag
+    @level = level || WARN
+  end
+
+  # getter for the singleton logger
+  def logger
+    @logger ||= Logger.instance.logger
+  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
+    end
+  end
+
+  # use LaLogger.new.post() directly.
+  def_delegator :logger, :post
+end

data/spec/helpers/io_helper.rb

@@ -0,0 +1,30 @@
+# 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

data/spec/helpers/mongo_helper.rb

@@ -0,0 +1,26 @@
+require 'mongo'
+include Mongo
+
+# require 'bson_ext'
+
+module MongoHelper
+  def db
+    MongoClient.new('localhost', 27017).db('lamancha_log')
+  end
+
+  def get_last_logs(col)
+    db.collection(col).find({}, { limit: 5 }).sort(time: :desc).to_a
+  end
+
+  def cleanup
+    db.collections.each { |c| c.drop }
+  end
+
+  def has_log(tag, level, value)
+    sleep 2
+    get_last_logs(tag).each do |ld|
+      return true if ld[level] == value
+    end
+    false
+  end
+end

data/spec/la_logger_spec.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+ENV['FLUENTD'] = 'localhost'
+require 'spec_helper'
+require 'la_logger'
+
+#require 'helpers/io_helper'
+#include IOHelper
+
+require 'helpers/mongo_helper'
+include MongoHelper
+
+# first test class
+class UserA
+  def logger
+    @logger ||= LaLogger.new('la.user_a', LaLogger::INFO)
+  end
+
+  def test_log_error(msg = 'error message from A')
+    logger.error(msg)
+  end
+
+  def test_log_info(msg = 'info message from A')
+    logger.info(msg)
+  end
+end
+
+# second test class
+class UserB
+  def logger
+    @logger ||= LaLogger.new('la.user_b')
+  end
+
+  def test_log_error(msg = 'error message from B')
+    logger.error(msg)
+  end
+
+  def test_log_info(msg = 'info message from B')
+    logger.info(msg)
+  end
+end
+
+describe LaLogger do
+  describe 'singleton' do
+    it 'same logger globally' do
+      LaLogger.new.logger.equal?(LaLogger.new.logger).should be_true
+      LaLogger.new.logger.equal?(UserA.new.logger.logger).should be_true
+      UserB.new.logger.logger.equal?(UserA.new.logger.logger).should be_true
+    end
+  end
+
+  describe 'default level' do
+    it 'log error messages' do
+      LaLogger.new('la.global').error('error message from global')
+      has_log('global', 'error', 'error message from global').should be_true
+    end
+  end
+
+  describe 'through class' do
+    it 'record error for both A and B' do
+      UserA.new.test_log_error('through a test')
+      has_log('user_a', 'error', 'through a test').should be_true
+      UserB.new.test_log_error('through b test')
+      has_log('user_b', 'error', 'through b test').should be_true
+    end
+
+    it 'record info only for A' do
+      UserA.new.test_log_info('info through a test')
+      has_log('user_a', 'info', 'info through a test').should be_true
+      UserB.new.test_log_info('info through b test')
+      has_log('user_b', 'info', 'info through b test').should be_false
+    end
+  end
+
+  after(:all) { cleanup }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+require 'rspec'
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__))
+
+# in spec/spec_helper.rb
+RSpec.configure do |c|
+#  c.filter_run_excluding slow: true
+end

data/tuser.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + '/lib'
+
+require 'la_logger'
+
+LaLogger.logger.post('La', {message: 'La Mon'})
+
+class User
+  include LaLogger
+
+  def say
+    log_error('An error occured.')
+  end
+
+  def say_other
+    logger_init('La Mancha')
+    log_error('Error occured again.')
+  end
+end
+
+User.new.say
+User.new.say_other

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: la_logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Huang Wei
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluent-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: A singleton wrapper for fluent logger object.
+email: huangw@7lime.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- Gemfile
+- Procfile
+- README.md
+- benchmark/singleton.rb
+- config/fluent.conf
+- 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
+- tuser.rb
+homepage: https://github.com/7lime/la_logger-gem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Wrap fluent logger as a singleton object, silently fail-over to STDOUT 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