zgcp_toolkit 1.1.0 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 691381f36c471f3cfbf429041d6fb30398115834b1e7f996a92bdb62a5c189f3
-  data.tar.gz: f07d99fdbea33895b07542d9744c5682e499ffdb3c2f7bdaea216f3a146f330a
+  metadata.gz: e1a9df2f0bcc6d3287fbe692e9e2c4fc9f6709302b3d6e43b6b5962e78571351
+  data.tar.gz: 3253cdf248c707f9bd4c8e11c97d621fe224f12c80132bef53ec137f70f30780
 SHA512:
-  metadata.gz: fb1188320cfcc660b9dde35e862c51fcb4ff81d2fef9cd3bce349f3b1e6ad8f2c7f1c59716eab35067209a85e55ffe2b0577a07d555fa6bddcc836b4589da210
-  data.tar.gz: 95cf1705da9ce68c5c4ae128cff61933e840096604db4a77e3668c72541a733c505ba535b4711669a643f92fa6b71549e8555c347980c299a5849bdfe1089423
+  metadata.gz: d43f0d91122f12bbe3e160bb57643705ab21d039c5be263d5da333da90e405f4d33b57ca15cc4268a6121b1c8c3fe8000180d71a465983a178cd812aa1aa24c3
+  data.tar.gz: 32993c081275fb71b82b9e102b5dda2696781cda57b03d9527daa94ec5324867a81a07b5834190f3384869176262e6f7e2bcb83e622c5e4e533253c24f9e6f9e

data/README.md

@@ -6,6 +6,7 @@ Manage integration between Rails & Google Cloud services.
 Add this line to your application's Gemfile:
 
 ```ruby
+gem 'stackdriver' # Stackdriver gem auto installs middlewares to catch errors if you are running a Rails app.
 gem 'zgcp_toolkit'
 ```
 
@@ -42,23 +43,10 @@ end
 logger = ZgcpToolkit::Logger.new(:log_name)
 logger.info("Heyyyyyy!")
 logger.error(message: "Heyyyyy!", backtrace: ["line-1", "line-2"])
-logger.error(message: "Hello Bug !!", backtrace: ["line-1", "line-2"], push_slack: true)
+logger.error(message: "Hello Bug !!", backtrace: ["line-1", "line-2"])
 logger.warn("Hey hey nyc!")
 ```
 
-- Set `send_unexpected_error_to_slack` to `false` will delete `push_slack` key from unexpected error log.
-
-```ruby
-namespace :test_log do 
-  task do: :environment
-    ZgcpToolkit::Logger.create(:log_name) do |logger|
-      logger.send_unexpected_error_to_slack = false
-      raise 'errors'
-    end
-  end
-end
-```
-
 ### Controller
 
 You can send controller errors to Google Cloud Loggings
@@ -69,11 +57,8 @@ You can send controller errors to Google Cloud Loggings
 rescue_from StandardError do |e|
   raise e if Rails.env.development?
 
-  logger = ZgcpToolkit::Logger.new(Rails.env)
-  logger.error_request(e, request)
-
-  # If you want send notity to slack 
-  # logger.error_request(e, request, push_slack: true)
+  # Useful ENV information will also be sent along with the error
+  ZgcpToolkit::Logger.report_error_request(e, request)
 
   head :internal_server_error
 end

data/lib/zgcp_toolkit.rb

@@ -3,5 +3,6 @@ require "zgcp_toolkit/version"
 module ZgcpToolkit; end
 
 require 'zgcp_toolkit/logger'
+require 'zgcp_toolkit/formatter/request'
 require 'zgcp_toolkit/generators/templates/zgcp_toolkit'
 require 'zgcp_toolkit/generators/zgcp_toolkit_generator'

data/lib/zgcp_toolkit/formatter/request.rb

@@ -0,0 +1,101 @@
+module ZgcpToolkit::Formatter
+  class Request
+    FILTERED_ENV_LIST = %w(
+      CONTENT_LENGTH
+      CONTENT_TYPE
+      HTTP_ACCEPT
+      HTTP_ACCEPT_ENCODING
+      HTTP_ACCEPT_LANGUAGE
+      HTTP_CACHE_CONTROL
+      HTTP_COOKIE
+      HTTP_HOST
+      HTTP_ORIGIN
+      HTTP_REFERER
+      HTTP_SEC_CH_UA
+      HTTP_SEC_CH_UA_MOBILE
+      HTTP_SEC_FETCH_DEST
+      HTTP_SEC_FETCH_MODE
+      HTTP_SEC_FETCH_SITE
+      HTTP_SEC_FETCH_USER
+      HTTP_UPGRADE_INSECURE_REQUESTS
+      HTTP_USER_AGENT
+      HTTP_VERSION
+      HTTP_VIA
+      HTTP_X_FORWARDED_FOR
+      HTTP_X_FORWARDED_PROTO
+      ORIGINAL_FULLPATH
+      ORIGINAL_SCRIPT_NAME
+      PATH_INFO
+      QUERY_STRING
+      REMOTE_ADDR
+      REMOTE_PORT
+      REQUEST_METHOD
+      REQUEST_URI
+      SERVER_NAME
+      SERVER_PORT
+      SERVER_PROTOCOL
+    ).freeze
+
+    def call(request)
+      log_object = {}
+      log_object[:request]     = request_filter(request)
+      log_object[:session]     = session_filter(request)
+      log_object[:environment] = environment_filter(request)
+      log_object
+    end
+
+    def format_for_report(request)
+      log_object = {}
+      log_object[:request]     = beauty_format request_filter(request)
+      log_object[:session]     = beauty_format session_filter(request)
+      log_object[:environment] = beauty_format separation_environment_filter(request)
+
+      result = log_object.map { |key, value| "#{key.capitalize}:\n#{value}\n" }
+      result.join("\n")
+    end
+
+    private
+
+    def beauty_format(data)
+      data.map { |k,v| "#{k.to_s.indent(4)}: #{v}" }.join("\n")
+    end
+
+    def environment_filter(request)
+      result = {}
+      request.filtered_env.keys.each do |key|
+        result[key] = request.filtered_env[key]
+      end
+      result
+    end
+
+    def separation_environment_filter(request)
+      result = {}
+      FILTERED_ENV_LIST.each do |key|
+        result[key] = request.filtered_env[key]
+      end
+      result
+    end
+
+    def session_filter(request)
+      result = {}
+      result[:session_id]   = request.ssl? ? "[FILTERED]" : request.session['session_id'] || request.env['rack.session.options'][:id].inspect
+      result[:data_session] = request.session.to_hash
+      result
+    end
+
+    def request_filter(request)
+      result = {}
+      result[:url]            = request.url
+      result[:request_method] = request.request_method
+      result[:ip_address]     = request.remote_ip
+      result[:parameters]     = request.filtered_parameters.inspect
+      result[:timestamp]      = Time.current
+      result[:server]         = Socket.gethostname
+      result[:process]        = $$
+      if defined?(Rails) && Rails.respond_to?(:root)
+        result[:rails_root] = Rails.root
+      end
+      result
+    end
+  end
+end

data/lib/zgcp_toolkit/generators/templates/zgcp_toolkit.rb

@@ -1,5 +1,7 @@
-loggers = [:std_out]
-
-loggers.push(:google_cloud_logging) unless Rails.env.development?
+if Rails.env.development? || Rails.env.test?
+  loggers = [:std_out]
+else
+  loggers = [:google_cloud_logging]
+end
 
 ZgcpToolkit::Logger.config.registered_loggers = loggers

data/lib/zgcp_toolkit/logger.rb

@@ -1,4 +1,5 @@
 require 'dry/configurable'
+require "google/cloud/error_reporting"
 require 'zgcp_toolkit/logger/stdout'
 require 'zgcp_toolkit/logger/google_cloud_logging'
 
@@ -30,13 +31,20 @@ module ZgcpToolkit
         begin
           yield(logger) if block_given?
         rescue StandardError => e
-          logger.error(e, push_slack: logger.send_unexpected_error_to_slack)
-          logger.flush!
+          Google::Cloud::ErrorReporting.report e
         end
 
         logger
       end
 
+      def report_error_request(error, request)
+        message = ZgcpToolkit::Formatter::Request.new.format_for_report(request)
+
+        Google::Cloud::ErrorReporting.report error do |event|
+          event.message = event.message + "\n\n" + message
+        end
+      end
+  
       private
 
       def valid_name?(log_name)
@@ -47,29 +55,28 @@ module ZgcpToolkit
 
     DEFAULT_BACKTRACE_LIMIT = 10
 
-    attr_accessor :send_unexpected_error_to_slack, :backtrace_limit
+    attr_accessor :backtrace_limit
     attr_reader :loggers, :log_name
 
     def initialize(log_name)
       @log_name = log_name
-      @send_unexpected_error_to_slack = true
       @backtrace_limit = DEFAULT_BACKTRACE_LIMIT
       @loggers = ZgcpToolkit::Logger.registered_loggers.map { |logger| logger.new(log_name) }
     end
 
     [:debug, :info, :warn, :error, :fatal, :unknown].each do |log_level_method|
-      define_method(log_level_method) do |log, push_slack: false|
+      define_method(log_level_method) do |log, **kwargs|
         log_object =
           case log
           when StandardError
             obj = { message: log.message, backtrace: log.backtrace.first(backtrace_limit) }
-            obj.merge!(push_slack: true) if push_slack
+            obj.merge!(kwargs)
             obj
           when Hash
             log
           when String
             obj = { message: log }
-            obj.merge!(push_slack: true) if push_slack
+            obj.merge!(kwargs)
             obj
           else
             raise UnsupportedLogType, "#{log.class.name} is not supported!"
@@ -79,7 +86,7 @@ module ZgcpToolkit
     end
 
     def error_request(error, request, **args)
-      filter_request_params = format_request_env(request)
+      filter_request_params = ZgcpToolkit::Formatter::Request.new.call(request)
 
       error({ message: error.message, backtrace: error.backtrace.first(backtrace_limit) }.merge!(filter_request_params).merge!(args))
     end
@@ -87,45 +94,5 @@ module ZgcpToolkit
     def flush!
       loggers.each { |a| a.flush! }
     end
-
-    private
-
-    def format_request_env(request)
-      log_object = {}
-      log_object[:request]     = request_filter(request)
-      log_object[:session]     = session_filter(request)
-      log_object[:environment] = environment_filter(request)
-      log_object
-    end
-
-    def environment_filter(request)
-      result = {}
-      request.filtered_env.keys.each do |key|
-        result[key] = request.filtered_env[key]
-      end
-      result
-    end
-
-    def session_filter(request)
-      result = {}
-      result[:session_id]   = request.ssl? ? "[FILTERED]" : request.session['session_id'] || request.env['rack.session.options'][:id].inspect
-      result[:data_session] = request.session.to_hash
-      result
-    end
-
-    def request_filter(request)
-      result = {}
-      result[:url]            = request.url
-      result[:request_method] = request.request_method
-      result[:ip_address]     = request.remote_ip
-      result[:parameters]     = request.filtered_parameters.inspect
-      result[:timestamp]      = Time.current
-      result[:server]         = Socket.gethostname
-      result[:process]        = $$
-      if defined?(Rails) && Rails.respond_to?(:root)
-        result[:rails_root] = Rails.root
-      end
-      result
-    end
   end
 end

data/lib/zgcp_toolkit/version.rb

@@ -1,3 +1,3 @@
 module ZgcpToolkit
-  VERSION = '1.1.0'
+  VERSION = '1.2.3'
 end

data/zgcp_toolkit.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'stackdriver', '~> 0.20.1'
   spec.add_dependency 'dry-configurable', '~> 0.11.6'
+  spec.add_dependency 'google-cloud-error_reporting', '~> 0.42.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zgcp_toolkit
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.3
 platform: ruby
 authors:
 - ZIGExN VeNtura developers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-09 00:00:00.000000000 Z
+date: 2021-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stackdriver
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.11.6
+- !ruby/object:Gem::Dependency
+  name: google-cloud-error_reporting
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.42.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.42.0
 description: Manage essential toolset
 email: kuruma-dev@zigexn.vn
 executables: []
@@ -55,6 +69,7 @@ files:
 - bin/console
 - bin/setup
 - lib/zgcp_toolkit.rb
+- lib/zgcp_toolkit/formatter/request.rb
 - lib/zgcp_toolkit/generators/templates/zgcp_toolkit.rb
 - lib/zgcp_toolkit/generators/zgcp_toolkit_generator.rb
 - lib/zgcp_toolkit/logger.rb
@@ -83,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: GCP Toolkit