Class: Rack::CommonLogger::Fluent

Inherits:
Object
  • Object
show all
Defined in:
lib/rack/common_logger/fluent.rb

Overview

Examples:

# 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
format = lambda do |info|
  result = Rack::CommonLogger::Fluent.default_format
  result["xxxxxx"] = info[:env]["appx.xxxxxx"]
  # ...

  result
end
use Rack::CommonLogger::Fluent, 'myapp', logger, format

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app, tag, logger = nil, format = nil) ⇒ 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.



33
34
35
36
37
38
39
40
 
# File 'lib/rack/common_logger/fluent.rb', line 33

def initialize(app, tag, logger=nil, format=nil)
  @app = app
  @logger = logger || ::Fluent::Logger::FluentLogger.new(nil, :host => 'localhost', :port => 24224)
  @tag = tag
  @format = format || lambda do |info|
    self.class.default_format(info)
  end
end

Class Method Details

.default_format(info) ⇒ Object

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.
referer:        Referer request header.
content_type:   Content-Type response header.
content_length: Content-Length response header.(Fixnum)
runtime:        seconds of application running. (Float)



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/rack/common_logger/fluent.rb', line 75

def self.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["referer"]        = info[:env]["HTTP_REFERER"]
    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

Instance Method Details

#call(env) ⇒ Object

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



51
52
53
54
55
56
57
58
 
# File 'lib/rack/common_logger/fluent.rb', line 51

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

#log(env, status, header, began_at) ⇒ Object 



95
96
97
98
99
 
# File 'lib/rack/common_logger/fluent.rb', line 95

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