nexus_semantic_logger 1.7.3 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fb8608fc5db931115c7c1398607eff97e56745183939261b1993ea10004e10e
-  data.tar.gz: 9b326b54b65bcd45a0f5a8fef49e4d0b0112710028996afcb957ff0113aae8ff
+  metadata.gz: f13512ab6f95abaa8a782f2718438d924eeca7dd1ae014c0f5419b14f0b13bfa
+  data.tar.gz: 54594c63bca42969a1639e1d6295f51a6b4faf5222e340c8dbd0e00a9e16390b
 SHA512:
-  metadata.gz: f5d864a434d1499e2b0880b55f5969e2f0856e2625d9e20db54387b01610fea866cc09191276f2c2f5ff1601927f4a2a7140f42ca70993cf6f5c5499753c055e
-  data.tar.gz: 240f197160c496ac997ae2c5cd33a672d656b6bf6280318e7926d5cb593ecac40f794316a9090dfa7984273bff9ed987cf6ef689e20591a62690dd3b40b971c5
+  metadata.gz: bc42282551ce7a194ab0e4891296891cfb0520943f7c4ba383c259a90ef59d035aacdc756c11f5ab2d18d17175e655d919d6d46f50399c8c51bde831343801e1
+  data.tar.gz: b4e966ed8e476ede32c07cfb85e16ebfb00337d7b7ba8fb9989bae1f180a2f170349f78b617b5aeae2d0c4edacf2b16d77748e566db7e89967fb8004eea3c186

data/README.md

@@ -9,7 +9,44 @@ As well as providing a semantic logger, this gem handles datadog telemetry assoc
 * logs
 * traces
 * metrics
-   * statsd is automatically attached to datadog runtime metrics and may also be used for custom metrics.
+    * statsd is automatically attached to datadog runtime metrics and may also be used for custom metrics.
+
+### Customise log level per logger
+
+For example, to show debug logging for `MySubscriber` while having all other logs on info.
+
+```
+# The log level must be set to the lowest level which can be dynamically controlled.
+LOG_LEVEL=DEBUG
+# The default level for filtered logs.
+LOG_NAMES_DEFAULT_LEVEL=INFO
+# Per level overrides for filtered logs.
+LOG_NAMES_DEBUG=MySubscriber
+```
+
+* Customised log names are available for each level e.g. `LOG_NAMES_TRACE`
+* Log names are matched on prefix.
+* Multiple log names are supported via comma separated values.
+
+### Changing log level dynamically
+
+The default level for filtered logs (`LOG_NAMES_DEFAULT_LEVEL`) may be changed on a running instance with the `WINCH`
+signal. This cycles through the available levels `[trace debug info warn error fatal]`.
+
+Note that you cannot dynamically enable a level lower than the `LOG_LEVEL`. Instead the env var must be adjusted and the
+instance restarted.
+
+Send signal: `pkill --signal WINCH --count --full "^puma.*"`
+
+Instance output: `WINCH signal changed LOG_NAMES_DEFAULT_LEVEL from debug to info`
+
+### Querying current log level
+
+The `SYS` signal will print the levels used by the running instance.
+
+Send signal: `pkill --signal SYS --count --full "^puma.*"`
+
+Instance output: `SYS signal reports LOG_LEVEL=debug LOG_NAMES_DEFAULT_LEVEL=warn`
 
 ### Sending metrics
 

data/lib/nexus_semantic_logger/appender_filter.rb

@@ -32,8 +32,12 @@ module NexusSemanticLogger
       }
     end
 
+    def self.env_level
+      @@level ||= ENV.fetch('LOG_LEVEL', Rails.application.config.log_level).downcase
+    end
+
     def self.env_names_default_level
-      @@names_default_level ||= ENV.fetch('LOG_NAMES_DEFAULT_LEVEL', Rails.application.config.log_level)
+      @@names_default_level ||= ENV.fetch('LOG_NAMES_DEFAULT_LEVEL', Rails.application.config.log_level).downcase
     end
 
     def self.env_names_trace
@@ -61,6 +65,7 @@ module NexusSemanticLogger
     end
 
     def self.flush
+      @@level = nil
       @@names_default_level = nil
       @@names_trace = nil
       @@names_debug = nil
@@ -73,5 +78,40 @@ module NexusSemanticLogger
     def self.fetch_env_names(var)
       ENV.fetch(var, '').split(',').to_set
     end
+
+    # Change LOG_LEVEL and LOG_NAMES_DEFAULT_LEVEL on a running process by sending signals.
+    # Each signal rotates through the levels, wrapping around.
+    # Based on SemanticLogger.add_signal_handler.
+    # Note that USR1/USR2 are already used by puma. WINCH/SYS should be unused these days.
+    def self.add_signal_handler(log_names_level_signal = "WINCH", info_signal = "SYS")
+      if log_names_level_signal
+        Signal.trap(log_names_level_signal) do
+          current_level = env_names_default_level
+          next_level = get_next_log_level(current_level)
+          @@names_default_level = next_level
+          puts "#{log_names_level_signal} signal changed LOG_NAMES_DEFAULT_LEVEL from #{current_level} to #{next_level}"
+        rescue => err
+          puts "Error handling signal #{log_names_level_signal}: #{err}"
+          puts err.backtrace
+        end
+      end
+
+      if info_signal
+        Signal.trap(info_signal) do
+          current_level = env_names_default_level
+          puts "#{info_signal} signal reports LOG_LEVEL=#{env_level} LOG_NAMES_DEFAULT_LEVEL=#{current_level}"
+        rescue => err
+          puts "Error handling signal #{info_signal}: #{err}"
+          puts err.backtrace
+        end
+      end
+    end
+
+    def self.get_next_log_level(current_log_level)
+      current_log_level_index = SemanticLogger::Levels.index(current_log_level)
+      next_log_level_index = current_log_level_index + 1
+      next_log_level_index = 0 if next_log_level_index >= SemanticLogger::Levels.all_levels.size
+      SemanticLogger::Levels.level(next_log_level_index)
+    end
   end
 end

data/lib/nexus_semantic_logger/application.rb

@@ -35,6 +35,7 @@ module NexusSemanticLogger
       config.rails_semantic_logger.add_file_appender = false
       dd_appender = config.semantic_logger.add_appender(io: $stdout, formatter: config.rails_semantic_logger.format)
       dd_appender.filter = NexusSemanticLogger::AppenderFilter.filter_lambda
+      NexusSemanticLogger::AppenderFilter.add_signal_handler
 
       NexusSemanticLogger::DatadogTracer.new(service)
 

data/lib/nexus_semantic_logger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module NexusSemanticLogger
-  # Leave this as 1.7.3 in order for CI process to replace with the tagged version.
-  VERSION = '1.7.3'
+  # Leave this as 1.8.0 in order for CI process to replace with the tagged version.
+  VERSION = '1.8.0'
 end

data/lib/nexus_semantic_logger.rb

@@ -11,3 +11,12 @@ module NexusSemanticLogger
     DatadogSingleton.instance
   end
 end
+
+# Patch access to LEVELS array.
+module SemanticLogger
+  module Levels
+    def self.all_levels
+      LEVELS
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexus_semantic_logger
 version: !ruby/object:Gem::Version
-  version: 1.7.3
+  version: 1.8.0
 platform: ruby
 authors:
 - Johnathon Harris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-22 00:00:00.000000000 Z
+date: 2022-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print