zgcp_toolkit 0.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdd5f30aab3e292d7eefa9c362a0e79129cfc39d48c85b74822377d80a30cd91
-  data.tar.gz: 8f0e40f5d92bad0d83c8e856b2d81d1dc347987fb28e1e963cdeb8e29d855b3d
+  metadata.gz: 168a4db3ef4d6631232d6bb44c475f5a558ab7f0b10072d844cc3af903e252fd
+  data.tar.gz: a5202f7d5495c03e8586a42c8daeff3fe3c5e8dde350e4968eaa3904aabf137b
 SHA512:
-  metadata.gz: 462b117371427824f07fc8caf86b9d2af58e3304ebf38081e687e8c39264981a674600da0c6c69de9150d33a8975d7956af05ceab1a8ecd05d2f648d270a5590
-  data.tar.gz: be469a18442677b5ffddc406e029941c6cda7d9daa596d227f4785960d0f3e1801a7c49f28b5500ddd0d8caa80d8b56f4c0d06b7682ae89f833bf844b93d0e66
+  metadata.gz: e31981e2f9315f24d8bf1c48824ebc39e2495cf060b09feb7ec9e3daa76bfb96b594a073a4868e13b30df0ae7d793ac5c3b113aa55946552cc1126c3a0a4023f
+  data.tar.gz: c1d648d261f8f9571ad2e396110ffb58803158f2f8f88bda66cbcf4e9ac24cb3dfa43d6df857ca60861f276f1b6d8037b195bf79762ab04a3df1bb6202d45e45

data/README.md

@@ -22,7 +22,6 @@ Next, you need to run the generator:
     $ rails generate zgcp_toolkit
 
 ## Logger
-Each rake task will have its own log file in Cloud Logging. The log file name on Cloud Logging are combined from the rake task `namespace`s and `task name`. The rake task also be able to access the logger object.
 
 Unexpected errors in rake tasks are caught automatically & write to a log file in Cloud Logging. And, by default, when GCP Toolkit caught an unexpected error, it push a key & value (key: `push_slack` with value: `true`) in Cloud Logging Log `jsonPayload` so that the log that should be sent on Slack can be filtered.
 
@@ -30,36 +29,26 @@ Unexpected errors in rake tasks are caught automatically & write to a log file i
 
 ```ruby
 namespace :tcv_transactions do
-  task :daily_import do |t, logger:|
-    logger.info("Heyyyyyy!")
-    # The error message & backtrace are sent to Cloud Logging
-    raise "Heyyyyyy Oops!"
+  task :daily_import
+    ZgcpToolkit::Logger.create(:log_name) do |logger|
+      logger.info("Heyyyyyy!") # You can log anything to console, also google cloud logging
+      Bug.last
+    end
   end
 end
 ```
 
 ```ruby
-logger = ZgcpToolkit::Logger.new(:any_log_name)
+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 do |args, logger:|
-    logger.send_unexpected_error_to_slack = false
-    raise 'errors'
-  end
-end
-```
-
 ### Controller
 
-you can send controller errors to Google Cloud Loggings
+You can send controller errors to Google Cloud Loggings
 
 ```ruby
 # app/controllers/application_controller.rb
@@ -70,8 +59,8 @@ rescue_from StandardError do |e|
   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)
+  # You can report error (Error Reporting) with: 
+  # ZgcpToolkit::Logger.report_error_request(e, request)
 
   head :internal_server_error
 end

data/lib/zgcp_toolkit.rb

@@ -3,6 +3,6 @@ require "zgcp_toolkit/version"
 module ZgcpToolkit; end
 
 require 'zgcp_toolkit/logger'
-require 'zgcp_toolkit/rake/task'
+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,9 +1,3 @@
-require 'dry/configurable'
-require 'google/cloud/logging'
-require 'rake/task'
-
-Rake::Task.prepend(ZgcpToolkit::Rake::Task)
-
 loggers = [:std_out]
 
 loggers.push(:google_cloud_logging) unless Rails.env.development?

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'
 
@@ -6,6 +7,8 @@ module ZgcpToolkit
   class Logger
     extend Dry::Configurable
 
+    REGEX_VALID_NAME = /^[a-z0-9_]+$/.freeze
+
     AVAILABLE_LOGGERS = {
       std_out: ZgcpToolkit::Logger::Stdout,
       google_cloud_logging: ZgcpToolkit::Logger::GoogleCloudLogging
@@ -17,32 +20,63 @@ module ZgcpToolkit
 
     class Error < StandardError; end
     class UnsupportedLogType < Error; end
+    class InvalidLogName < Error; end
+
+    class << self
+      def create(log_name)
+        raise InvalidLogName, "Log name is invalid. Log name regex is #{REGEX_VALID_NAME.inspect}" unless valid_name?(log_name.to_s)
+
+        logger = Logger.new(log_name.to_s)
+
+        begin
+          yield(logger) if block_given?
+        rescue StandardError => e
+          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)
+        return true if log_name.match(REGEX_VALID_NAME)
+        false
+      end
+    end
 
     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!"
@@ -52,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
@@ -60,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/logger/google_cloud_logging.rb

@@ -1,3 +1,5 @@
+require 'google/cloud/logging'
+
 module ZgcpToolkit
   class Logger
     class GoogleCloudLogging

data/lib/zgcp_toolkit/version.rb

@@ -1,3 +1,3 @@
 module ZgcpToolkit
-  VERSION = '0.1.0'
+  VERSION = '1.2.1'
 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: 0.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - ZIGExN VeNtura developers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2021-07-26 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,12 +69,12 @@ 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
 - lib/zgcp_toolkit/logger/google_cloud_logging.rb
 - lib/zgcp_toolkit/logger/stdout.rb
-- lib/zgcp_toolkit/rake/task.rb
 - lib/zgcp_toolkit/version.rb
 - zgcp_toolkit.gemspec
 homepage: https://github.com/ZIGExN/zgcp_toolkit
@@ -84,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

data/lib/zgcp_toolkit/rake/task.rb

@@ -1,13 +0,0 @@
-module ZgcpToolkit::Rake
-  module Task
-    def execute(args=nil)
-      task_name = self.name.gsub(':', '_')
-      logger = ZgcpToolkit::Logger.new(task_name)
-      args.with_defaults(logger: logger)
-      super
-    rescue StandardError => e
-      logger.error(e, push_slack: logger.send_unexpected_error_to_slack)
-      logger.flush!
-    end
-  end
-end