nexus_semantic_logger 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4d34bf88bf2a928a063405a76a758fb9c456b98ef95648e566ac3a41020f6a1
-  data.tar.gz: b371208a349846331dc45b38cd64b8da000e6df7b6e05bb03de4c7820c0be504
+  metadata.gz: 2f12150f394b0f2c56570a19a1979c3f8cf0f58f3c622d6d2886ed6925041825
+  data.tar.gz: 7fc2853cb92631be96b8bc17f07d97eff6057091170704d28ef0280b673ac370
 SHA512:
-  metadata.gz: 194c8b3e44165a6c4006a1c972ed1b4c89b52828c960a73c2873ac05a155cf4a6f0939ceace374376fb87c99348906bf1a7103ca981b4db4caafcb2e1737b959
-  data.tar.gz: 8d85828bf271757d7cdf8409ec9707aabeef7fcb5fd4503835ce2b41650a2b797228a187bb3637deca84c14029e57989dfa204385495cedf8da236c11f5deb9a
+  metadata.gz: dd9b6db086b0b1bb5f8cb760577d87a8603ae892aeeb8e01249081911f3b83068e96357ad0c13a8fa184e96a63efb9f55241bbcc1baa7aa4e513021dd713689b
+  data.tar.gz: '084c137b346270f171132a5de282a3a2019be85fe5a83de3677cedf26290f6f7b1ced55c2ede9cbd57afe9daa6ed9d5d58ddf60ce5e7954d6e3b937753302e30'

data/.rubocop.yml

@@ -1,6 +1,10 @@
 inherit_gem:
   rubocop-shopify: rubocop.yml
 
+Style/ClassVars:
+  Enabled: false
+Style/ConditionalAssignment:
+  Enabled: false
 Style/GlobalVars:
   Enabled: false
 Style/FrozenStringLiteralComment:

data/lib/nexus_semantic_logger/appender_filter.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+require 'rails_semantic_logger'
+
+module NexusSemanticLogger
+  class AppenderFilter
+    def self.filter_lambda
+      -> (log) {
+        # log API see https://logger.rocketjob.io/log_struct.html
+        # and lib/semantic_logger/levels.rb
+        # level: :trace=>0, :debug=>1, :info=>2, :warn=>3, :error=>4, :fatal=>5
+        current_log_level = SemanticLogger::Levels.index(env_names_default_level)
+
+        # Names allow overriding the level that will be appended,
+        # else the global level is used to determine appending.
+        append = false
+        if log.name.in?(env_names_trace)
+          append = true
+        elsif log.name.in?(env_names_debug)
+          append = log.level_index >= 1
+        elsif log.name.in?(env_names_info)
+          append = log.level_index >= 2
+        elsif log.name.in?(env_names_warn)
+          append = log.level_index >= 3
+        elsif log.name.in?(env_names_error)
+          append = log.level_index >= 4
+        elsif log.name.in?(env_names_fatal)
+          append = log.level_index >= 5
+        else
+          append = log.level_index >= current_log_level
+        end
+        append
+      }
+    end
+
+    def self.env_names_default_level
+      @@names_default_level ||= ENV.fetch('LOG_NAMES_DEFAULT_LEVEL', Rails.application.config.log_level)
+    end
+
+    def self.env_names_trace
+      @@names_trace ||= fetch_env_names('LOG_NAMES_TRACE')
+    end
+
+    def self.env_names_debug
+      @@names_debug ||= fetch_env_names('LOG_NAMES_DEBUG')
+    end
+
+    def self.env_names_info
+      @@names_info ||= fetch_env_names('LOG_NAMES_INFO')
+    end
+
+    def self.env_names_warn
+      @@names_warn ||= fetch_env_names('LOG_NAMES_WARN')
+    end
+
+    def self.env_names_error
+      @@names_error ||= fetch_env_names('LOG_NAMES_ERROR')
+    end
+
+    def self.env_names_fatal
+      @@names_fatal ||= fetch_env_names('LOG_NAMES_FATAL')
+    end
+
+    def self.flush
+      @@names_default_level = nil
+      @@names_trace = nil
+      @@names_debug = nil
+      @@names_info = nil
+      @@names_warn = nil
+      @@names_error = nil
+      @@names_fatal = nil
+    end
+
+    def self.fetch_env_names(var)
+      ENV.fetch(var, '').split(',').to_set
+    end
+  end
+end

data/lib/nexus_semantic_logger/application.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'semantic_logger'
+require 'rails_semantic_logger'
 
 module NexusSemanticLogger
   class Application
@@ -33,7 +33,8 @@ module NexusSemanticLogger
       # Default logging is stdout in datadog compatible JSON.
       config.rails_semantic_logger.format = NexusSemanticLogger::DatadogFormatter.new(service)
       config.rails_semantic_logger.add_file_appender = false
-      config.semantic_logger.add_appender(io: $stdout, formatter: config.rails_semantic_logger.format)
+      dd_appender = config.semantic_logger.add_appender(io: $stdout, formatter: config.rails_semantic_logger.format)
+      dd_appender.filter = NexusSemanticLogger::AppenderFilter.filter_lambda
 
       logger.info('SemanticLogger initialised.', level: config.log_level)
     end
@@ -44,13 +45,19 @@ module NexusSemanticLogger
 
       # Change default logging to coloured logging on stdout.
       config.semantic_logger.clear_appenders!
-      config.semantic_logger.add_appender(io: $stdout, formatter: :color)
+      color_appender = config.semantic_logger.add_appender(io: $stdout, formatter: :color)
+      color_appender.filter = NexusSemanticLogger::AppenderFilter.filter_lambda
+
       if ENV['DD_AGENT_HOST'].present? && ENV['DD_AGENT_PORT'].present?
         # Development logs can be sent to datadog via a TCP logging endpoint on a local agent.
         # Each port is assigned a particular service.
         # See https://logger.rocketjob.io/appenders.html
-        config.semantic_logger.add_appender(appender: :tcp, server: "#{ENV['DD_AGENT_HOST']}:#{ENV['DD_AGENT_PORT']}",
-                                            formatter: config.rails_semantic_logger.format)
+        dd_appender = config.semantic_logger.add_appender(
+          appender: :tcp,
+          server: "#{ENV['DD_AGENT_HOST']}:#{ENV['DD_AGENT_PORT']}",
+          formatter: config.rails_semantic_logger.format
+        )
+        dd_appender.filter = NexusSemanticLogger::AppenderFilter.filter_lambda
       end
 
       logger.info('SemanticLogger initialised in development.', level: config.log_level)
@@ -59,7 +66,8 @@ module NexusSemanticLogger
     def self.test(config)
       # Use human readable coloured output for logs when running tests.
       config.semantic_logger.clear_appenders!
-      config.semantic_logger.add_appender(io: $stdout, formatter: :color)
+      color_appender = config.semantic_logger.add_appender(io: $stdout, formatter: :color)
+      color_appender.filter = NexusSemanticLogger::AppenderFilter.filter_lambda
     end
   end
 end

data/lib/nexus_semantic_logger/version.rb

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

data/lib/nexus_semantic_logger.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'nexus_semantic_logger/appender_filter'
 require 'nexus_semantic_logger/application'
 require 'nexus_semantic_logger/datadog_formatter'
 

data/nexus_semantic_logger.gemspec

@@ -13,7 +13,8 @@ Gem::Specification.new do |spec|
     %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.require_paths = ['lib']
-  spec.add_dependency('amazing_print')
-  spec.add_dependency('rails_semantic_logger')
-  spec.add_dependency('net_tcp_client') # For TCP logging.
+  spec.add_dependency('amazing_print', '~> 1.4.0')
+  spec.add_dependency('rails_semantic_logger', '~> 4.10.0')
+  spec.add_dependency('net_tcp_client', '~> 2.2.0') # For TCP logging.
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: nexus_semantic_logger
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Johnathon Harris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-05 00:00:00.000000000 Z
+date: 2022-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: rails_semantic_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.10.0
 - !ruby/object:Gem::Dependency
   name: net_tcp_client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.0
 description: 
 email: john.harris@nexusmods.com
 executables: []
@@ -63,6 +63,7 @@ files:
 - Gemfile
 - README.md
 - lib/nexus_semantic_logger.rb
+- lib/nexus_semantic_logger/appender_filter.rb
 - lib/nexus_semantic_logger/application.rb
 - lib/nexus_semantic_logger/datadog_formatter.rb
 - lib/nexus_semantic_logger/version.rb
@@ -78,7 +79,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="