getaround_utils 0.2.22 → 0.2.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58b10898f00f8c2e46207ee4048602603d2765560da5e82f78d506c1595a4b2c
-  data.tar.gz: 41aebe4bc7ffb3f9ed1995c4231479149d6f3c7765934f69d9b48b6098d90301
+  metadata.gz: d0f45f64d93dc7e5b83b2ee8612dff306880d7953c3e9026edcafe40925e7127
+  data.tar.gz: 5bcd057a886ff3a7423841f5bc29fb491501fa3c9226658a4b17801ae6eee189
 SHA512:
-  metadata.gz: dd59793351753bb94b39eebf2fb0bdda889e5e985ec832fbd6ba28b9f8bca5e7e879e66daa9bebb77e014e7d00967c211727ea633a8dbd1a8ceb2a3b147571e9
-  data.tar.gz: 98457dc6584d8c60b973618cb356e1c393f3f4673d3555b062d8342ae65800f3b33e06a161534efe66b08c9a845196fd5893a82bc8970621b3918376600c6d5a
+  metadata.gz: 98f5f63856cc9319be1d3f04e69bcf8aa5a165c48ad982ebf058a9e0faf92e31bf6dbeb1b5311f8ea89512156e508a7d3e070fbf0cfc22897958bc7279d58c06
+  data.tar.gz: ae985999bf28745645966d3108fd0dce14fba751f4a2e53aace72f5089515ddd94d6765ae3ae3349972b69cbcd72ac73b9f5083a4ec8acbf1a3c0d532938e8f7

data/.ruby-version

@@ -1 +1 @@
-ruby-2.6.7
+ruby-2.7.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    getaround_utils (0.2.21)
+    getaround_utils (0.2.23)
 
 GEM
   remote: https://rubygems.org/
@@ -70,28 +70,28 @@ GEM
     ast (2.4.2)
     builder (3.2.4)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     connection_pool (2.2.5)
     crack (0.4.5)
       rexml
     crass (1.0.6)
     diff-lcs (1.5.0)
     erubi (1.10.0)
-    getaround-rubocop (0.2.6)
+    getaround-rubocop (0.2.7)
       relaxed-rubocop (= 2.5)
-      rubocop (= 1.18.3)
+      rubocop (= 1.25.1)
       rubocop-rspec (= 2.4.0)
     globalid (1.0.0)
       activesupport (>= 5.0)
     hashdiff (1.0.1)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    lograge (0.11.2)
+    lograge (0.12.0)
       actionpack (>= 4)
       activesupport (>= 4)
       railties (>= 4)
       request_store (~> 1.0)
-    loofah (2.14.0)
+    loofah (2.18.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -102,21 +102,21 @@ GEM
     mini_portile2 (2.8.0)
     minitest (5.15.0)
     nio4r (2.5.8)
-    nokogiri (1.13.3)
+    nokogiri (1.13.6)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     oj (3.11.3)
     ougai (2.0.0)
       oj (~> 3.10)
-    parallel (1.20.1)
-    parser (3.0.2.0)
+    parallel (1.21.0)
+    parser (3.1.1.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (4.0.6)
     racc (1.6.0)
-    rack (2.2.3)
+    rack (2.2.3.1)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails (6.1.4.6)
@@ -137,7 +137,7 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
+    rails-html-sanitizer (1.4.3)
       loofah (~> 2.3)
     railties (6.1.4.6)
       actionpack (= 6.1.4.6)
@@ -145,12 +145,12 @@ GEM
       method_source
       rake (>= 0.13)
       thor (~> 1.0)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
     redis (4.6.0)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.1)
     relaxed-rubocop (2.5)
-    request_store (1.5.0)
+    request_store (1.5.1)
       rack (>= 1.4)
     request_store_rails (2.0.0)
       concurrent-ruby (~> 1.0)
@@ -164,10 +164,10 @@ GEM
     rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-rails (5.1.0)
+    rspec-rails (5.1.2)
       actionpack (>= 5.2)
       activesupport (>= 5.2)
       railties (>= 5.2)
@@ -176,22 +176,22 @@ GEM
       rspec-mocks (~> 3.10)
       rspec-support (~> 3.10)
     rspec-support (3.11.0)
-    rubocop (1.18.3)
+    rubocop (1.25.1)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.8.0)
-      parser (>= 3.0.1.1)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
     rubocop-rspec (2.4.0)
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
-    sidekiq (6.4.1)
+    sidekiq (6.5.0)
       connection_pool (>= 2.2.2)
       rack (~> 2.0)
       redis (>= 4.2.0)
@@ -205,7 +205,7 @@ GEM
     thor (1.2.1)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
     webmock (3.14.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
@@ -220,9 +220,9 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
-  getaround-rubocop (= 0.2.6)
+  getaround-rubocop (= 0.2.7)
   getaround_utils!
-  lograge (~> 0.11.2)
+  lograge (~> 0.12.0)
   ougai (~> 2.0)
   pry (~> 0.14.0)
   rails (~> 6.0)
@@ -230,9 +230,9 @@ DEPENDENCIES
   request_store_rails (~> 2.0)
   rspec (~> 3.9, >= 3.9.0)
   rspec-rails (~> 5.0)
-  rubocop (= 1.18.3)
+  rubocop (= 1.25.1)
   sidekiq (~> 6.0)
   webmock (~> 3.7)
 
 BUNDLED WITH
-   2.2.21
+   2.3.4

data/README.md

@@ -28,8 +28,8 @@ For more details, [read the spec](spec/getaround_utils/railties/ougai_spec.rb)
 
 ### GetaroundUtils::Mixins::Loggable
 
-Enables lograge (http logs) with favored default.
-```
+- Enables lograge (http logs) with favored default.
+```ruby
 class MyClass
   include GetaroundUtils::Mixins::Loggable
 
@@ -48,6 +48,31 @@ MyClass.new.action # :info message="hello" origin="MyClass" static="value" dynam
 
 For more details, [read the spec](spec/getaround_utils/mixins/loggable_spec.rb)
 
+- Offers an abstraction to log messages with a configurable `alert_threshold` attribute
+
+```ruby
+class MyClass
+  include GetaroundUtils::Mixins::Loggable
+
+  def action
+    monitorable_log(:my_event_to_be_monitored, dynamic: 'value')
+  end
+end
+
+MyClass.new.action # :info message="monitorable_log__my_event_to_be_monitored" origin="MyClass" dynamic="value", threshold=10
+```
+The threshold is configured in the relevant Rails configuration (eg `config/environments/production.rb`)
+```ruby
+# ...
+  config.monitorable_log_thresholds = {
+    my_event_to_be_monitored: 10
+  }
+# ...
+```
+You may set / override the configured thresholds with an environment variable of the event name prefixed with `MONITORABLE_LOG__`, for instance `MONITORABLE_LOG__MY_EVENT_TO_BE_MONITORED`.
+
+For more details, [read the spec](spec/getaround_utils/mixins/loggable_spec.rb#L171)
+
 ## Misc
 
 ### GetaroundUtils::LogFormatters::DeepKeyValue

data/getaround_utils.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |gem|
   gem.email = ['oss@drivy.com']
   gem.homepage = 'https://github.com/drivy'
   gem.license = 'MIT'
-  gem.required_ruby_version = '>= 2.6'
+  gem.required_ruby_version = '>= 2.7'
 
   gem.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
@@ -19,16 +19,16 @@ Gem::Specification.new do |gem|
 
   # Development dependencies
   gem.add_development_dependency 'bundler', '~> 2.0'
-  gem.add_development_dependency 'getaround-rubocop', '= 0.2.6'
+  gem.add_development_dependency 'getaround-rubocop', '= 0.2.7'
   gem.add_development_dependency 'pry', '~> 0.14.0'
   gem.add_development_dependency 'rake', '~> 13.0'
   gem.add_development_dependency 'rspec', '~> 3.9', '>= 3.9.0'
   gem.add_development_dependency 'rspec-rails', '~> 5.0'
-  gem.add_development_dependency 'rubocop', '= 1.18.3'
+  gem.add_development_dependency 'rubocop', '= 1.25.1'
   gem.add_development_dependency 'webmock', '~> 3.7'
 
   # Functional (optional) dependencies
-  gem.add_development_dependency 'lograge', '~> 0.11.2'
+  gem.add_development_dependency 'lograge', '~> 0.12.0'
   gem.add_development_dependency 'ougai', '~> 2.0'
   gem.add_development_dependency 'rails', '~> 6.0'
   gem.add_development_dependency 'request_store_rails', '~> 2.0'

data/lib/getaround_utils/mixins/loggable.rb

@@ -29,4 +29,38 @@ module GetaroundUtils::Mixins::Loggable
     base_append_infos_to_loggable(payload)
     loggable_logger.send(severity.to_sym, msg: message, **payload)
   end
+
+  MONITORABLE_LOG_PREFIX = "monitorable_log__"
+
+  def monitorable_log(event_name, **options)
+    monitorable_threshold = monitorable_threshold(event_name)
+    return if monitorable_threshold.blank?
+
+    loggable_log(
+      :info,
+      log_message(event_name),
+      alert_threshold: monitorable_threshold,
+      **options
+    )
+  end
+
+  def monitorable_threshold(event_name)
+    monitorable_threshold = ENV["#{log_message(event_name)}_threshold".upcase]&.to_i
+    if monitorable_threshold.nil? && rails_config_defined?
+      monitorable_threshold = Rails.application.config.monitorable_log_thresholds&.dig(event_name.to_sym)
+    end
+    monitorable_threshold
+  end
+
+  def log_message(event_name)
+    MONITORABLE_LOG_PREFIX + event_name
+  end
+
+  private
+
+  def rails_config_defined?
+    defined?(Rails) &&
+      Rails.application.config.respond_to?(:monitorable_log_thresholds) &&
+      Rails.application.config.monitorable_log_thresholds.respond_to?(:dig)
+  end
 end

data/lib/getaround_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GetaroundUtils
-  VERSION = '0.2.22'
+  VERSION = '0.2.23'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: getaround_utils
 version: !ruby/object:Gem::Version
-  version: 0.2.22
+  version: 0.2.23
 platform: ruby
 authors:
 - Drivy
 - Laurent Humez
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-28 00:00:00.000000000 Z
+date: 2022-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.2.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.2.7
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -71,22 +71,22 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.9.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.9.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -107,14 +107,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.18.3
+        version: 1.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.18.3
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -135,14 +135,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: 0.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: ougai
   requirement: !ruby/object:Gem::Requirement
@@ -227,7 +227,7 @@ homepage: https://github.com/drivy
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -235,15 +235,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Backend shared utility classes
 test_files: []