la_logger 0.1.0 → 0.1.2

data/Gemfile

@@ -1,6 +1,7 @@
 source 'http://ruby.taobao.org/'
 
 gem 'fluent-logger'
+gem 'activesupport'
 
 group :development do
   gem 'fluentd'

data/Gemfile.lock

@@ -1,11 +1,17 @@
 GEM
   remote: http://ruby.taobao.org/
   specs:
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
     ast (1.1.0)
-    backports (3.3.3)
-    bson (1.9.2)
-    bson_ext (1.9.2)
-      bson (~> 1.9.2)
+    atomic (1.1.14)
+    bson (1.8.6)
+    bson_ext (1.8.6)
+      bson (~> 1.8.6)
     cool.io (1.1.1)
       iobuffer (>= 1.0.0)
     diff-lcs (1.2.4)
@@ -13,10 +19,10 @@ GEM
     fluent-logger (0.4.6)
       msgpack (>= 0.4.4, < 0.6.0, != 0.5.3, != 0.5.2, != 0.5.1, != 0.5.0)
       yajl-ruby (~> 1.0)
-    fluent-plugin-mongo (0.6.7)
-      fluentd (>= 0.10.7)
-      mongo (>= 1.6.0)
-    fluentd (0.10.38)
+    fluent-plugin-mongo (0.7.1)
+      fluentd (~> 0.10.9)
+      mongo (~> 1.8.0)
+    fluentd (0.10.39)
       cool.io (~> 1.1.1)
       http_parser.rb (~> 0.5.1)
       json (>= 1.4.3)
@@ -26,37 +32,43 @@ GEM
       dotenv (>= 0.7)
       thor (>= 0.13.6)
     http_parser.rb (0.5.3)
+    i18n (0.6.5)
     iobuffer (1.1.2)
     json (1.8.0)
-    mongo (1.9.1)
-      bson (~> 1.9.1)
-    msgpack (0.5.5)
-    parser (2.0.0.pre6)
+    minitest (4.7.5)
+    mongo (1.8.6)
+      bson (~> 1.8.6)
+    msgpack (0.5.6)
+    multi_json (1.8.0)
+    parser (2.0.0.pre8)
       ast (~> 1.1)
       slop (~> 3.4, >= 3.4.5)
-    powerpack (0.0.6)
+    powerpack (0.0.8)
     rainbow (1.1.4)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
     rspec-core (2.14.5)
-    rspec-expectations (2.14.2)
+    rspec-expectations (2.14.3)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.3)
-    rubocop (0.12.0)
-      backports (~> 3.3.3)
+    rubocop (0.13.1)
       parser (~> 2.0.0.pre6)
-      powerpack (~> 0.0.3)
+      powerpack (~> 0.0.6)
       rainbow (>= 1.1.4)
     slop (3.4.6)
     thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.37)
     yajl-ruby (1.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport
   bson_ext
   fluent-logger
   fluent-plugin-mongo

data/README.md

@@ -1,53 +1,89 @@
-# LaLogger: A general logger module wraps Fluentd-logger
+## LaLogger: A general logger module wraps Fluentd-logger
 
-Require: ruby 1.9.x, fluent-logger (not working on JRuby without modification).
+### Requirement
 
-## Concepts
+- ruby 1.9.x,
+- activesupport
+- fluent-logger (which depends on `yaji-ruby` so will not working on JRuby without modification)
 
-- Initialize a logger object with `tag` (which becomings collection name for `tag_mapped`
-  setting in `fluent.conf`) and log level:
+### Concept
 
-    class LoggerUser
-      def logger
-        # initialize tag and log level, default level is 'WARN'
-        LaLogger.new('specific_tag', LaLogger::ERROR)
-      end
+- Singleton
+- Severity control
+- Centralized log storage by fluentd
+- Send to STDERR in debug mode
 
-      def logger_this
-        # use warn, error, fatal, ... to log messages with optional
-        # extra information in hash format:
-        logger.error('oops! an error happend!', {extra: 'data'})
+### Synopsis
 
-        # send (post) message using fluent-logger object directly
-        logger.post('custom.tag', {custom: 'message'})
-      end
-    end
+Setup fluentd configuration to forward specific tag:
 
-- Silently fails-over to `STDOUT` if `ENV['FLUENTD']` not defined.
+    <match la.**>
+      # plugin type
+      type mongo
 
-To use fluentd service, define: `ENV[FLUENTD] = 'localhost:24224:label'`
-somewhere in your code before use the logger.
+      # mongodb host + port
+      host localhost
+      port 27017
 
-Default port `24224` is optional, `label` is also optional (default is `nil`).
+      # mongodb db + collection
+      database lalogger_test
+      tag_mapped
+      collection default
 
-Note: as logger object is wrapped by a singleton class, there is no effect to
-change this setting after logger object has created.
+      remove_tag_prefix la.
 
-## Severities
+      # interval
+      flush_interval 1s
+    </match>
 
-Imported from ruby's default `Logger::Severity`, namely: `debug, info, warn, error,
-fatal, unknown`.
+In your program:
 
-## Develop or Test
+1. Define the host and ip where `fluentd` is running and a `global` tag matches `<match la.**>` above:
 
-Run `foreman start` to start the `fluentd` server fro test.
+~~~~~~ ruby
+ENV[FLUENTD] = 'localhost:24224:la'
+~~~~~~~~~~~~~~~~
+
+   default port `24224` is optional: `localhost::la` is same as above.
+
+   Note: as logger object is wrapped by a singleton class, there is no effect to
+   change this setting after logger object has created.
+
+2. Use the logger in your program:
+
+~~~~~~ ruby
+def logger
+  # initialize tag and log level, default level is 'WARN'
+  LaLogger.new('la.logger.tag', LaLogger::ERROR)
+end
+~~~~~~~~~~~~~~~~
+
+  Tag set here will becoming collection name if you use `tag_mapped`
+  setting in your `fluent.conf` file
 
-## Production
+~~~~~~ ruby
+def logger_this
+  # use warn, error, fatal, ... to log messages with optional
+  # extra information in hash format:
+  logger.error('oops! an error happend!', {extra: 'data'})
+end
+~~~~~~~~~~~~~~~~
 
-Set up your fluentd conf file, set
+   You can use `raw` command `post` too:
 
-    <match lalogger.**>
+~~~~~~~~~ ruby
+# send (post) message using fluent-logger object directly
+logger.post('custom.tag', {custom: 'message'})
+~~~~~~~~~~~~~~~~
 
-where `lalogger` equals the tag parts you set in your `ENV['FLUENTD']` variable.
+   In this way you can specify an `tag`.
+
+## Severities
+
+Imported from ruby's default `Logger::Severity`,
+namely: `debug, info, warn, error, fatal, unknown`.
+
+## Develop or Test
+
+Run `foreman start` to start the `fluentd` server fro test.
 
-Optionally set `remove_tag_prefix lalogger.` to remove tag from collection names.

data/la_logger.gemspec

@@ -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_dependency 'activesupport'
+  s.add_development_dependency 'rspec'
   s.add_development_dependency 'mongo'
   s.add_development_dependency 'bson_ext'
-  s.add_development_dependency 'simplecov', '~> 2.5'
+  s.add_development_dependency 'simplecov'
 end

data/lib/la_logger/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: la_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-25 00:00:00.000000000 Z
+date: 2013-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluent-logger
@@ -32,33 +32,33 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mongo
   requirement: !ruby/object:Gem::Requirement
@@ -96,17 +96,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '0'
 description: A singleton wrapper for fluent logger.
 email: huangw@7lime.com
 executables: []