grape_logging 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59face7f1f95aa107acdf703dbc1f3b7cd7a7089
-  data.tar.gz: ddbc3faa4075116e49201ed0e42a8a484fe6f0bb
+  metadata.gz: fe992e3b160e737c3ad0d38a636252db026dbf97
+  data.tar.gz: fbbcd347c5846b25d4a737a964fb2600c4e8ac98
 SHA512:
-  metadata.gz: 80f4eea80aa5b7cdee7e6e2f45ec1a52c35c41839f67988fa89a70290b6706547cc4a664cce4a0dea136fd5d56b6bc266e8d592176b732e94527c8731c038219
-  data.tar.gz: 6effcdf54c98000c0b8417ea2f02c6a707054ade7e66c035cc55e68ee721d5d25cf9d81c34683545f1a31c88d8bc6a433219600164369078294c3b48fc92b8ed
+  metadata.gz: 35efe1809d92fa3a12d260f71306b8c2aa8f08254607ea2c46c9d3c2dcc38e5a8a009af0b4044f26660feae420b12ef5c0f4d17059d086227253cc2cc9a16000
+  data.tar.gz: a2021c9a92c8b4c4d96cf494b3ef27da4c17bb05c839d7c8e3c35660fbfbae9ba279380f66c173c7e863d110de7c959207367f180292258c3f218f1a72c6272e

data/README.md

@@ -19,7 +19,7 @@ Or install it yourself as:
 ## Basic Usage
 
 In your api file (somewhere on the top)
-    
+
     require 'grape_logging'
     logger.formatter = GrapeLogging::Formatters::Default.new
     use GrapeLogging::Middleware::RequestLogger, { logger: logger }
@@ -50,19 +50,28 @@ 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,
+                   GrapeLogging::Loggers::RequestHeaders.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.
+
+#### RequestHeaders
+The `RequestHeaders` logger will add `request headers` 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
-    
+
     log_file = File.open('path/to/your/logfile.log', 'a')
     log_file.sync = true
     logger Logger.new GrapeLogging::MultiIO.new(STDOUT, log_file)
-    
+
 ### Logging via Rails instrumentation
 
 You can choose to not pass the logger to ```grape_logging``` but instead send logs to Rails instrumentation in order to let Rails and its configured Logger do the log job, for example.
@@ -74,16 +83,16 @@ First, config ```grape_logging```, like that:
         include: [ GrapeLogging::Loggers::Response.new,
                    GrapeLogging::Loggers::FilterParameters.new ]
     end
-    
+
 and then add an initializer in your Rails project:
-    
+
     # config/initializers/instrumentation.rb
-    
+
     # Subscribe to grape request and log with Rails.logger
     ActiveSupport::Notifications.subscribe('grape_key') do |name, starts, ends, notification_id, payload|
       Rails.logger.info payload
     end
-   
+
 The idea come from here: https://gist.github.com/teamon/e8ae16ffb0cb447e5b49
 
 ### Logging exceptions

data/lib/grape_logging.rb

@@ -5,6 +5,8 @@ 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/loggers/request_headers'
 require 'grape_logging/reporters/active_support_reporter'
 require 'grape_logging/reporters/logger_reporter'
 require 'grape_logging/timings'

data/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

data/lib/grape_logging/loggers/request_headers.rb

@@ -0,0 +1,23 @@
+module GrapeLogging
+  module Loggers
+    class RequestHeaders < GrapeLogging::Loggers::Base
+
+      HTTP_PREFIX = 'HTTP_'.freeze
+
+      def parameters(request, _)
+        headers = {}
+
+        request.env.each_pair do |k, v|
+          next unless k.to_s.start_with? HTTP_PREFIX
+
+          k = k[5..-1].split('_').each(&:capitalize!).join('-')
+          headers[k] = v
+        end
+
+        { headers: headers }
+      end
+
+
+    end
+  end
+end

data/lib/grape_logging/version.rb

@@ -1,3 +1,3 @@
 module GrapeLogging
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape_logging
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - aserafin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-18 00:00:00.000000000 Z
+date: 2016-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -73,7 +73,9 @@ files:
 - lib/grape_logging/formatters/default.rb
 - lib/grape_logging/formatters/json.rb
 - lib/grape_logging/loggers/base.rb
+- lib/grape_logging/loggers/client_env.rb
 - lib/grape_logging/loggers/filter_parameters.rb
+- lib/grape_logging/loggers/request_headers.rb
 - lib/grape_logging/loggers/response.rb
 - lib/grape_logging/middleware/request_logger.rb
 - lib/grape_logging/multi_io.rb