grape_logging 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1ffd8bd8e43e3c62b4ea629ff034db37f60f4e5
-  data.tar.gz: e57a2e7ee7937252d33c921ea97d8c820233889d
+  metadata.gz: cb31f81ee7d41a9964530d7cdadae6e24b2c1005
+  data.tar.gz: 7c61c14042a4c77da0b56c0e8f2922af7a0b48d0
 SHA512:
-  metadata.gz: 79619111ac1fe3148fb631770e88da6e3b74f06447f15969194776dc7926107e3b32d1ae9feaa1c61b62e406771e9aece3c6a7d17e83d0a4c21f0d29e666318d
-  data.tar.gz: 8d3777d6d64f1450de33795f6aebaddce650afb7d5d52fc2907a1090a268a38d38ba5c826417bd252289a9fc7b35be29a685500b6d6b252a857bd31778130529
+  metadata.gz: 1ed98f125bcb8df6908407bf820add0566c9e980e2e89d48c7c4c29378174edf5eae51d18e56d27fa90937cf7b8442306ff5cd2aa0a4d7f04fd70e2611b92329
+  data.tar.gz: 9d5091d60125bc91edfd4dca9b28a0a8ff83807d695b1987b9f564e784ba1a7f709f994563dd2d0d7a260fcebb5033a6a1a1f4cb0c4be27c1958070c3fda0f33

data/README.md

@@ -33,11 +33,83 @@ use GrapeLogging::Middleware::RequestLogger, { logger: logger }
 
 ### Log Format
 
-With the default configuration you will get nice log message
+There are formatters provided for you, or you can provide your own.
+
+#### `GrapeLogging::Formatters::Default`
+
+    [2015-04-16 12:52:12 +0200] INFO -- 200 -- total=2.06 db=0.36 -- PATCH /api/endpoint params={"some_param"=>{"value_1"=>"123", "value_2"=>"456"}}
+
+#### `GrapeLogging::Formatters::Json`
+
+```json
+{
+  "date": "2015-04-16 12:52:12+0200",
+  "severity": "INFO",
+  "data": {
+    "status": 200,
+    "time": {
+      "total": 2.06,
+      "db": 0.36,
+      "view": 1.70
+    },
+    "method": "PATCH",
+    "path": "/api/endpoint",
+    "params": {
+      "value_1": "123",
+      "value_2": "456"
+    },
+    "host": "localhost"
+  }
+}
+```
+
+#### `GrapeLogging::Formatters::Lograge`
+
+    severity="INFO", duration=2.06, db=0.36, view=1.70, datetime="2015-04-16 12:52:12+0200", status=200, method="PATCH", path="/api/endpoint", params={}, host="localhost"
+
+#### `GrapeLogging::Formatters::Logstash`
+
+```json
+{
+  "@timestamp": "2015-04-16 12:52:12+0200",
+  "severity": "INFO",
+  "status": 200,
+  "time": {
+    "total": 2.06,
+    "db": 0.36,
+    "view": 1.70
+  },
+  "method": "PATCH",
+  "path": "/api/endpoint",
+  "params": {
+    "value_1": "123",
+    "value_2": "456"
+  },
+  "host": "localhost"
+}
+```
 
-    [2015-04-16 12:52:12 +0200] INFO -- 200 -- total=2.06 db=0.36 -- PATCH /your_app/endpoint params={"some_param"=>{"value_1"=>"123", "value_2"=>"456"}}
+#### `GrapeLogging::Formatters::Rails`
 
-If you prefer some other format I strongly encourage you to do pull request with new formatter class ;)
+Rails will print the "Started..." line:
+
+    Started GET "/api/endpoint" for ::1 at 2015-04-16 12:52:12 +0200
+      User Load (0.7ms)  SELECT "users".* FROM "users" WHERE  "users"."id" = $1
+      ...
+
+The `Rails` formatter adds the last line of the request, like a standard Rails request:
+
+    Completed 200 OK in 349ms (Views: 250.1ms | DB: 98.63ms)
+
+#### Custom
+
+You can provide your own class that implements the `call` method returning a `String`:
+
+```ruby
+def call(severity, datetime, _, data)
+   ...
+end
+```
 
 You can change the formatter like so
 ```ruby
@@ -46,6 +118,8 @@ class MyAPI < Grape::API
 end
 ```
 
+If you prefer some other format I strongly encourage you to do pull request with new formatter class ;)
+
 ### Customising What Is Logged
 
 You can include logging of other parts of the request / response cycle by including subclasses of `GrapeLogging::Loggers::Base`

data/grape_logging.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'grape'
+  spec.add_dependency 'rack'
 
   spec.add_development_dependency 'bundler', '~> 1.8'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/grape_logging.rb

@@ -4,6 +4,7 @@ require 'grape_logging/formatters/default'
 require 'grape_logging/formatters/json'
 require 'grape_logging/formatters/lograge'
 require 'grape_logging/formatters/logstash'
+require 'grape_logging/formatters/rails'
 require 'grape_logging/loggers/base'
 require 'grape_logging/loggers/response'
 require 'grape_logging/loggers/filter_parameters'

data/lib/grape_logging/formatters/rails.rb

@@ -0,0 +1,59 @@
+require 'rack/utils'
+
+module GrapeLogging
+  module Formatters
+    class Rails
+
+      def call(severity, datetime, _, data)
+        if data.is_a?(String)
+          "#{severity[0..0]} [#{datetime}] #{severity} -- : #{data}\n"
+        elsif data.is_a?(Exception)
+          "#{severity[0..0]} [#{datetime}] #{severity} -- : #{format_exception(data)}\n"
+        elsif data.is_a?(Hash)
+          format_hash(data)
+        else
+          "#{data.inspect}\n"
+        end
+      end
+
+      private
+
+      def format_exception(exception)
+        backtrace_array = (exception.backtrace || []).map { |line| "\t#{line}" }
+
+        [
+          "#{exception.message} (#{exception.class})",
+          backtrace_array.join("\n")
+        ].reject{|line| line == ""}.join("\n")
+      end
+
+      def format_hash(hash)
+        # Create Rails' single summary line at the end of every request, formatted like:
+        # Completed 200 OK in 958ms (Views: 951.1ms | ActiveRecord: 3.8ms)
+        # See: actionpack/lib/action_controller/log_subscriber.rb
+
+        message = ""
+        additions = []
+        status = hash.delete(:status)
+        params = hash.delete(:params)
+
+        total_time = hash[:time] && hash[:time][:total] && hash[:time][:total].round(2)
+        view_time  = hash[:time] && hash[:time][:view]  && hash[:time][:view].round(2)
+        db_time    = hash[:time] && hash[:time][:db]    && hash[:time][:db].round(2)
+
+        additions << "Views: #{view_time}ms" if view_time
+        additions << "DB: #{db_time}ms"      if db_time
+
+        message << "  Parameters: #{params.inspect}\n" if params
+
+        message << "Completed #{status} #{::Rack::Utils::HTTP_STATUS_CODES[status]} in #{total_time}ms"
+        message << " (#{additions.join(" | ".freeze)})" if additions.size > 0
+        message << "\n"
+        message << "\n" if defined?(::Rails.env) && ::Rails.env.development?
+
+        message
+      end
+
+    end
+  end
+end

data/lib/grape_logging/loggers/filter_parameters.rb

@@ -4,7 +4,7 @@ module GrapeLogging
       AD_PARAMS = 'action_dispatch.request.parameters'.freeze
 
       def initialize(filter_parameters = nil, replacement = nil, exceptions = %w(controller action format))
-        @filter_parameters = filter_parameters || (defined?(Rails.application) ? Rails.application.config.filter_parameters : [])
+        @filter_parameters = filter_parameters || (defined?(::Rails.application) ? ::Rails.application.config.filter_parameters : [])
         @replacement = replacement || '[FILTERED]'
         @exceptions = exceptions
       end

data/lib/grape_logging/loggers/request_headers.rb

@@ -17,7 +17,6 @@ module GrapeLogging
         { headers: headers }
       end
 
-
     end
   end
 end

data/lib/grape_logging/util/parameter_filter.rb

@@ -1,4 +1,4 @@
-if defined?(Rails.application)
+if defined?(::Rails.application)
   class ParameterFilter < ActionDispatch::Http::ParameterFilter
     def initialize(_replacement, filter_parameters)
       super(filter_parameters)

data/lib/grape_logging/version.rb

@@ -1,3 +1,3 @@
 module GrapeLogging
-  VERSION = '1.7.0'
+  VERSION = '1.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape_logging
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - aserafin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-10 00:00:00.000000000 Z
+date: 2018-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +117,7 @@ files:
 - lib/grape_logging/formatters/json.rb
 - lib/grape_logging/formatters/lograge.rb
 - lib/grape_logging/formatters/logstash.rb
+- lib/grape_logging/formatters/rails.rb
 - lib/grape_logging/loggers/base.rb
 - lib/grape_logging/loggers/client_env.rb
 - lib/grape_logging/loggers/filter_parameters.rb