rack-common_logger-fluent 0.2.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+#
+gem 'fluent-logger'
+gem 'rack'
+
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler"
+  gem "jeweler", "~> 1.8.3"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Keiji, Yoshimi
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,41 @@
+= rack-common_logger-fluent
+
+rack middleware for writing access log to fluentd.
+
+== Example
+    # in your config.ru
+    
+    require 'fluent-logger'
+    require 'rack/common_logger/fluent'
+    
+    logger = Fluent::Logger::FluentLogger.new(nil, :host => 'localhost', :port => 24224)
+    use Rack::CommonLogger::Fluent, 'myapp', logger
+    
+    # if you want to customize format
+    use Rack::CommonLogger::Fluent, 'myapp', logger do |info|
+      result = {}
+    
+      # ...
+    
+      result
+    end
+
+== WARN
+
+THIS PROJECT is early development. compatibility may break.
+
+== Contributing to rack-common_logger-fluent
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Keiji, Yoshimi. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rack-common_logger-fluent"
+  gem.homepage = "http://github.com/walf443/rack-common_logger-fluent"
+  gem.license = "MIT"
+  gem.summary = %Q{rack middleware for writing access log to fluentd. }
+  gem.description = %Q{rack middleware for writing access log to fluentd. }
+  gem.email = "walf443@gmail.com"
+  gem.authors = ["Keiji, Yoshimi"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack-common_logger-fluent #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/rack-common_logger-fluent.rb

@@ -0,0 +1,2 @@
+# just alias.
+require 'rack/common_logger/fluent'

data/lib/rack/common_logger/fluent.rb

@@ -0,0 +1,102 @@
+require 'fluent-logger'
+require 'time'
+
+module Rack
+  class CommonLogger
+    #
+    # @example
+    #   # in your config.ru
+    #
+    #   require 'fluent-logger'
+    #   require 'rack/common_logger/fluent'
+    #
+    #   logger = Fluent::Logger::FluentLogger.new(nil, :host => 'localhost', :port => 24224)
+    #   use Rack::CommonLogger::Fluent, 'myapp.access', logger
+    #   # will output to log
+    #   #   #=> 2012-05-12T17:56:50+09:00       myapp.access      {"remote_addr":"127.0.0.1","date":"2012-05-12T17:56:50+09:00","request_method":"GET","path_info":"/","query_string":"?body=1","http_version":"HTTP/1.1","http_status":304,"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/535.19 (KHTML, like Gecko) Chrome/18.0.1025.168 Safari/535.19","content_type":null,"content_length":null,"runtime":0.007976}
+    #
+    #   # if you want to customize format
+    #   use Rack::CommonLogger::Fluent, 'myapp', logger do |info|
+    #     result = {}
+    #
+    #     # ...
+    #
+    #     result
+    #   end
+    # 
+    #
+    class Fluent
+      # tag is Fluent::Logger's tag for access log.
+      # +logger+ should implement post(+tag+, +message) method. logger is a Fluent::Logger::FluentLogger object.
+      # +format+ is block that take Hash that has +env+(Rack's env), +status+, +header+, +now+, +runtime+, and should return Hash that contain access_log element.
+      # +format+ is optional and use +default_format+ as default.
+      def initialize(app, tag, logger=nil, &format)
+        @app = app
+        @logger = logger || ::Fluent::Logger::FluentLogger.new(nil, :host => 'localhost', :port => 24224)
+        @tag = tag
+        @format = format || lambda do |info|
+          self.default_format(info)
+        end
+      end
+
+      # run application and post access information to fluentd.
+      #
+      # This middleware set @logger to rack.fluent_logger of env.
+      # So your application can post to fluentd like this.
+      #   def call(env)
+      #     env["fluent_logger"].post("app.log", { "message": "xxxxxx" })
+      #     # ...
+      #   end
+      #
+      def call(env)
+        env["rack.fluent_logger"] = @logger
+        began_at = Time.now
+        status, header, body = @app.call(env)
+        header = Utils::HeaderHash.new(header)
+        body = BodyProxy.new(body) { log(env, status, header, began_at) }
+        [status, header, body]
+      end
+
+      # This method return default_format.
+      #   hostname:       HTTP_HOST or SERVER_NAME
+      #   remote_addr:    HTTP_X_FORWARDED_FOR or REMOTE_ADDR
+      #   date:           iso8601 datetime string.
+      #   request_method: rack's REQUEST_METHOD
+      #   path_info:      rack's PATH_INFO
+      #   query_string:   rack's QUERY_STRING
+      #   http_version:   rack's HTTP_VERSION
+      #   http_status:    response code. (Fixnum)
+      #   user_agent:     User-Agent request header.
+      #   content_type:   Content-Type response header.
+      #   content_length: Content-Length response header.(Fixnum)
+      #   runtime:        seconds of application running. (Float)
+      #
+      def default_format(info)
+          hash = {}
+
+          hash["hostname"]       = info[:env]["HTTP_HOST"] || info[:env]["SERVER_NAME"]
+          hash["remote_addr"]    = info[:env]["HTTP_X_FORWARDED_FOR"] || info[:env]["REMOTE_ADDR"] || nil
+          hash["date"]           = info[:now].iso8601
+          hash["request_method"] = info[:env]["REQUEST_METHOD"]
+          hash["path_info"]      = info[:env]["PATH_INFO"].gsub("%2F", '/') # some case "/" to be %2F.
+          hash["query_string"]   = info[:env]["QUERY_STRING"].empty? ? "" : '?' + info[:env]["QUERY_STRING"]
+          hash["http_version"]   = info[:env]["HTTP_VERSION"]
+          hash["http_status"]    = info[:status].to_s[0..3].to_i
+          hash["user_agent"]     = info[:env]["HTTP_USER_AGENT"]
+          hash["content_type"]   = info[:header]["Content-Type"]
+          hash["content_length"] = info[:header]["Content-Length"] ? info[:header]["Content-Length"].to_i : nil
+          hash["runtime"]        = info[:runtime]
+
+          hash
+      end
+
+      def log(env, status, header, began_at)
+        now = Time.now
+        result = @format.call({ :env => env, :status => status, :header => header, :now => now, :runtime => now - began_at })
+        @logger.post(@tag, result)
+      end
+
+    end
+  end
+end
+

data/rack-common_logger-fluent.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "rack-common_logger-fluent"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Keiji, Yoshimi"]
+  s.date = "2012-05-12"
+  s.description = "rack middleware for writing access log to fluentd. "
+  s.email = "walf443@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/rack-common_logger-fluent.rb",
+    "lib/rack/common_logger/fluent.rb",
+    "rack-common_logger-fluent.gemspec",
+    "spec/rack-common_logger-fluent_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/walf443/rack-common_logger-fluent"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.21"
+  s.summary = "rack middleware for writing access log to fluentd."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<fluent-logger>, [">= 0"])
+      s.add_runtime_dependency(%q<rack>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+    else
+      s.add_dependency(%q<fluent-logger>, [">= 0"])
+      s.add_dependency(%q<rack>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    end
+  else
+    s.add_dependency(%q<fluent-logger>, [">= 0"])
+    s.add_dependency(%q<rack>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+  end
+end
+

data/spec/rack-common_logger-fluent_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "RackCommonLoggerFluent" do
+  before do
+    body = "foobar"
+    @app = Rack::Lint.new(lambda {|env|
+      [200, { "Content-Type" => "text/html", "Content-Length" => body.size.to_s }, [body] ]
+    })
+  end
+
+  it do
+    logger = Fluent::Logger::TestLogger.new
+    res = Rack::MockRequest.new(Rack::CommonLogger::Fluent.new(@app, 'myapp', logger)).get('/')
+    logger.queue.size.should == 1
+    message = logger.queue.first
+    message["hostname"].should == "example.org"
+    message["content_length"].should == 6
+    message["content_type"].should == "text/html"
+    message["request_method"].should == "GET"
+    message["path_info"].should == "/"
+    message["http_status"].should == 200
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'rack-common_logger-fluent'
+require 'rack/lint'
+require 'rack/mock'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: rack-common_logger-fluent
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Keiji, Yoshimi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluent-logger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+description: ! 'rack middleware for writing access log to fluentd. '
+email: walf443@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rack-common_logger-fluent.rb
+- lib/rack/common_logger/fluent.rb
+- rack-common_logger-fluent.gemspec
+- spec/rack-common_logger-fluent_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/walf443/rack-common_logger-fluent
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4004731729266765288
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: rack middleware for writing access log to fluentd.
+test_files: []