act-fluent-logger-rails 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e28f2538881b7eb28b8f09685cc092a4b602e5e
-  data.tar.gz: 236175fa5424912c12231b24f16ae47dd187832f
+  metadata.gz: ba6d73a346e319350b3656f24a42809e20b161a6
+  data.tar.gz: eff76247f67cbe7aa92c4f396c598ec42922502f
 SHA512:
-  metadata.gz: e302fef91fb4d21bfd52b92e029da7d14a129cab26eee6640bf96006378da41901c35b8d99128120103b28596fb1820c869f4e89d22992456e37d9a0beba7eb9
-  data.tar.gz: 9c772565e1c5db6a976501aaa73a92d476b5098da7d25cad2df50496e2106c83f4381577e8e121c384c8837d0bcec4234f33e9afd543a6d8631cf5e3b5b75d40
+  metadata.gz: 040c190bfea376ec3456569668fbc3aaaacefabb76d54e86bca4d1f41a98f49b56109b3f2847e26e13fadc23db21ba2ed30cf8ba32cb54f38213ae6d91cfdb76
+  data.tar.gz: 65317b818e16de0efe43cbcc12d3ffdb5d6b7dc9ee2bd643ba07048aa1ac14390cb8defb1735b724a7454e5898fd882f23541f637b6714ad252ec377fa04ff0e

data/.gitignore

@@ -1,8 +1,10 @@
 *.gem
 *.rbc
+*~
 .bundle
 .config
 .yardoc
+/vendor
 Gemfile.lock
 InstalledFiles
 _yardoc
@@ -15,4 +17,3 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-*~

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p195

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.1 / September 26 2013
+
+ * Add log_tags feature.
+
 ## 0.1.0 / September 16 2013
 
  * Rails 4.0.0

data/README.md

@@ -2,6 +2,10 @@
 
 Fluent logger.
 
+## Supported versions
+
+ * Rails 4.0
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -21,7 +25,14 @@ Or install it yourself as:
 in config/environments/production.rb
 
     config.log_level = :info
-    config.logger = ActFluentLoggerRails::Logger.new
+    config.logger = ActFluentLoggerRails::Logger.
+      new(log_tags: {
+            ip: :ip,
+            ua: :user_agent,
+            uid: ->(request) { request.session[:uid] }
+          })
+
+Don't use config.log_tags.
 
 create config/fluent-logger.yml
 
@@ -56,9 +67,9 @@ create config/fluent-logger.yml
 2013-01-18T15:04:50+09:00 foo {"messages":["Started GET \"/\" for 127.0.0.1 at 2013-01-18 15:04:49 +0900","Processing by TopController#index as HTML","Completed 200 OK in 635ms (Views: 479.3ms | ActiveRecord: 39.6ms)"],"level":"INFO"}
 ```
 
-If your Rails version is older than v3.2.9, You must set a dummy value to config.log_tags.
+You can add any tags at run time.
 
-    config.log_tags = ['nothing']
+   logger[:foo] = "foo value"
 
 
 ## Contributing

data/lib/act-fluent-logger-rails/logger.rb

@@ -8,8 +8,8 @@ module ActFluentLoggerRails
     # Severity label for logging. (max 5 char)
     SEV_LABEL = %w(DEBUG INFO WARN ERROR FATAL ANY)
 
-    def self.new
-      config_file   = Rails.root.join("config", "fluent-logger.yml")
+    def self.new(config_file: Rails.root.join("config", "fluent-logger.yml"), log_tags: {})
+      Rails.application.config.log_tags = [ ->(request) { request } ] unless log_tags.empty?
       fluent_config = YAML.load(ERB.new(config_file.read).result)[Rails.env]
       settings = {
         tag:  fluent_config['tag'],
@@ -18,31 +18,21 @@ module ActFluentLoggerRails
         messages_type: fluent_config['messages_type'],
       }
       level = SEV_LABEL.index(Rails.application.config.log_level.to_s.upcase)
-      logger = ActFluentLoggerRails::FluentLogger.new(settings, level)
-      logger.formatter ||= ActiveSupport::Logger::SimpleFormatter.new
-      logger.formatter.extend ActiveSupport::TaggedLogging::Formatter
-      logger.extend ActiveSupport::TaggedLogging
+      logger = ActFluentLoggerRails::FluentLogger.new(settings, level, log_tags)
+      logger = ActiveSupport::TaggedLogging.new(logger)
       logger.extend self
     end
 
-    def add(severity, message = nil, progname = nil, &block)
-      return true if severity < level
-      message = (block_given? ? block.call : progname) if message.blank?
-      return true if message.blank?
-      add_message(severity, message)
-      true
-    end
-
     def tagged(*tags)
-      super(*tags)
+      @request = tags[0][0]
+      yield self
     ensure
       flush
     end
-
   end
 
   class FluentLogger < ActiveSupport::Logger
-    def initialize(options, level=DEBUG)
+    def initialize(options, level, log_tags)
       self.level = level
       port    = options[:port]
       host    = options[:host]
@@ -51,6 +41,16 @@ module ActFluentLoggerRails
       @fluent_logger = ::Fluent::Logger::FluentLogger.new(nil, host: host, port: port)
       @severity = 0
       @messages = []
+      @log_tags = log_tags
+      @map = {}
+    end
+
+    def add(severity, message = nil, progname = nil, &block)
+      return true if severity < level
+      message = (block_given? ? block.call : progname) if message.blank?
+      return true if message.blank?
+      add_message(severity, message)
+      true
     end
 
     def add_message(severity, message)
@@ -58,6 +58,14 @@ module ActFluentLoggerRails
       @messages << message
     end
 
+    def [](key)
+      @map[key]
+    end
+
+    def []=(key, value)
+      @map[key] = value
+    end
+
     def flush
       return if @messages.empty?
       messages = if @messages_type == :string
@@ -65,9 +73,22 @@ module ActFluentLoggerRails
                  else
                    @messages
                  end
-      @fluent_logger.post(@tag, messages: messages, level: format_severity(@severity))
+      @map[:messages] = messages
+      @map[:level] = format_severity(@severity)
+      @log_tags.each do |k, v|
+        @map[k] = case v
+                  when Proc
+                    v.call(@request)
+                  when Symbol
+                    @request.send(v)
+                  else
+                    v
+                  end rescue :error
+      end
+      @fluent_logger.post(@tag, @map)
       @severity = 0
       @messages.clear
+      @map.clear
     end
 
     def close

data/lib/act-fluent-logger-rails/version.rb

@@ -1,3 +1,3 @@
 module ActFluentLoggerRails
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/logger_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+require 'tempfile'
+
+
+describe ActFluentLoggerRails::Logger do
+  before do
+
+    Rails = double("Rails", env: "test")
+    Rails.stub_chain(:application, :config, :log_level).and_return(:debug)
+    Rails.stub_chain(:application, :config, :log_tags=)
+
+    class MyLogger
+      attr_accessor :log
+      def post(tag, map)
+        @log ||= []
+        @log << [tag, map.merge(messages: map[:messages].dup)]
+      end
+      def clear
+        @log.clear
+      end
+      def close
+      end
+    end
+    @my_logger = MyLogger.new
+    Fluent::Logger::FluentLogger.stub(:new) { @my_logger }
+
+    @config_file = Tempfile.new('fluent-logger-config')
+    @config_file.close(false)
+    File.open(@config_file.path, 'w') {|f|
+      f.puts <<EOF
+test:
+  fluent_host: '127.0.0.1'
+  fluent_port: 24224
+  tag:         'foo'
+EOF
+    }
+  end
+
+  let(:logger) {
+    ActFluentLoggerRails::Logger.new(config_file: File.new(@config_file.path),
+                                     log_tags: {
+                                       uuid: :uuid,
+                                       foo: ->(request) { request.foo }
+                                     })
+  }
+
+  it 'info' do
+    request = double('request', uuid: 'uuid_value', foo: 'foo_value')
+    logger[:abc] = 'xyz'
+    logger.tagged([request]) { logger.info('hello') }
+    expect(@my_logger.log).to eq([['foo', {
+                                     abc: 'xyz',
+                                     messages: ['hello'],
+                                     level: 'INFO',
+                                     uuid: 'uuid_value',
+                                     foo: 'foo_value'
+                                   } ]])
+    @my_logger.clear
+    logger.tagged([request]) { logger.info('world'); logger.info('bye') }
+    expect(@my_logger.log).to eq([['foo', {
+                                     messages: ['world', 'bye'],
+                                     level: 'INFO',
+                                     uuid: 'uuid_value',
+                                     foo: 'foo_value'
+                                   } ]])
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'active_support'
+require 'active_support/deprecation'
+require 'active_support/core_ext/module'
+require 'active_support/logger'
+require 'active_support/tagged_logging'
+require 'yaml'
+require 'act-fluent-logger-rails/logger'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: act-fluent-logger-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - TAHARA Yoshinori
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-17 00:00:00.000000000 Z
+date: 2013-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -60,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .ruby-version
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -69,6 +70,8 @@ files:
 - lib/act-fluent-logger-rails.rb
 - lib/act-fluent-logger-rails/logger.rb
 - lib/act-fluent-logger-rails/version.rb
+- spec/logger_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/actindi/act-fluent-logger-rails
 licenses: []
 metadata: {}
@@ -92,4 +95,6 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Fluent logger
-test_files: []
+test_files:
+- spec/logger_spec.rb
+- spec/spec_helper.rb