nexus_semantic_logger 1.7.3 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fb8608fc5db931115c7c1398607eff97e56745183939261b1993ea10004e10e
-  data.tar.gz: 9b326b54b65bcd45a0f5a8fef49e4d0b0112710028996afcb957ff0113aae8ff
+  metadata.gz: 71ea65404e5b4980ffa32eda0d91588142cd2571252117f1f651f566f506bb98
+  data.tar.gz: ade58c1fcc429f832d26ed23786d859068cefb6e33a1f7b5b32d2627de999c91
 SHA512:
-  metadata.gz: f5d864a434d1499e2b0880b55f5969e2f0856e2625d9e20db54387b01610fea866cc09191276f2c2f5ff1601927f4a2a7140f42ca70993cf6f5c5499753c055e
-  data.tar.gz: 240f197160c496ac997ae2c5cd33a672d656b6bf6280318e7926d5cb593ecac40f794316a9090dfa7984273bff9ed987cf6ef689e20591a62690dd3b40b971c5
+  metadata.gz: 0d488c447d1e7f14c49a0c33ff0ee79ff512346ea17557c68a91e4b204dd37d9bdafb04383ed4db1c7c2c71d15273a9375c49c1e031a9a710e2345b34f143db9
+  data.tar.gz: 3712bf027d2fc5668c3a593d8cbd79457aef86d69a19e5602bfe4929ba301e14f6ce9006680acfbf4ce777ba5ae42f18ee45cdb6fded3a3fa4d1e0f8c284479b

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,9 +35,12 @@ 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)
 
+      SemanticLogger.on_log(NexusSemanticLogger::LoggerMetricsSubscriber.new)
+
       logger.info('SemanticLogger initialised.', level: config.log_level)
 
       config.after_initialize do

data/lib/nexus_semantic_logger/datadog_singleton.rb

@@ -17,7 +17,7 @@ module NexusSemanticLogger
     # @param [String] metric Metric name.
     # @param [Array<String>] tags Additional tags.
     def increment(metric, tags: [])
-      statsd&.increment(metric, tags: global_tags + tags)
+      statsd&.increment(metric, tags: combine_tags(tags))
       flush
     end
 
@@ -25,7 +25,7 @@ module NexusSemanticLogger
     # @param [String] metric Metric name.
     # @param [Array<String>] tags Additional tags.
     def decrement(metric, tags: [])
-      statsd&.decrement(metric, tags: global_tags + tags)
+      statsd&.decrement(metric, tags: combine_tags(tags))
       flush
     end
 
@@ -34,7 +34,7 @@ module NexusSemanticLogger
     # @param [Integer] ms Timing in milliseconds.
     # @param [Array<String>] tags Additional tags.
     def timing(metric, ms, tags: [])
-      statsd&.timing(metric, ms, tags: global_tags + tags)
+      statsd&.timing(metric, ms, tags: combine_tags(tags))
       flush
     end
 
@@ -43,7 +43,7 @@ module NexusSemanticLogger
     # @param [Numeric] value Distribution value.
     # @param [Array<String>] tags Additional tags.
     def distribution(metric, value, tags: [])
-      statsd&.distribution(metric, value, tags: global_tags + tags)
+      statsd&.distribution(metric, value, tags: combine_tags(tags))
       flush
     end
 
@@ -52,8 +52,18 @@ module NexusSemanticLogger
     # @param [Numeric] value Gauge value.
     # @param [Array<String>] tags Additional tags.
     def gauge(metric, value, tags: [])
-      statsd&.gauge(metric, value, tags: global_tags + tags)
+      statsd&.gauge(metric, value, tags: combine_tags(tags))
       flush
     end
+
+    private
+
+    # Safely combine the global tags with the supplied tags.
+    def combine_tags(tags)
+      final_tags = []
+      final_tags += global_tags unless global_tags.nil?
+      final_tags += tags unless tags.nil?
+      final_tags
+    end
   end
 end

data/lib/nexus_semantic_logger/logger_metrics_subscriber.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require 'semantic_logger'
+
+module NexusSemanticLogger
+  # Sends SemanticLogger metrics to statsd.
+  # This is a candidate to move into the nexus_semantic_logger gem if it becomes widely useful.
+  # See https://logger.rocketjob.io/metrics.html
+  # Based on https://github.com/reidmorrison/semantic_logger/blob/master/lib/semantic_logger/metric/statsd.rb
+  class LoggerMetricsSubscriber < SemanticLogger::Subscriber
+    def call(log)
+      log(log) if should_log?(log)
+    end
+
+    def log(log)
+      metric = log.metric
+      tags = log.payload.nil? ? nil : []
+      log.payload&.each_pair { |key, value| tags << "#{key}:#{value}" }
+      if (duration = log.duration)
+        NexusSemanticLogger.metrics.timing(metric, duration, tags: tags)
+      else
+        amount = (log.metric_amount || 1).round
+        if amount.negative?
+          NexusSemanticLogger.metrics.decrement(metric, tags: tags)
+        else
+          NexusSemanticLogger.metrics.increment(metric, tags: tags)
+        end
+      end
+    end
+
+    # Only forward log entries that contain metrics.
+    def should_log?(log)
+      # Does not support metrics with dimensions.
+      log.metric && !log.dimensions && meets_log_level?(log) && !filtered?(log)
+    end
+  end
+end

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.9.0 in order for CI process to replace with the tagged version.
+  VERSION = '1.9.0'
 end

data/lib/nexus_semantic_logger.rb

@@ -4,6 +4,7 @@ require 'nexus_semantic_logger/application'
 require 'nexus_semantic_logger/datadog_formatter'
 require 'nexus_semantic_logger/datadog_singleton'
 require 'nexus_semantic_logger/datadog_tracer'
+require 'nexus_semantic_logger/logger_metrics_subscriber'
 
 module NexusSemanticLogger
   # Get application wide object for sending metrics.
@@ -11,3 +12,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.9.0
 platform: ruby
 authors:
 - Johnathon Harris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-22 00:00:00.000000000 Z
+date: 2022-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print
@@ -112,6 +112,7 @@ files:
 - lib/nexus_semantic_logger/datadog_singleton.rb
 - lib/nexus_semantic_logger/datadog_tracer.rb
 - lib/nexus_semantic_logger/extensions/action_dispatch/debug_exceptions.rb
+- lib/nexus_semantic_logger/logger_metrics_subscriber.rb
 - lib/nexus_semantic_logger/sneakers_metrics.rb
 - lib/nexus_semantic_logger/version.rb
 - nexus_semantic_logger.gemspec