getaround_utils 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 391634ba2c0e6d1c3fe81bbdaf24519a84dfaa61fa093b8cb5ef10b3b47445a1
-  data.tar.gz: 0733525cd736128b202d0c6e8e87bb724685a09a8349ddb6fcdaccd8d10e6bee
+  metadata.gz: 6caee3209d10665822566c7ccc2d6b336c8132b72106aacda7db87a317a0f9f7
+  data.tar.gz: 241deaa2c3b3d37bb21bade62b517b54bee6fc62910113f2f40209862230d80c
 SHA512:
-  metadata.gz: 9e1b37388a0f05c21337941a8badddbc4e0411c61bceb9e326d9e0c99d16459c7df9868d4e2b6a2dda566f08ff19ae56f939f33198cbd929165f7fab3086d2d1
-  data.tar.gz: '095c102942a20a9fc4f9ec0ea445a560ced7b34bf9dab794e151c273b0b6845a84d888a7cb12a6542e37bfd5d26b675214769bdc82fe42adb9306c507cdbf1f2'
+  metadata.gz: c19cb3921b428f3cd7f5d885edb7eb2214fae0c07449f8a25e0a2225c6961408960d641f7a702b686cbf453476e4eea90e558f18ce0310af19ff49874f57ea17
+  data.tar.gz: 25230181f5c735e08c60384e5fd734969b4a703df25a2cf995f7582131a0e6b182e5d091e1bd5ab6d741f3b4008df09cb9d2c220e3ecaf5ab308ee913ca56eb0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    getaround_utils (0.1.8)
+    getaround_utils (0.1.9)
 
 GEM
   remote: https://rubygems.org/
@@ -65,6 +65,7 @@ GEM
     builder (3.2.3)
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
+    connection_pool (2.2.2)
     crass (1.0.5)
     diff-lcs (1.3)
     erubi (1.9.0)
@@ -103,6 +104,8 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     rack (2.0.7)
+    rack-protection (2.0.7)
+      rack
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails (6.0.0)
@@ -133,6 +136,7 @@ GEM
       thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (10.5.0)
+    redis (4.1.3)
     relaxed-rubocop (2.4)
     request_store (1.4.1)
       rack (>= 1.4)
@@ -167,6 +171,11 @@ GEM
     rubocop-rspec (1.36.0)
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
+    sidekiq (6.0.3)
+      connection_pool (>= 2.2.2)
+      rack (>= 2.0.0)
+      rack-protection (>= 2.0.0)
+      redis (>= 4.1.0)
     sprockets (4.0.0)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -199,6 +208,7 @@ DEPENDENCIES
   rspec-rails (~> 3.9)
   rubocop (~> 0.75, >= 0.75.0)
   rubocop-rspec (~> 1.36, >= 0.36.0)
+  sidekiq (~> 6.0)
 
 BUNDLED WITH
    2.0.2

data/README.md

@@ -52,6 +52,19 @@ GetaroundUtils::Patches::KeyValueLogTags.enable
 
 For more details, [read the spec](spec/getaround_utils/patches/key_value_log_tags_spec.rb)
 
+
+### GetaroundUtils::Patches::KeyValueSidekiqExceptions
+
+Enables parse-able exception logging from Sidekiq
+```
+# config/application.rb
+require 'getaround_utils/patches/key_value_sidekiq_exceptions'
+GetaroundUtils::Patches::KeyValueSidekiqExceptions.enable
+```
+
+For more details, [read the spec](spec/getaround_utils/patches/key_value_sidekiq_exceptions_spec.rb)
+
+
 ## Misc
 
 ### GetaroundUtils::LogFormatters::DeepKeyValue

data/getaround_utils.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec-rails', '~> 3.9'
   gem.add_development_dependency 'rubocop', '~> 0.75', '>= 0.75.0'
   gem.add_development_dependency 'rubocop-rspec', '~> 1.36', '>= 0.36.0'
+  gem.add_development_dependency 'sidekiq', '~> 6.0'
 end

data/lib/getaround_utils/log_formatters/deep_key_value.rb

@@ -10,51 +10,41 @@ require 'getaround_utils/utils/deep_key_value_serializer'
 # It will attempt to serialize message it is a string otherwise adding it as message=value
 
 class GetaroundUtils::LogFormatters::DeepKeyValue < GetaroundUtils::Utils::DeepKeyValueSerializer
-  def call(severity, _datetime, appname, message)
-    payload = { severity: severity, appname: appname }
+  def normalize(message)
     if message.is_a?(Hash)
-      "#{serialize(payload.merge(message).compact)}\n"
+      serialize(message.compact)
+    elsif message.is_a?(String) && message.match(/^[^ =]+=/)
+      message
     else
-      "#{serialize(payload.compact)} #{message}\n"
+      serialize(message: message.to_s)
     end
   end
 
+  def call(severity, _datetime, appname, message)
+    payload = { severity: severity, appname: appname }
+    "#{normalize(payload)} #{normalize(message)}\n"
+  end
+
   module Lograge
-    def call(data)
-      data.compact! if data.is_a?(Hash)
-      serialize(data)
+    def call(message)
+      message = message.compact if message.is_a?(Hash)
+      serialize(message)
     end
   end
 
-  ##
-  # Return a lograge-style LogFormatter
-  #
-  # This formatter will only take one argument and serialize it
-
   def self.for_lograge
     new.extend(Lograge)
   end
 
   module Sidekiq
     def call(severity, _datetime, appname, message)
-      payload = {}
-      payload[:sidekiq] = Thread.current[:sidekiq_context] || {}
-      payload[:sidekiq][:tid] = Thread.current['sidekiq_tid']
-      message = if message.is_a?(Hash)
-        message.merge(payload.compact)
-      else
-        "#{serialize(payload.compact)} #{message}"
-      end
-      super
+      payload = { severity: severity, appname: appname }
+      sidekiq = { sidekiq: Thread.current[:sidekiq_context] || {} }
+      sidekiq[:sidekiq][:tid] = Thread.current['sidekiq_tid']
+      "#{normalize(payload)} #{normalize(message)} #{normalize(sidekiq)}\n"
     end
   end
 
-  ##
-  # Return a sidekiq-style LogFormatter
-  #
-  # This formatter replicates the default Sidekiq LogFormatter behavior of merging context
-  # values from the current Thread's store
-
   def self.for_sidekiq
     new.extend(Sidekiq)
   end

data/lib/getaround_utils/patches.rb

@@ -1,3 +1,4 @@
 module GetaroundUtils::Patches
   autoload :KeyValueLogTags, 'getaround_utils/patches/key_value_log_tags'
+  autoload :KeyValueSidekiqExceptions, 'getaround_utils/patches/key_value_sidekiq_exceptions'
 end

data/lib/getaround_utils/patches/key_value_log_tags.rb

@@ -1,4 +1,3 @@
-require 'rails/railtie'
 require 'getaround_utils/utils/deep_key_value_serializer'
 
 module GetaroundUtils; end

data/lib/getaround_utils/patches/key_value_sidekiq_exceptions.rb

@@ -0,0 +1,26 @@
+require 'sidekiq/exception_handler'
+require 'getaround_utils/utils/deep_key_value_serializer'
+
+module GetaroundUtils; end
+module GetaroundUtils::Patches; end
+
+class GetaroundUtils::Patches::KeyValueSidekiqExceptions
+  module ExceptionHandlerLogger
+    def kv_formatter
+      @kv_formatter ||= GetaroundUtils::Utils::DeepKeyValueSerializer.new
+    end
+
+    def call(exception, ctx)
+      payload = {}
+      payload[:exception] = exception&.class&.name
+      payload[:sidekiq] = ctx
+      payload[:message] = exception&.message
+      payload[:backtrace] = exception&.backtrace&.join("\n")
+      Sidekiq.logger.warn(kv_formatter.serialize(payload.compact))
+    end
+  end
+
+  def self.enable
+    Sidekiq::ExceptionHandler::Logger.prepend ExceptionHandlerLogger
+  end
+end

data/lib/getaround_utils/utils/deep_key_value_serializer.rb

@@ -2,6 +2,11 @@ module GetaroundUtils; end
 module GetaroundUtils::Utils; end
 
 class GetaroundUtils::Utils::DeepKeyValueSerializer
+  def initialize(max_depth: 5, max_length: 512)
+    @max_depth = max_depth
+    @max_length = max_length
+  end
+
   def serialize(data)
     case data
     when Array
@@ -19,6 +24,10 @@ class GetaroundUtils::Utils::DeepKeyValueSerializer
 
   # https://stackoverflow.com/questions/48836464/how-to-flatten-a-hash-making-each-key-a-unique-value
   def flattify(value, result = {}, path = [])
+    if path.length > @max_depth
+      result[path.join(".")] = '"..."'
+      return result
+    end
     case value
     when Array
       value.each.with_index(0) do |v, i|
@@ -31,9 +40,14 @@ class GetaroundUtils::Utils::DeepKeyValueSerializer
     when Numeric
       result[path.join(".")] = value.to_s
     when String
-      result[path.join(".")] = value =~ /^".*"$/ ? value : value.inspect
+      value = if value =~ /^".*"$/
+        value.length >= @max_length ? %{#{value[0...@max_length]} ..."} : value
+      else
+        value.length >= @max_length ? %{#{value[0...@max_length]} ...}.inspect : value.inspect
+      end
+      result[path.join(".")] = value
     else
-      result[path.join(".")] = value.to_s.inspect
+      flattify(value.to_s, result, path)
     end
     result
   end

data/lib/getaround_utils/version.rb

@@ -1,3 +1,3 @@
 module GetaroundUtils
-  VERSION = '0.1.8'.freeze
+  VERSION = '0.1.9'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: getaround_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Drivy
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-15 00:00:00.000000000 Z
+date: 2019-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -175,6 +175,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.36'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 description: Shared base utility classes for Getaround Backend Applications.
 email:
 - oss@drivy.com
@@ -194,6 +208,7 @@ files:
 - lib/getaround_utils/mixins/loggable.rb
 - lib/getaround_utils/patches.rb
 - lib/getaround_utils/patches/key_value_log_tags.rb
+- lib/getaround_utils/patches/key_value_sidekiq_exceptions.rb
 - lib/getaround_utils/railties/lograge.rb
 - lib/getaround_utils/utils.rb
 - lib/getaround_utils/utils/deep_key_value_serializer.rb