deprecation_collector 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f45c8742c0a83f697b04d7a99af54749b354c25cfcffb78f152a680f8224584
-  data.tar.gz: ab25a06b38f3ebfe82a48136c8a58da8d61e4db93614af0c66e283771f0b61b7
+  metadata.gz: edc00d8d4dd22e076dd0c331bd65ee2a6caad48e28ee0f2a79253f94d6d5a1b3
+  data.tar.gz: a8d0a71ada4d0eae355f853f685ea4548124e5090bcac361bb4363ef69b8faaa
 SHA512:
-  metadata.gz: d395dc4cedb786ab398911e5de19568f44317040352f1b85a6fc45a45fce465d6c82b8092c2f74e0a6b1d18e4dedfbc3284d59767dad2f3a2202143acd969b81
-  data.tar.gz: 0f9a6cd6f02b9b674710db839fcce21f69a2af31a41cc552ad3266b7cd1c3eaa21dac1ac7f94f0208833536e29c20d70e0261e6b087bc548597035c45bc47799
+  metadata.gz: b7f467b251d4e04f9d23f5524f1c0e36d6ab363090664178ef82d78d261e118d7f30511f6711ebde8205cde3fe46e871f870752c8be867f4f0bd743344589e5b
+  data.tar.gz: 2c3b8f59fc2adb43a04a39f3fb39f02bcd752ebbc9d7a1974a77a8441dfeb1daaf65ec87704d7159a1b31a443c20df5a202ff1872e08a28e709baccd84657998

data/CHANGELOG.md

@@ -1,4 +1,7 @@
-== 0.0.5 (unreleased)
+== 0.0.6
+- added custom context saving ability
+
+== 0.0.5
 - options `print_to_stderr`, `print_recurring`
 - fix redis deprecated `pipelined` block arity (support for redis 5)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    deprecation_collector (0.0.5)
+    deprecation_collector (0.0.6)
       redis (>= 3.0)
 
 GEM

data/README.md

@@ -33,6 +33,10 @@ Add an initializer with configuration, like
       instance.ignored_messages = [
         "Ignoring db/schema_cache.yml because it has expired"
       ]
+      instance.context_saver do
+        # this will only be called for new deprecations, return value must be json-compatible
+        { some: "custom", context: "for example request.id" }
+      end
     end
   end
 ```

data/lib/deprecation_collector/deprecation.rb

@@ -4,6 +4,7 @@ class DeprecationCollector
   # :nodoc:
   class Deprecation
     attr_reader :message, :realm, :gem_traceline, :app_traceline, :occurences, :first_timestamp, :full_backtrace
+    attr_accessor :context
 
     CLEANUP_REGEXES = {
       # rails views generated methods names are unique per-worker
@@ -70,7 +71,8 @@ class DeprecationCollector
         revision: DeprecationCollector.instance.app_revision,
         count: @occurences, # output anyway for frequency estimation (during write_interval inside single process)
         first_timestamp: first_timestamp, # this may not be accurate, a worker with later timestamp may dump earlier
-        digest_base: digest_base # for debug purposes
+        digest_base: digest_base, # for debug purposes
+        context: context
       }.compact
     end
 

data/lib/deprecation_collector/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class DeprecationCollector
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/deprecation_collector.rb

@@ -56,7 +56,7 @@ class DeprecationCollector
                 :write_interval, :write_interval_jitter,
                 :app_revision, :app_root,
                 :print_to_stderr, :print_recurring
-  attr_writer :redis
+  attr_writer :redis, :context_saver
 
   def initialize(mutex: nil)
     # on cruby hash itself is threadsafe, but we need to prevent races
@@ -79,12 +79,19 @@ class DeprecationCollector
     # NB: in production with hugreds of workers may easily overload redis with writes, so more delay needed:
     @write_interval = 900 # 15.minutes
     @write_interval_jitter = 60
+    @context_saver = nil
   end
 
   def ignored_messages=(val)
     @ignore_message_regexp = (val && Regexp.union(val)) || nil
   end
 
+  def context_saver(&block)
+    return @context_saver unless block_given?
+
+    @context_saver = block
+  end
+
   def app_root_prefix
     "#{app_root}/"
   end
@@ -228,6 +235,7 @@ class DeprecationCollector
   def store_deprecation(deprecation)
     return if deprecation.ignored?
     fresh = !@deprecations.key?(deprecation.digest)
+    deprecation.context = context_saver.call if context_saver
 
     @deprecations_mutex.synchronize do
       (@deprecations[deprecation.digest] ||= deprecation).touch

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deprecation_collector
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Vasily Fedoseyev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-02 00:00:00.000000000 Z
+date: 2022-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -54,7 +54,7 @@ metadata:
   homepage_uri: https://github.com/Vasfed/deprecation_collector
   source_code_uri: https://github.com/Vasfed/deprecation_collector
   changelog_uri: https://github.com/Vasfed/deprecation_collector/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -69,8 +69,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Collector for ruby/rails deprecations and warnings, suitable for production
 test_files: []