Merge pull request #26 from scauglog/master

add logger for client ip and ua

README.md

@@ -50,11 +50,16 @@ You can include logging of other parts of the request / response cycle by includ
       use GrapeLogging::Middleware::RequestLogger,
         logger: logger,
         include: [ GrapeLogging::Loggers::Response.new,
-                   GrapeLogging::Loggers::FilterParameters.new ]
+                   GrapeLogging::Loggers::FilterParameters.new,
+                   GrapeLogging::Loggers::ClientEnv.new ]
     end
 
+#### FilterParameters
 The `FilterParameters` logger will filter out sensitive parameters from your logs. If mounted inside rails, will use the `Rails.application.config.filter_parameters` by default. Otherwise, you must specify a list of keys to filter out.
 
+#### ClientEnv
+The `ClientEnv` logger will add `ip` and user agent `ua` in your log.
+
 ### Logging to file and STDOUT
 
 You can log to file and STDOUT at the same time, you just need to assign new logger

lib/grape_logging.rb

@@ -5,6 +5,7 @@ require 'grape_logging/formatters/json'
 require 'grape_logging/loggers/base'
 require 'grape_logging/loggers/response'
 require 'grape_logging/loggers/filter_parameters'
+require 'grape_logging/loggers/client_env'
 require 'grape_logging/reporters/active_support_reporter'
 require 'grape_logging/reporters/logger_reporter'
 require 'grape_logging/timings'

lib/grape_logging/loggers/client_env.rb

@@ -0,0 +1,9 @@
+module GrapeLogging
+  module Loggers
+    class ClientEnv < GrapeLogging::Loggers::Base
+      def parameters(request, _)
+        { ip: request.env["HTTP_X_FORWARDED_FOR"] || request.env["REMOTE_ADDR"], ua: request.env["HTTP_USER_AGENT"] }
+      end
+    end
+  end
+end