google_logger 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51a89c8354ab6973e899f1d06f12af447b896610e6acc41a4d00b78fafbce979
-  data.tar.gz: de685bd286d977dfc8af3699a792cdaf50e9e89cd0080cddd74c3c9fdd66a8cd
+  metadata.gz: 0b63f1300144826557fc796374cf5dcd15f608a7ba2044f68d011bbac2b01f88
+  data.tar.gz: cdef99457af4f3bc04c0c1f666f6014736e120d365a6c1d26560d0c5dacb9c1f
 SHA512:
-  metadata.gz: 9e15bd07b973746f68551cdcf3cdf72cd83da2ed90c3e9742732467370a31c99e8e50f29fb09eddd385d133cebe412c3228e940b008116a6817b8f93c6f317df
-  data.tar.gz: 64946691763b5b908c0b02cd05a2c02151db6b96b32ac615addfa3a05fcf21e02f6ce7aab25b76dcf9b36530f868d12481f9f89d188d9dad8ef6722afed196f8
+  metadata.gz: 4cd40975a4e1aaa7accbcab858f63176b8edc345214b3a9292af2f244baa42f1e731838d7400a7505bfdce2d4950d5ec3852645ee453fdb4efb13d8c3d66c124
+  data.tar.gz: a8b3b972f21cfb69365b54c186e1135c3b35eb5725f2f00d70b6021df8c40f6b103409d491da9a9fca53bb402914ae5dcd6cb60b059c5df8abc405590aaa4147

data/lib/google_logger/configuration.rb

@@ -12,6 +12,7 @@ module GoogleLogger
                     credentials
                     log_locally
                     local_logger
+                    backtrace_length
                   ])
 
     # Creates a new instance with default configuration values
@@ -22,6 +23,7 @@ module GoogleLogger
       @secret_params = %i[password]
       @secret_param_value = '<SECRET_PARAM>'
       @log_locally = false
+      @backtrace_length = 10
     end
 
     def validate!

data/lib/google_logger/json_logger.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module GoogleLogger
+  class JsonLogger < ::Logger
+    SEVERITY_MAPPING = {
+      UNKNOWN => :DEFAULT,
+      FATAL => :CRITICAL,
+      ERROR => :ERROR,
+      WARN => :WARNING,
+      INFO => :INFO,
+      DEBUG => :DEBUG
+    }.freeze
+
+    def initialize(default_log_name: 'default')
+      @default_log_name = default_log_name
+      @tagged = nil
+      self.level = DEBUG
+    end
+
+    private
+
+    #
+    # @see Logger#add
+    #
+    def add(severity, message = nil, progname = nil)
+      return true if message.blank? && progname.blank?
+
+      severity ||= UNKNOWN
+      return true if severity < level
+
+      create_formatted_log(severity, message, progname)
+    end
+
+    def create_formatted_log(severity, message = nil, progname = nil)
+      log_name = tagged? ? formatter.current_tags.join('.') : @default_log_name
+      GoogleLogger.create_entry(
+        message || progname,
+        log_name: log_name,
+        severity: SEVERITY_MAPPING.fetch(severity)
+      )
+    end
+
+    def tagged?
+      formatter.respond_to?(:current_tags) && formatter.current_tags.any?
+    end
+  end
+end

data/lib/google_logger/params_replacer.rb

@@ -26,7 +26,9 @@ module GoogleLogger
     end
 
     class << self
-      delegate :deep_replace_secret_params, to: :new
+      def deep_replace_secret_params(params)
+        new.deep_replace_secret_params(params)
+      end
     end
   end
 end

data/lib/google_logger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GoogleLogger
-  VERSION = '1.0.2'
-end
+  VERSION = '1.2.0'
+end

data/lib/google_logger.rb

@@ -8,6 +8,7 @@ require 'google_logger/loggers/local_logger'
 require 'google_logger/loggers/base'
 require 'google_logger/controller_logging'
 require 'google_logger/params_replacer'
+require 'google_logger/json_logger'
 
 # Main module which should serve as an interface to all functionalities
 module GoogleLogger
@@ -60,7 +61,7 @@ module GoogleLogger
       payload = {
         message: exception.message,
         exception: exception.class.name,
-        bactrace: exception.backtrace&.first(5)
+        bactrace: exception.backtrace&.first(configuration.backtrace_length)
       }
 
       create_entry(payload, log_name: 'error', severity: :ERROR)
@@ -92,11 +93,7 @@ module GoogleLogger
     #
     # @return [Object] GoogleLogger::Logger by default, local logger if `loc_locally` is set to true
     def logger
-      if configuration.log_locally
-        Loggers::LocalLogger.new
-      else
-        Loggers::CloudLogger.new
-      end
+      configuration.log_locally ? local_logger : cloud_logger
     end
 
     # Log gem errors locally if local_logger is present
@@ -107,8 +104,19 @@ module GoogleLogger
       local_logger.error "GOOGLE_LOGGER ERROR: #{exception.inspect}" if local_logger.present?
     end
 
+    # mask secret param values
     def deep_replace_secret_params(params)
       ParamsReplacer.deep_replace_secret_params(params)
     end
+
+    # get a cached instance of a local logger
+    def local_logger
+      @local_logger ||= Loggers::LocalLogger.new
+    end
+
+    # get a cached instance of a cloud logger
+    def cloud_logger
+      @cloud_logger ||= Loggers::CloudLogger.new
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google_logger
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Jan Hric
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-10 00:00:00.000000000 Z
+date: 2022-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.4.5
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: stackdriver
   requirement: !ruby/object:Gem::Requirement
@@ -50,6 +64,7 @@ files:
 - lib/google_logger.rb
 - lib/google_logger/configuration.rb
 - lib/google_logger/controller_logging.rb
+- lib/google_logger/json_logger.rb
 - lib/google_logger/loggers/base.rb
 - lib/google_logger/loggers/cloud_logger.rb
 - lib/google_logger/loggers/local_logger.rb
@@ -61,11 +76,13 @@ licenses:
 metadata:
   homepage_uri: https://github.com/panter/google_logger
   source_code_uri: https://github.com/panter/google_logger
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 - lib/google_logger
+- lib/google_logger/json_logger
 - lib/google_logger/loggers
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
@@ -78,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.25
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Provides a simple interface to write logs to the google cloud platform.