# Act::Fluent::Logger::Rails

Fluent logger.

## Supported versions

 * Rails 4 and 5

## Installation

Add this line to your application's Gemfile:

    gem 'influxdb-logger

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install influxdb-logger

## Usage

in config/environments/production.rb

    config.log_level = :info
    config.logger = InfluxdbLogger::Logger.
      new(log_tags: {
            ip: :ip,
            ua: :user_agent,
            uid: ->(request) { request.session[:uid] }
          })

Don't use config.log_tags.

### To define where to send messages to, either:

#### create config/fluent-logger.yml

    development:
      fluent_host:   '127.0.0.1'
      fluent_port:   24224
      tag:           'foo'
      messages_type: 'string'
      severity_key:  'level'     # default severity

    test:
      fluent_host:   '127.0.0.1'
      fluent_port:   24224
      tag:           'foo'
      messages_type: 'string'
      severity_key:  'level'     # default severity

    production:
      fluent_host:   '127.0.0.1'
      fluent_port:   24224
      tag:           'foo'
      messages_type: 'string'
      severity_key:  'level'     # default severity

#### set an environment variable FLUENTD_URL

    http://fluentd.example.com:42442/foo?messages_type=string&severity_key=level

#### pass a settings object to InfluxdbLogger::Logger.new

    config.logger = InfluxdbLogger::Logger.
      new(settings: {
            host: '127.0.0.1',
            port: 24224,
            tag: 'foo',
            messages_type: 'string',
            severity_key: 'level'
          })

### Setting

 * fluent_host: The host name of Fluentd.
 * fluent_port: The port number of Fluentd.
 * tag: The tag of the Fluentd event.
 * messages_type: The type of log messages. 'string' or 'array'.
   If it is 'string', the log messages is a String.
```
2013-01-18T15:04:50+09:00 foo {"messages":"Started GET \"/\" for 127.0.0.1 at 2013-01-18 15:04:49 +0900\nProcessing by TopController#index as HTML\nCompleted 200 OK in 635ms (Views: 479.3ms | ActiveRecord: 39.6ms)"],"severity":"INFO"}
```
   If it is 'array', the log messages is an Array.
```
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)"],"severity":"INFO"}
```
 * severity_key: The key of severity(DEBUG, INFO, WARN, ERROR).

You can add any tags at run time.

   logger[:foo] = "foo value"

### Usage as a standalone logger

Typical usage is as a replacement for the default Rails logger, in which case
messages are collected and flushed automatically as part of the request
lifecycle. If you wish to use it instead as a separate logger and log to it
manually then it is necessary to initialize with the `flush_immediately` flag.

```ruby
InfluxdbLogger::Logger.new(flush_immediately: true)
```


## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request