chihiro 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4666ee015ce32bb45f640b4dc1ff82db3c17a1f3ba4986a932bcff9ff909bc3
-  data.tar.gz: c4794aee5ebdff7120964ac0822ba5ab9a9bd454be88017e8256c50ea54255b9
+  metadata.gz: 19a0c1588e96239af86932d782fde853c350ed8ddb7eee1d878a00551e0ed96a
+  data.tar.gz: 7c38262b300d98a138bb51e833a71da78eedfd6e03e83aba157aac974bb48c8f
 SHA512:
-  metadata.gz: eba984700e135b559a0f8512b67d54ddfc4a9e05aefe8945dff053560646d1d607c020105d836e46cdf4d6834263780d5df8bff8b61403a840dadab507088ef0
-  data.tar.gz: a6dca929ced1a63d9994946609bc726defe140132d08cd19fa1e34c9cc72ba3c792137f2be36bb4608813ae4cbc01b2912ca5d457703bdbb7dea725ad2cc7ffb
+  metadata.gz: c4e36a40c4c9d4e40749664808efa5419660a5573804ff27e35751dbcda02a14d1a214ce55c72c5f33962309d7ad19287d9882efa615eeb1ed4218473f406d98
+  data.tar.gz: 3394d08f54bcbb7cba1dbde34f22a611317d8f5585708114ea2e46fe35424221477e27bac6f7bf5ee443f9e287ee9040ef843958d7a0b37222fa16ffa18bf13a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chihiro (0.2.0)
+    chihiro (0.3.0)
       lograge (~> 0.10)
 
 GEM

data/lib/chihiro/initializer.rb

@@ -16,11 +16,11 @@ module Chihiro
         config.lograge.enabled = true
         config.lograge.base_controller_class = 'ActionController::API'
         config.lograge.ignore_actions = ['HealthCheckController#index']
-        if ENV['RAILS_LOG_TO_STDOUT'].present?
-          logger = ActiveSupport::Logger.new(STDOUT)
-          logger.formatter = config.log_formatter
-          config.logger = logger
-        end
+
+        logger = ActiveSupport::Logger.new(STDOUT)
+        logger.formatter = config.log_formatter
+        config.logger = logger
+
       end
     end
   end

data/lib/chihiro/json_log_formatter.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Chihiro
-  class JsonLogFormatter < Logger::Formatter
+  class JsonLogFormatter < ::Logger::Formatter
     def call(severity, _time, _progname, msg)
       extra_log_data(msg).merge(
         level: severity.downcase,
@@ -16,7 +16,7 @@ module Chihiro
 
     def extra_log_data(msg)
       if msg.is_a? Hash
-        msg
+        MaskUtil.mask(msg)
       elsif msg.is_a? Exception
         { message: msg.message, backtrace: msg.backtrace }
       else

data/lib/chihiro/loggable.rb

@@ -0,0 +1,52 @@
+module Chihiro
+  module Loggable
+    extend ActiveSupport::Concern
+
+    included do
+      around_action :log_and_deal_exceptions
+    end
+
+    private
+
+    def log_and_deal_exceptions
+      log_request
+      yield
+      log_response
+    rescue => e
+      log_exception(e)
+      raise
+    end
+  
+    def log_request
+      to_log = {
+        message: 'Received API request',
+        requestPath: request.path
+      }
+      if Rails.configuration.no_log_param_paths.include?("#{controller_name}##{action_name}")
+        Rails.logger.info(to_log)
+      else
+        Rails.logger.info(to_log.merge(params: params.as_json))
+      end
+    end
+  
+    def log_response
+      to_log = {
+        message: 'Send API Response',
+        requestPath: request.path,
+        responseStatus: response.status.to_s
+      }
+      Rails.logger.info(to_log)
+    end
+  
+    def log_exception(e)
+      to_log = {
+        message: 'Catched exception in controller',
+        requestPath: request.path,
+        exceptionClass: e.class.to_s,
+        exceptionMessage: e.message,
+        backtrace: e.backtrace
+      }
+      Rails.logger.error(to_log)
+    end
+  end
+end

data/lib/chihiro/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chihiro
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/lib/chihiro.rb

@@ -4,6 +4,7 @@ require 'chihiro/version'
 require 'chihiro/initializer'
 require 'chihiro/mask_util'
 require 'chihiro/json_log_formatter'
+require 'chihiro/loggable'
 
 module Chihiro
   # Your code goes here...

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chihiro
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Shu Hui
@@ -99,6 +99,7 @@ files:
 - lib/chihiro.rb
 - lib/chihiro/initializer.rb
 - lib/chihiro/json_log_formatter.rb
+- lib/chihiro/loggable.rb
 - lib/chihiro/mask_util.rb
 - lib/chihiro/version.rb
 - lib/generators/chihiro/init_generator.rb
@@ -108,6 +109,7 @@ files:
 - pkg/chihiro-0.1.9.gem
 - pkg/chihiro-0.2.0.gem
 - pkg/chihiro-0.2.1.gem
+- pkg/chihiro-0.2.2.gem
 - spec/chihiro_spec.rb
 - spec/mask_util_spec.rb
 - spec/spec_helper.rb