grape_logging 1.1.2 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b3bf40b45307865cbd2c98fe98ca4a8a3a4d159
-  data.tar.gz: 116be8f340bab2a4d7b7b66bc1aba888a35db947
+  metadata.gz: 59face7f1f95aa107acdf703dbc1f3b7cd7a7089
+  data.tar.gz: ddbc3faa4075116e49201ed0e42a8a484fe6f0bb
 SHA512:
-  metadata.gz: 29a8feba5650aa2034a30263bae9dab1e1810053e0df49d7a4e7224d569645c9002434f35aea875753d50c46d8cd869cded6aadaffdddd63fc06178f24474a28
-  data.tar.gz: 5cc8354ea7119b4e11b1619bb6795931e7f7f88f59392cd61bcd4ee76d3e4a825302ebef975a3908a267e0e8210ad62457a5477e9441cfb68b5bdd05a32ca3b7
+  metadata.gz: 80f4eea80aa5b7cdee7e6e2f45ec1a52c35c41839f67988fa89a70290b6706547cc4a664cce4a0dea136fd5d56b6bc266e8d592176b732e94527c8731c038219
+  data.tar.gz: 6effcdf54c98000c0b8417ea2f02c6a707054ade7e66c035cc55e68ee721d5d25cf9d81c34683545f1a31c88d8bc6a433219600164369078294c3b48fc92b8ed

data/README.md

@@ -10,7 +10,7 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -19,10 +19,12 @@ 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 }
 
+**ProTip:** If your logger doesn't support setting formatter you can remove this line - it's optional
 
 ## Features
 
@@ -34,11 +36,55 @@ With the default configuration you will get nice log message
 
 If you prefer some other format I strongly encourage you to do pull request with new formatter class ;)
 
+You can change the formatter like so
+
+    class MyAPI < Grape::API
+      use GrapeLogging::Middleware::RequestLogger, logger: logger, format: MyFormatter.new
+    end
+
+### Customising What Is Logged
+
+You can include logging of other parts of the request / response cycle by including subclasses of `GrapeLogging::Loggers::Base`
+
+    class MyAPI < Grape::API
+      use GrapeLogging::Middleware::RequestLogger,
+        logger: logger,
+        include: [ GrapeLogging::Loggers::Response.new,
+                   GrapeLogging::Loggers::FilterParameters.new ]
+    end
+
+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.
+
 ### Logging to file and STDOUT
 
-You can to file and STDOUT at the same time, you just need to assign new logger
+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.
+First, config ```grape_logging```, like that:
 
-    logger Logger.new GrapeLogging::MultiIO.new(STDOUT, File.open('path/to/your/logfile.log', 'a'))
+    class MyAPI < Grape::API
+      use GrapeLogging::Middleware::RequestLogger,
+        instrumentation_key: 'grape_key',
+        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

@@ -1,4 +1,11 @@
 require 'grape_logging/multi_io'
 require 'grape_logging/version'
 require 'grape_logging/formatters/default'
-require 'grape_logging/middleware/request_logger'
+require 'grape_logging/formatters/json'
+require 'grape_logging/loggers/base'
+require 'grape_logging/loggers/response'
+require 'grape_logging/loggers/filter_parameters'
+require 'grape_logging/reporters/active_support_reporter'
+require 'grape_logging/reporters/logger_reporter'
+require 'grape_logging/timings'
+require 'grape_logging/middleware/request_logger'

data/lib/grape_logging/formatters/default.rb

@@ -11,7 +11,7 @@ module GrapeLogging
         elsif data.is_a?(Exception)
           format_exception(data)
         elsif data.is_a?(Hash)
-          "#{data.delete(:status)} -- total=#{data.delete(:total)} db=#{data.delete(:db)} -- #{data.delete(:method)} #{data.delete(:path)} #{format_hash(data)}"
+          "#{data.delete(:status)} -- #{format_hash(data.delete(:time))} -- #{data.delete(:method)} #{data.delete(:path)} #{format_hash(data)}"
         else
           data.inspect
         end
@@ -28,4 +28,4 @@ module GrapeLogging
       end
     end
   end
-end
+end

data/lib/grape_logging/formatters/json.rb

@@ -0,0 +1,33 @@
+module GrapeLogging
+  module Formatters
+    class Json
+      def call(severity, datetime, _, data)
+        {
+          date: datetime,
+          severity: severity,
+          data: format(data)
+        }.to_json
+      end
+
+      private
+
+      def format(data)
+        if data.is_a?(String) || data.is_a?(Hash)
+          data
+        elsif data.is_a?(Exception)
+          format_exception(data)
+        else
+          data.inspect
+        end
+      end
+
+      def format_exception(exception)
+        {
+          exception: {
+            message: exception.message
+          }
+        }
+      end
+    end
+  end
+end

data/lib/grape_logging/loggers/base.rb

@@ -0,0 +1,9 @@
+module GrapeLogging
+  module Loggers
+    class Base
+      def parameters(request, response)
+        {}
+      end
+    end
+  end
+end

data/lib/grape_logging/loggers/filter_parameters.rb

@@ -0,0 +1,24 @@
+module GrapeLogging
+  module Loggers
+    class FilterParameters < GrapeLogging::Loggers::Base
+      def initialize(filter_parameters = nil, replacement = '[FILTERED]')
+        @filter_parameters = filter_parameters || (defined?(Rails.application) ? Rails.application.config.filter_parameters : [])
+        @replacement = replacement
+      end
+
+      def parameters(request, _)
+        { params: replace_parameters(request.params.clone) }
+      end
+
+      private
+      def replace_parameters(parameters)
+        @filter_parameters.each do |parameter_name|
+          if parameters.key?(parameter_name.to_s)
+            parameters[parameter_name.to_s] = @replacement
+          end
+        end
+        parameters
+      end
+    end
+  end
+end

data/lib/grape_logging/loggers/response.rb

@@ -0,0 +1,21 @@
+module GrapeLogging
+  module Loggers
+    class Response < GrapeLogging::Loggers::Base
+      def parameters(_, response)
+        response ? { response: serialized_response_body(response) } : {}
+      end
+
+      private
+      # In some cases, response.body is not parseable by JSON.
+      # For example, if you POST on a PUT endpoint, response.body is egal to """".
+      # It's strange but it's the Grape behavior...
+      def serialized_response_body(response)
+        begin
+          response.body.map{ |body| JSON.parse(body.to_s) }
+        rescue => e
+          response.body
+        end
+      end
+    end
+  end
+end

data/lib/grape_logging/middleware/request_logger.rb

@@ -3,45 +3,66 @@ require 'grape/middleware/base'
 module GrapeLogging
   module Middleware
     class RequestLogger < Grape::Middleware::Base
+
+      ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
+        event = ActiveSupport::Notifications::Event.new(*args)
+        GrapeLogging::Timings.append_db_runtime(event)
+      end if defined?(ActiveRecord)
+
+      def initialize(app, options = {})
+        super
+
+        @included_loggers = @options[:include] || []
+        @reporter = if options[:instrumentation_key]
+          Reporters::ActiveSupportReporter.new(@options[:instrumentation_key])
+        else
+          Reporters::LoggerReporter.new(@options[:logger], @options[:formatter])
+        end
+      end
+
       def before
+        reset_db_runtime
         start_time
 
-        @db_duration = 0
-        @subscription = ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
-          event = ActiveSupport::Notifications::Event.new(*args)
-          @db_duration += event.duration
-        end if defined?(ActiveRecord)
+        invoke_included_loggers(:before)
       end
 
       def after
         stop_time
-        logger.info parameters
+        @reporter.perform(collect_parameters)
+        invoke_included_loggers(:after)
         nil
       end
 
       def call!(env)
         super
-      ensure
-        ActiveSupport::Notifications.unsubscribe(@subscription) if @subscription
       end
 
       protected
+
+      def response
+        begin
+          super
+        rescue
+          nil
+        end
+      end
+
       def parameters
         {
-            path: request.path,
-            params: request.params.to_hash,
-            method: request.request_method,
+          status: response.nil? ? 'fail' : response.status,
+          time: {
             total: total_runtime,
-            db: @db_duration.round(2),
-            status: response.status
+            db: db_runtime,
+            view: view_runtime
+          },
+          method: request.request_method,
+          path: request.path,
+          params: request.params
         }
       end
 
       private
-      def logger
-        @logger ||= @options[:logger] || Logger.new(STDOUT)
-      end
-
       def request
         @request ||= ::Rack::Request.new(env)
       end
@@ -50,6 +71,18 @@ module GrapeLogging
         ((stop_time - start_time) * 1000).round(2)
       end
 
+      def view_runtime
+        total_runtime - db_runtime
+      end
+
+      def db_runtime
+        GrapeLogging::Timings.db_runtime.round(2)
+      end
+
+      def reset_db_runtime
+        GrapeLogging::Timings.reset_db_runtime
+      end
+
       def start_time
         @start_time ||= Time.now
       end
@@ -57,6 +90,22 @@ module GrapeLogging
       def stop_time
         @stop_time ||= Time.now
       end
+
+      def collect_parameters
+        parameters.tap do |params|
+          @included_loggers.each do |logger|
+            params.merge! logger.parameters(request, response) do |_, oldval, newval|
+              oldval.respond_to?(:merge) ? oldval.merge(newval) : newval
+            end
+          end
+        end
+      end
+
+      def invoke_included_loggers(method_name)
+        @included_loggers.each do |logger|
+          logger.send(method_name) if logger.respond_to?(method_name)
+        end
+      end
     end
   end
-end
+end

data/lib/grape_logging/reporters/active_support_reporter.rb

@@ -0,0 +1,11 @@
+module Reporters
+  class ActiveSupportReporter
+    def initialize(instrumentation_key)
+      @instrumentation_key = instrumentation_key
+    end
+
+    def perform(params)
+      ActiveSupport::Notifications.instrument @instrumentation_key, params
+    end
+  end
+end

data/lib/grape_logging/reporters/logger_reporter.rb

@@ -0,0 +1,12 @@
+module Reporters
+  class LoggerReporter
+    def initialize(logger, formatter)
+      @logger = logger || Logger.new(STDOUT)
+      @logger.formatter = formatter || GrapeLogging::Formatters::Default.new if @logger.respond_to?(:formatter=)
+    end
+
+    def perform(params)
+      @logger.info params
+    end
+  end
+end

data/lib/grape_logging/timings.rb

@@ -0,0 +1,21 @@
+module GrapeLogging
+  module Timings
+    extend self
+
+    def db_runtime=(value)
+      Thread.current[:grape_db_runtime] = value
+    end
+
+    def db_runtime
+      Thread.current[:grape_db_runtime] ||= 0
+    end
+
+    def reset_db_runtime
+      self.db_runtime = 0
+    end
+
+    def append_db_runtime(event)
+      self.db_runtime += event.duration
+    end
+  end
+end

data/lib/grape_logging/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape_logging
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.1
 platform: ruby
 authors:
 - aserafin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2016-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -68,12 +68,18 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- grape_logging-1.1.1.gem
 - grape_logging.gemspec
 - lib/grape_logging.rb
 - lib/grape_logging/formatters/default.rb
+- lib/grape_logging/formatters/json.rb
+- lib/grape_logging/loggers/base.rb
+- lib/grape_logging/loggers/filter_parameters.rb
+- lib/grape_logging/loggers/response.rb
 - lib/grape_logging/middleware/request_logger.rb
 - lib/grape_logging/multi_io.rb
+- lib/grape_logging/reporters/active_support_reporter.rb
+- lib/grape_logging/reporters/logger_reporter.rb
+- lib/grape_logging/timings.rb
 - lib/grape_logging/version.rb
 homepage: http://github.com/aserafin/grape_logging
 licenses: