gray_logger 0.9.5 → 0.10.0

data/README.md

@@ -34,15 +34,45 @@ GrayLogger is a small logging tool that allows you to simply log anything you wa
   ActionController::Base.send(:include, ::GrayLogger::HelperMethods)
   ````
 
+4. To install the gray_logger proxy:
+  ````ruby
+  config.logger = Rack::GrayLogger::Proxy.new(Syslogger.new("path..."))
+  ````
+
 ## Usage
 
 In Rails you can use the "gray_logger" method to add new fields to be logged to Graylog2.
 
-e.g.
-```ruby
-gray_logger.login_name = "darkswoop"
-```
+#### Buckets
+You can use buckets to collect fields and send them in one request to GrayLog2:
+
+````ruby
+gray_logger.bucket(:financial_data).account_nr = 123
+gray_logger.bucket(:financial_data).iban = 98767
+gray_logger.flush_bucket(:financial_data) # sends the collected fields as one log message to GrayLog2 and clears the bucket
+````
+When the request is finished all remaining buckets are send to GrayLog2 so you don't have to care if you only want to collect your data.
+
+#### After Request Log
+
+There is a special bucket that is used for logging possible exceptions and request information.
+When you are using the Rack::GrayLogger::Proxy the proxy will use this bucket to collect the loglines
+from the proxied logger. Feel free to add your own fields using:
+
+````ruby
+gray_logger.after_request_log.user_login = current_user.login
+````
+
+#### Automatic Logging
 
-After the request is finished and shortly before the response is send to the user GrayLogger will send your Log-Message to the Graylog2 server.
+Automatic Logging is enabled by default. That means after the request is done GrayLogger will automatically
+log to GrayLog2. If you don't want this automatic logging disable it by setting automatic_logging to false.
 
+````yaml
+development:
+  host: ...
+  port:  ...
+  facility: ...
+  automatic_logging: false
+````
 

data/lib/gray_logger/logger.rb

@@ -2,9 +2,12 @@ module GrayLogger
 
   class Logger < GELF::Logger
     include ::GrayLogger::Support
-    attr_reader :buckets
+    attr_reader :buckets, :automatic_logging
 
     def initialize(configuration={})
+      automatic_logging = configuration.delete(:automatic_logging)
+      @automatic_logging = automatic_logging.nil? ? true : automatic_logging
+
       defaults = {
         :size => "WAN",
         :facility => "facility-not-defined"
@@ -18,6 +21,15 @@ module GrayLogger
       @buckets = {}
     end
 
+    def automatic_logging?
+      !!@automatic_logging
+    end
+
+    def reset!
+      @buckets = {}
+      self
+    end
+
     # logger.after_request_log << {:my_field => 'field content'}
     # logger.after_request_log.my_field = 'field content'
     def after_request_log

data/lib/gray_logger/rack.rb

@@ -19,14 +19,18 @@ module Rack
         begin
           status, headers, body = @app.call(env)
         rescue => e
-          gray_logger.log_exception(e)
+          gray_logger.log_exception(e) if gray_logger.automatic_logging?
           raise
         ensure
           req = Rack::Request.new(env)
-          gray_logger.log_exception(env['rack.exception'])
-          gray_logger.after_request_log.status_code = status.to_i
-          gray_logger.after_request_log.short_message = "Request: #{req.path} (#{status.to_i})" if gray_logger.after_request_log[:short_message].nil?
-          gray_logger.flush
+          if gray_logger.automatic_logging?
+            gray_logger.log_exception(env['rack.exception'])
+            gray_logger.after_request_log.status_code = status.to_i
+            gray_logger.after_request_log.short_message = "Request: #{req.path} (#{status.to_i})" if gray_logger.after_request_log[:short_message].nil?
+            gray_logger.flush
+          else
+            gray_logger.reset!
+          end
           [status, headers, body]
         end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gray_logger
 version: !ruby/object:Gem::Version 
-  hash: 49
+  hash: 55
   prerelease: 
   segments: 
   - 0
-  - 9
-  - 5
-  version: 0.9.5
+  - 10
+  - 0
+  version: 0.10.0
 platform: ruby
 authors: 
 - Benjamin Behr