diff --git a/README.md b/README.md new file mode 100644 index 0000000..3d70e5c --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +# Fluent logger +A structured event loger + +## Examples + +### Simple + +```ruby +require 'fluent-logger' + +log = Fluent::Logger::FluentLogger.new(nil, :host=>'localhost', :port=>24224) +unless log.post("myapp.access", {"agent"=>"foo"}) + p log.last_error # You can get last error object via last_error method +end + +# output: myapp.access {"agent":"foo"} +``` + +### Singleton +```ruby +require 'fluent-logger' + +Fluent::Logger::FluentLogger.open(nil, :host=>'localhost', :port=>24224) +Fluent::Logger.post("myapp.access", {"agent"=>"foo"}) + +# output: myapp.access {"agent":"foo"} +``` + +### Tag prefix +```ruby +require 'fluent-logger' + +log = Fluent::Logger::FluentLogger.new('myapp', :host=>'localhost', :port=>24224) +log.post("access", {"agent"=>"foo"}) + +# output: myapp.access {"agent":"foo"} +``` + +## Loggers + +### Fluent +```ruby +Fluent::Logger::FluentLogger.open('tag_prefix', :host=>'localhost', :port=24224) +``` + +### Console +```ruby +Fluent::Logger::ConsoleLogger.open(io) +``` + +### Null +```ruby +Fluent::Logger::NullLogger.open +``` + +|name|description| +|---|---| +|Web site|http://fluent.github.com/| +|Documents|http://fluent.github.com/doc/| +|Source repository|https://github.com/fluent/fluent-logger-ruby| +|Author|Sadayuki Furuhashi| +|Copyright|(c) 2011 FURUHASHI Sadayuki| +|License|Apache License, Version 2.0| diff --git a/README.rdoc b/README.rdoc deleted file mode 100644 index 29dd29c..0000000 --- a/README.rdoc +++ /dev/null @@ -1,57 +0,0 @@ -= Fluent logger - -A structured event loger - -== Examples - -=== Simple - - require 'fluent-logger' - - log = Fluent::Logger::FluentLogger.new(nil, :host=>'localhost', :port=>24224) - unless log.post("myapp.access", {"agent"=>"foo"}) - p log.last_error # You can get last error object via last_error method - end - - # output: myapp.access {"agent":"foo"} - -=== Singleton - - require 'fluent-logger' - - Fluent::Logger::FluentLogger.open(nil, :host=>'localhost', :port=>24224) - Fluent::Logger.post("myapp.access", {"agent"=>"foo"}) - - # output: myapp.access {"agent":"foo"} - -=== Tag prefix - - require 'fluent-logger' - - log = Fluent::Logger::FluentLogger.new('myapp', :host=>'localhost', :port=>24224) - log.post("access", {"agent"=>"foo"}) - - # output: myapp.access {"agent":"foo"} - -== Loggers - -=== Fluent - - Fluent::Logger::FluentLogger.open('tag_prefix', :host=>'localhost', :port=24224) - -=== Console - - Fluent::Logger::ConsoleLogger.open(io) - -=== Null - - Fluent::Logger::NullLogger.open - - -Web site:: http://fluent.github.com/ -Documents:: http://fluent.github.com/doc/ -Source repository:: https://github.com/fluent/fluent-logger-ruby -Author:: Sadayuki Furuhashi -Copyright:: (c) 2011 FURUHASHI Sadayuki -License:: Apache License, Version 2.0 -