getaround_utils 0.1.20 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac89bb57e946209df2cd90a27662dd6eafe09eaf1ad75c70e0120843600eaa73
-  data.tar.gz: b5e42696a498a174113437cf8350b1eb742391f74588621a3bae00e12cab7fc4
+  metadata.gz: bdcc5b1460329ad345ef3d8a3be543c4e4d9b5b626d4c71551c698513df16a97
+  data.tar.gz: 876b086f9f1ef2b411409ffcfd5f2d16676fed5fa87d40020f254efc3e2d9b7c
 SHA512:
-  metadata.gz: 20debe44bc0c094ce9dcc3cde822eb7565c6c399cc4ba5849c2a6c5bbc249c9fa96e8fda50648c9974c03b1177030b3880aab5df65c3eba6ea9632845e796d69
-  data.tar.gz: 3017542f9d2b157a8f6ee9637c5659212a3fa3ad8803975ac2fd8b76e255487183e7b671944a6ec8a9b841890917dfb0c3ae7f3973eba0966257d7a9089c0161
+  metadata.gz: 42967aa90f0c6384d87d9b1c1d7fde77526b3949a854107b438c9968524736df6e6b044dd8674d92c6d53e36e4c3024debbbc1ef799fcea62a034ad7a733e94d
+  data.tar.gz: c23299cce88fd8bf7ecc9741ddda44e3a14d7e68b2f06fe359fcac88d635a91513c4dfe930437e65054ea30363b07d3aa52d84e7f10a09932d705ba250c120f1

data/.rubocop.yml

@@ -6,6 +6,10 @@ inherit_gem:
     - .rubocop.yml
     - .rubocop-rspec.yml
 
+Layout/MultilineMethodCallIndentation:
+  Description: Vertical alignment results in awkward diffs.
+  EnforcedStyle: indented
+
 Layout/MultilineAssignmentLayout:
   Description: Vertical alignment results in awkward diffs.
   EnforcedStyle: same_line

data/Gemfile

@@ -3,5 +3,6 @@ source "https://rubygems.org"
 gemspec
 
 gem "faraday", "~> 1.0"
-
+gem "ougai", "~> 1.8"
+gem "request_store_rails", "~> 2.0"
 gem "webmock", "~> 3.7"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    getaround_utils (0.1.20)
+    getaround_utils (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -105,6 +105,9 @@ GEM
     nio4r (2.5.2)
     nokogiri (1.10.5)
       mini_portile2 (~> 2.4.0)
+    oj (3.10.14)
+    ougai (1.8.5)
+      oj (~> 3.10)
     parallel (1.18.0)
     parser (2.6.5.0)
       ast (~> 2.4.0)
@@ -149,6 +152,8 @@ GEM
     relaxed-rubocop (2.4)
     request_store (1.4.1)
       rack (>= 1.4)
+    request_store_rails (2.0.0)
+      concurrent-ruby (~> 1.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -216,9 +221,11 @@ DEPENDENCIES
   getaround-rubocop (~> 0.1.0, >= 0.1.0)
   getaround_utils!
   lograge (~> 0.11.2)
+  ougai (~> 1.8)
   pry (~> 0.12.2)
   rails (~> 6.0)
   rake (~> 10.0)
+  request_store_rails (~> 2.0)
   rspec (~> 3.9, >= 3.9.0)
   rspec-rails (~> 3.9)
   rubocop (~> 0.75, >= 0.75.0)
@@ -227,4 +234,4 @@ DEPENDENCIES
   webmock (~> 3.7)
 
 BUNDLED WITH
-   2.1.0
+   2.1.4

data/README.md

@@ -14,6 +14,16 @@ require 'getaround_utils/railties/lograge'
 
 For more details, [read the spec](spec/getaround_utils/railties/lograge_spec.rb)
 
+### GetaroundUtils::Railties::Ougai
+
+Enables structured log with Ougai.
+```
+# config/application.rb
+require 'getaround_utils/railties/ougai'
+```
+
+For more details, [read the spec](spec/getaround_utils/railties/ougai_spec.rb)
+
 ## Mixins
 
 ### GetaroundUtils::Mixins::Loggable
@@ -38,33 +48,6 @@ MyClass.new.action # :info message="hello" origin="MyClass" static="value" dynam
 
 For more details, [read the spec](spec/getaround_utils/mixins/loggable_spec.rb)
 
-
-## Patches
-
-### GetaroundUtils::Patches::KeyValueLogTags
-
-Enables parse-able key-value tags in ActiveRecord::TaggedLogger
-```
-# config/application.rb
-require 'getaround_utils/patches/key_value_log_tags'
-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/lib/getaround_utils.rb

@@ -1,8 +1,4 @@
+require 'getaround_utils/mixins'
+require 'getaround_utils/ougai'
+require 'getaround_utils/utils'
 require 'getaround_utils/version'
-
-module GetaroundUtils
-  autoload :LogFormatters, 'getaround_utils/log_formatters'
-  autoload :Mixins, 'getaround_utils/mixins'
-  autoload :Patches, 'getaround_utils/patches'
-  autoload :Utils, 'getaround_utils/utils'
-end

data/lib/getaround_utils/mixins.rb

@@ -1,3 +1 @@
-module GetaroundUtils::Mixins
-  autoload :Loggable, 'getaround_utils/mixins/loggable'
-end
+require 'getaround_utils/mixins/loggable'

data/lib/getaround_utils/mixins/loggable.rb

@@ -33,10 +33,7 @@ module GetaroundUtils::Mixins::Loggable
   end
 
   def loggable_log(severity, message, payload = {})
-    payload = { message: message }.merge(payload)
     base_append_infos_to_loggable(payload)
-
-    message = GetaroundUtils::Utils::DeepKeyValue.serialize(payload.compact)
-    base_loggable_logger.send(severity.to_sym, message)
+    base_loggable_logger.send(severity.to_sym, message, payload)
   end
 end

data/lib/getaround_utils/ougai.rb

@@ -0,0 +1,2 @@
+require 'getaround_utils/ougai/deep_key_value_formatter'
+require 'getaround_utils/ougai/json_formatter'

data/lib/getaround_utils/ougai/deep_key_value_formatter.rb

@@ -0,0 +1,15 @@
+require 'ougai'
+require 'getaround_utils/utils/deep_key_value'
+
+module GetaroundUtils; end
+module GetaroundUtils::Ougai; end
+
+class GetaroundUtils::Ougai::DeepKeyValuesFormatter < Ougai::Formatters::Base
+  def _call(severity, _time, progname, data)
+    data.delete(:msg) if data[:msg] == 'No message'
+    data = data.except(:msg).merge(message: data[:msg])
+
+    payload = { severity: severity, progname: progname }.merge(data).compact!
+    GetaroundUtils::Utils::DeepKeyValue.serialize(payload) + "\n"
+  end
+end

data/lib/getaround_utils/ougai/json_formatter.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module GetaroundUtils; end
+module GetaroundUtils::Ougai; end
+
+class GetaroundUtils::Ougai::JsonFormatter < Ougai::Formatters::Base
+  def _call(severity, _time, progname, data)
+    data.delete(:msg) if data[:msg] == 'No message'
+    data = data.except(:msg).merge(message: data[:msg])
+
+    payload = { severity: severity, progname: progname }.merge(data).compact!
+    JSON.dump(payload) + "\n"
+  end
+end

data/lib/getaround_utils/railties/lograge.rb

@@ -1,5 +1,4 @@
 require 'rails/railtie'
-require 'getaround_utils/log_formatters/deep_key_value'
 require 'lograge'
 
 module GetaroundUtils; end
@@ -26,6 +25,5 @@ class GetaroundUtils::Railties::Lograge < Rails::Railtie
   end
 
   config.lograge.enabled = true
-  config.lograge.formatter = GetaroundUtils::LogFormatters::DeepKeyValue.for_lograge
   config.lograge.custom_options = ->(event) { event.payload[:lograge] }
 end

data/lib/getaround_utils/railties/ougai.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'getaround_utils/ougai/deep_key_value_formatter'
+require 'request_store'
+require 'rails/railtie'
+require 'ougai'
+
+module GetaroundUtils; end
+module GetaroundUtils::Railties; end
+
+# Rails-compatible Ougai Logger
+# https://github.com/tilfin/ougai/wiki/Use-as-Rails-logger#define-a-custom-logger
+class OugaiRailsLogger < Ougai::Logger
+  include ActiveSupport::LoggerThreadSafeLevel
+  include Rails::VERSION::MAJOR < 6 ? LoggerSilence : ActiveSupport::LoggerSilence
+end
+
+# Patch for ActiveSupport::TaggedLogging
+# https://github.com/tilfin/ougai/wiki/Use-as-Rails-logger#with-activesupporttaggedlogging
+module OugaiTaggedLoggingFormatter
+  def call(severity, time, progname, data)
+    data = { msg: data.to_s } unless data.is_a?(Hash)
+    data[:tags] = current_tags if current_tags.any?
+    _call(severity, time, progname, data)
+  end
+end
+
+# Custom middleware to persist request metadatas
+# https://github.com/tilfin/ougai/issues/73#issuecomment-475866224
+# https://github.com/tilfin/ougai/issues/107#issuecomment-636050223
+class OugaiRequestStoreMiddleware
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    RequestStore.store[:ougai] = { request_id: env['action_dispatch.request_id'] }
+    @app.call(env)
+  end
+end
+
+class GetaroundUtils::Railties::Ougai < Rails::Railtie
+  log_level = ENV.fetch('LOG_LEVEL', :info).to_sym
+
+  config.ougai_logger = OugaiRailsLogger.new(STDOUT)
+  config.ougai_logger.after_initialize if Rails::VERSION::MAJOR < 6
+  config.ougai_logger.level = log_level
+  config.ougai_logger.formatter = GetaroundUtils::Ougai::DeepKeyValuesFormatter.new
+  config.ougai_logger.before_log = lambda do |data|
+    request_store = RequestStore.store[:ougai] || {}
+    data.merge!(request_store) if request_store&.any?
+
+    sidekiq_context = Thread.current[:sidekiq_context] || {}
+    data.merge!(sidekiq: sidekiq_context) if sidekiq_context&.any?
+  end
+
+  initializer :getaround_utils_ougai, before: :initialize_logger do |app|
+    LOG_LEVELS = {
+      Logger::DEBUG => :debug,
+      Logger::INFO => :info,
+      Logger::WARN => :warn,
+      Logger::ERROR => :error,
+      Logger::FATAL => :fatal,
+    }.freeze
+
+    app.config.log_level = LOG_LEVELS[config.ougai_logger.level] || :info
+    app.config.logger = config.ougai_logger
+  end
+
+  initializer :getaround_utils_ougai_middleware do |app|
+    app.config.app_middleware.insert_after ActionDispatch::RequestId, OugaiRequestStoreMiddleware
+  end
+
+  initializer :getaround_utils_ougai_activesupport do
+    ActiveSupport::TaggedLogging::Formatter.prepend OugaiTaggedLoggingFormatter
+  end
+
+  initializer :getaround_utils_ougai_lograge do |app|
+    next unless defined?(Lograge)
+
+    app.config.lograge.logger = app.config.logger
+    app.config.lograge.formatter = Lograge::Formatters::Raw.new
+  end
+
+  initializer :getaround_utils_ougai_sidekiq do
+    next unless defined?(Sidekiq)
+
+    # https://github.com/tilfin/ougai/wiki/Customize-Sidekiq-logger
+    Sidekiq.logger = config.ougai_logger
+
+    Sidekiq.configure_server do |config|
+      config.error_handlers.pop
+      config.error_handlers << lambda do |ex, ctx|
+        Sidekiq.logger.warn(ex, job: ctx[:job])
+      end
+    end
+  end
+end

data/lib/getaround_utils/utils.rb

@@ -1,6 +1,4 @@
-module GetaroundUtils::Utils
-  autoload :AsyncQueue, 'getaround_utils/utils/async_queue'
-  autoload :DeepKeyValue, 'getaround_utils/utils/deep_key_value'
-  autoload :HttpReporter, 'getaround_utils/utils/http_reporter'
-  autoload :CapturReporter, 'getaround_utils/utils/captur_reporter'
-end
+require 'getaround_utils/utils/async_queue'
+require 'getaround_utils/utils/deep_key_value'
+require 'getaround_utils/utils/http_reporter'
+require 'getaround_utils/utils/captur_reporter'

data/lib/getaround_utils/version.rb

@@ -1,3 +1,3 @@
 module GetaroundUtils
-  VERSION = '0.1.20'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: getaround_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.20
+  version: 0.2.0
 platform: ruby
 authors:
 - Drivy
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-15 00:00:00.000000000 Z
+date: 2020-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -203,14 +203,13 @@ files:
 - README.md
 - getaround_utils.gemspec
 - lib/getaround_utils.rb
-- lib/getaround_utils/log_formatters.rb
-- lib/getaround_utils/log_formatters/deep_key_value.rb
 - lib/getaround_utils/mixins.rb
 - 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/ougai.rb
+- lib/getaround_utils/ougai/deep_key_value_formatter.rb
+- lib/getaround_utils/ougai/json_formatter.rb
 - lib/getaround_utils/railties/lograge.rb
+- lib/getaround_utils/railties/ougai.rb
 - lib/getaround_utils/utils.rb
 - lib/getaround_utils/utils/async_queue.rb
 - lib/getaround_utils/utils/captur_reporter.rb

data/lib/getaround_utils/log_formatters.rb

@@ -1,3 +0,0 @@
-module GetaroundUtils::LogFormatters
-  autoload :DeepKeyValue, 'getaround_utils/log_formatters/deep_key_value'
-end

data/lib/getaround_utils/log_formatters/deep_key_value.rb

@@ -1,63 +0,0 @@
-module GetaroundUtils; end
-module GetaroundUtils::LogFormatters; end
-
-require 'getaround_utils/utils/deep_key_value'
-
-class GetaroundUtils::LogFormatters::DeepKeyValue
-  module Shared
-    def normalize(message)
-      if message.is_a?(Hash)
-        GetaroundUtils::Utils::DeepKeyValue.serialize(message.compact)
-      elsif message.is_a?(String) && message.match(/^[^ =]+=/)
-        message
-      else
-        GetaroundUtils::Utils::DeepKeyValue.serialize(message: message.to_s)
-      end
-    end
-  end
-
-  class Base
-    include GetaroundUtils::LogFormatters::DeepKeyValue::Shared
-
-    def call(severity, _datetime, appname, message)
-      payload = { severity: severity, appname: appname }
-      "#{normalize(payload)} #{normalize(message)}\n"
-    end
-  end
-
-  def self.new
-    Base.new
-  end
-
-  class Lograge
-    def call(message)
-      message = message.compact if message.is_a?(Hash)
-      GetaroundUtils::Utils::DeepKeyValue.serialize(message)
-    end
-  end
-
-  def self.for_lograge
-    Lograge.new
-  end
-
-  class Sidekiq < Base
-    def sidekiq_context
-      context = Thread.current&.fetch(:sidekiq_context, nil)
-      context.is_a?(Hash) ? context : {}
-    end
-
-    def sidekiq_tid
-      Thread.current&.fetch('sidekiq_tid', nil) || (Thread.current&.object_id ^ ::Process.pid).to_s(36)
-    end
-
-    def call(severity, _datetime, appname, message)
-      payload = { severity: severity, appname: appname }
-      sidekiq = sidekiq_context.merge(tid: sidekiq_tid).compact
-      "#{normalize(payload)} #{normalize(message)} #{normalize(sidekiq: sidekiq)}\n"
-    end
-  end
-
-  def self.for_sidekiq
-    Sidekiq.new
-  end
-end

data/lib/getaround_utils/patches.rb

@@ -1,4 +0,0 @@
-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,53 +0,0 @@
-require 'getaround_utils/log_formatters/deep_key_value'
-
-module GetaroundUtils; end
-module GetaroundUtils::Patches; end
-
-##
-# Augment the ActiveRecord::TaggedLogging tag formatting
-#
-# Tags are defined either as String, Proc or a property of request
-#
-# Originally they will be formatted as `[tag_value]`
-# This patch will instead attempt to serialize the tag with GetaroundUtils::DeepKeyValueSerializer
-#
-# ie:
-#  - for a String `value` it would yield `"value"`
-#  - for a Symbol `:request_id` it would yield `request_id="request_id_value"`
-#  - for a Proc `-> {key: :val}` it would yield `key="value"`
-
-class GetaroundUtils::Patches::KeyValueLogTags
-  module TaggedLoggingFormatter
-    include GetaroundUtils::LogFormatters::DeepKeyValue::Shared
-
-    def tags_text
-      "#{current_tags.join(' ')} " if current_tags.any?
-    end
-
-    def call(severity, datetime, appname, message)
-      original_method = method(__method__).super_method.super_method
-      message = "#{tags_text}#{normalize(message)}"
-      original_method.call(severity, datetime, appname, message)
-    end
-  end
-
-  module RackLogger
-    def compute_tags(request)
-      @taggers.collect do |tag|
-        case tag
-        when Proc
-          GetaroundUtils::Utils::DeepKeyValue.serialize(tag.call(request))
-        when Symbol
-          GetaroundUtils::Utils::DeepKeyValue.serialize(tag => request.send(tag))
-        else
-          GetaroundUtils::Utils::DeepKeyValue.serialize(tag)
-        end
-      end
-    end
-  end
-
-  def self.enable
-    ActiveSupport::TaggedLogging::Formatter.prepend TaggedLoggingFormatter
-    Rails::Rack::Logger.prepend RackLogger
-  end
-end

data/lib/getaround_utils/patches/key_value_sidekiq_exceptions.rb

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