sapience 2.11 → 2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dea67688e4da16e54b354ef95c3307c40b4c48a7a9c731b036a759301993bad
-  data.tar.gz: e95f42b7e1b564b96436119394c5cf36bfe764e151edc27f3bdd71571d373ff3
+  metadata.gz: 189ddb34ecc477adc2d44d235d2e8dac5bfad45f40539bdd6f842938e6b3cacb
+  data.tar.gz: 1f96bc549878bca58fb5122c983eb2e75f12e6d7c5715938bd82a6316b055072
 SHA512:
-  metadata.gz: 9d44242c65762e0696ff3b34256d2ee67cee441c1a957efb988ecebaa6abd340ba2e02e1fbd5168973262e689333b7bbc4e4fd5835bc9a5472b22fbb2990c15d
-  data.tar.gz: b803898eee7e30eedfcf704d9befc942e518e53da773fe699888d6c4cdfe79402ce4bdb7f9bbfdb5f1a14b2b78cc0d7101e658c32fe1da01c181c50a80f24fc0
+  metadata.gz: 5adb1b869eef53cde71734b7bacdbc11f31e188117d694863faeb49442f8bb0726394ad8f3e830b0da12d7ff193341f2b44db908aab13a7ddb0f2ec9b6a7388a
+  data.tar.gz: d786d35fd92de4268bcfe6d8bc946406f40cafcd2e7fd1f56d67f32733d60c3fefefc24f8b682ba2e9c5abc6dd854ef04af3df4910f31fb5b21e16f5dbc29ec7

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## v2.12
+- feature: 'log hooks', a mechanism for modifying the log event just before it is added to the appender
+
 ## v2.11
 - Add config option to enable/disable metrics from ActionController
 

data/README.md

@@ -249,6 +249,34 @@ For further details about "app_name", "filter_parameters", "appenders", "metrics
 - [logger](docs/logger.md)
 
 
+### Log hooks
+*Log hooks* allow us to modify the log object **Sapience::Log** just before it is added to the appender. A 'log hook' can be an object that responds to #call. Multiple hooks can be used.
+The following examples show how to use hooks to:
+
+  * inject Datadog APM tracing data in every log event.
+  * modify the logs event's **message** field.
+
+```ruby
+my_logger = Sapience.logger
+
+# inject Datadog tracing info in payload hash
+my_logger.log_hooks << ->(log) do
+  trace_data = { 
+    dd: { 
+      span_id:  ::Datadog.tracer.active_correlation.span_id.to_s, 
+      trace_id: ::Datadog.tracer.active_correlation.trace_id.to_s 
+    }
+  }
+  log.payload? ? log.payload.merge!(trace_data) : log.payload = trace_data
+end
+
+# append number of times a GC occurred since process started in field 'message'
+my_logger.log_hooks << ->(log) do
+  log.message = "#{log.message} = GC count: #{GC.count}"
+end
+```
+
+
 ## Running the tests
 
 You need to create the test postgres db, by running the command below:

data/lib/sapience/base.rb

@@ -3,7 +3,7 @@ module Sapience
   # rubocop:disable ClassLength
   class Base
     # Class name to be logged
-    attr_accessor :name, :filter
+    attr_accessor :name, :filter, :log_hooks
     include Sapience::LogMethods
 
     # Set the logging level for this logger
@@ -174,7 +174,7 @@ module Sapience
     #    Proc: Only include log messages where the supplied Proc returns true
     #          The Proc must return true or false
     # rubocop:disable AbcSize, PerceivedComplexity, CyclomaticComplexity, LineLength
-    def initialize(klass, level = nil, filter = nil)
+    def initialize(klass, level = nil, filter = nil, log_hooks = [])
       # Support filtering all messages to this logger using a Regular Expression
       # or Proc
       fail ArgumentError, ":filter must be a Regexp or Proc" unless filter.nil? || filter.is_a?(Regexp) || filter.is_a?(Proc)
@@ -183,6 +183,7 @@ module Sapience
       @name   = klass if klass.is_a?(String)
       @name ||= klass.name if klass.respond_to?(:name)
       @name ||= klass.class.name
+      @log_hooks = log_hooks
 
       if level.nil?
         # Allow the global default level to determine this loggers log level
@@ -271,6 +272,9 @@ module Sapience
         end
         log.payload = payload unless payload.empty?
       end
+
+      log_hooks.each { |h| h.call(log) }
+
       self.log(log) if include_message?(log)
     end
     # rubocop:enable AbcSize, PerceivedComplexity, CyclomaticComplexity, LineLength

data/lib/sapience/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Sapience
-  VERSION = "2.11"
+  VERSION = "2.12"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sapience
 version: !ruby/object:Gem::Version
-  version: '2.11'
+  version: '2.12'
 platform: ruby
 authors:
 - Mikael Henriksson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 2020-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby