logjam_agent 0.34.3 → 0.35.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f440bd17eaed288b652b4537a82ebcedaa6aae2c213e99cfce4c9a78259c8e1a
-  data.tar.gz: 4c437031ed233e9b836714742f37e23a6b8b2bcc81155776d8ce31b17040cdd5
+  metadata.gz: 3f6c65ee6f965cad2efa823e0c7bbdc2445bcc03b5eb5b925a80a3cf5750440b
+  data.tar.gz: cfc487c0f873c6eeb63e90c2680c31394eb112231a9a8f17273864bf26f1f5a3
 SHA512:
-  metadata.gz: d614ce5608d99b1735766d0d99a0b99d64a78bd75146891036d0063b11728ef8d92b0fcbb3de1bd95acd92999969fb0d4afcc06c9a439e986c279848eb899ee6
-  data.tar.gz: 4f63d8cef062c3350e6fbbc26a997300fb5928430bf335a3d3efb959e97fd6ca7e14e13bd1ca15a4d58575485104005416b042b2b4546d6a1c017218b8789efa
+  metadata.gz: 9465b7e6caf9e029b6d68112829a5720f2ee3d3ffc31b53cf3331b24497a9c46f971f3cd30b683feba7022bb56066797fb18b8fc35bd2f542510fd2a9d844eb3
+  data.tar.gz: f5217174aaf9331df102b3a367d6e1d755cc2a689c8e778c7b676d8469e9ba32159b3c06d8d4dccdad956811f55ec86e50e6af935be698ad9f7bb0179b22aff6

data/README.md

@@ -166,6 +166,16 @@ Sinatra's environment setting.
 Set the environment variable `APP_LOG_TO_STDOUT` if you want to log to `STDOUT`.
 Otherwise, logs will appear in the subdirectory `log` of your application's root.
 
+## Selective Logging
+
+The agent adds log lines to the request information sent via ZMQ on
+the logging bus and also writes log lines to the configured log
+device.
+
+Using one of the logjam helpers `LogjamAgent.logjam_only` or
+`LogjamAgent.logdevice_only` it is possible to send information to
+only one of those log line sinks for the duration of a given block.
+
 
 ## Troubleshooting
 

data/lib/logjam_agent/buffered_logger.rb

@@ -60,11 +60,11 @@ module LogjamAgent
       attributes = formatter.render_attributes
       message = "[#{attributes}] #{message}" if attributes
       time = Time.now
-      if log_to_log_device
+      if log_to_log_device && !SelectiveLogging.logjam_only?
         formatted_message = formatter.call(format_severity(severity), time, progname, message)
         @logdev.write(formatted_message) if @logdev
       end
-      request.add_line(severity, time, message) if request
+      request.add_line(severity, time, message) if request && !SelectiveLogging.logdevice_only?
       message
     end
 

data/lib/logjam_agent/request_handling.rb

@@ -0,0 +1,28 @@
+module LogjamAgent
+  module RequestHandling
+    extend self
+
+    def request
+      Thread.current.thread_variable_get(:logjam_request)
+    end
+
+    def request=(request)
+      Thread.current.thread_variable_set(:logjam_request, request)
+    end
+
+    def start_request(*args)
+      initial_fields = args.extract_options!
+      app = args[0] || LogjamAgent.application_name
+      env = args[1] || LogjamAgent.environment_name
+      self.request = Request.new(app, env, initial_fields)
+    end
+
+    def finish_request(additional_fields = {})
+      if request = self.request
+        request.fields.merge!(additional_fields)
+        self.request = nil
+        request.forward
+      end
+    end
+  end
+end

data/lib/logjam_agent/selective_logging.rb

@@ -0,0 +1,40 @@
+module LogjamAgent
+  module SelectiveLogging
+    extend self
+
+    mattr_accessor :selective_logging_enabled
+    self.selective_logging_enabled = true
+
+    def logjam_only
+      old_selector = logjam_log_selector
+      self.logjam_log_selector = :logjam_only if selective_logging_enabled
+      yield
+    ensure
+      self.logjam_log_selector = old_selector
+    end
+
+    def logdevice_only
+      old_selector = logjam_log_selector
+      self.logjam_log_selector = :logdevice_only  if selective_logging_enabled
+      yield
+    ensure
+      self.logjam_log_selector = old_selector
+    end
+
+    def logjam_log_selector
+      Thread.current.thread_variable_get(:logjam_log_selector)
+    end
+
+    def logjam_log_selector=(selector)
+      Thread.current.thread_variable_set(:logjam_log_selector, selector)
+    end
+
+    def logjam_only?
+      logjam_log_selector == :logjam_only
+    end
+
+    def logdevice_only?
+      logjam_log_selector == :logdevice_only
+    end
+  end
+end

data/lib/logjam_agent/version.rb

@@ -1,3 +1,3 @@
 module LogjamAgent
-  VERSION = "0.34.3"
+  VERSION = "0.35.1"
 end

data/lib/logjam_agent.rb

@@ -8,38 +8,13 @@ module Logger::Severity
   NONE = UNKNOWN + 1
 end
 
-module LogjamAgent
-  module RequestHandling
-    def request
-      Thread.current.thread_variable_get(:logjam_request)
-    end
-
-    def request=(request)
-      Thread.current.thread_variable_set(:logjam_request, request)
-    end
-
-    def start_request(*args)
-      initial_fields = args.extract_options!
-      app = args[0] || LogjamAgent.application_name
-      env = args[1] || LogjamAgent.environment_name
-      self.request = Request.new(app, env, initial_fields)
-    end
-
-    def finish_request(additional_fields = {})
-      if request = self.request
-        request.fields.merge!(additional_fields)
-        self.request = nil
-        request.forward
-      end
-    end
-  end
-end
-
 require "logjam_agent/version"
 require "logjam_agent/util"
 require "logjam_agent/zmq_forwarder"
 require "logjam_agent/forwarders"
 require "logjam_agent/request"
+require "logjam_agent/selective_logging"
+require "logjam_agent/request_handling"
 require "logjam_agent/buffered_logger"
 require "logjam_agent/logging_attributes"
 require "logjam_agent/syslog_like_formatter"
@@ -120,6 +95,7 @@ module LogjamAgent
   end
 
   extend RequestHandling
+  extend SelectiveLogging
 
   NO_COMPRESSION = 0
   ZLIB_COMPRESSION = 1

data/test/selective_logging_test.rb

@@ -0,0 +1,70 @@
+require_relative "test_helper.rb"
+
+module LogjamAgent
+  class SelectiveLoggingTest < MiniTest::Test
+    class MockLogDev
+      attr_reader :lines
+      def initialize
+        @lines = []
+      end
+      def write(s)
+        @lines << s
+      end
+    end
+
+    def setup
+      @request = LogjamAgent.request = Request.new("app", "env", {})
+      @lines = @request.instance_variable_get :@lines
+      @logger = BufferedLogger.new(File::NULL)
+      @device = MockLogDev.new
+      @logger.logdev = @device
+    end
+
+    def teardown
+      LogjamAgent.request = nil
+      LogjamAgent.selective_logging_enabled = true
+    end
+
+    def test_normal_logging_adds_line_to_request_and_logdevice
+      refute LogjamAgent.logjam_only?
+      refute LogjamAgent.logdevice_only?
+      @logger.info("normal")
+      assert_equal 1, @lines.size
+      assert_equal "normal", @lines.first.last
+      assert_equal 1, @device.lines.size
+      assert_match(/normal\n/, @device.lines.first)
+    end
+
+    def test_logjam_only_logging_adds_line_to_request_but_not_to_logdevice
+      LogjamAgent.logjam_only do
+        assert LogjamAgent.logjam_only?
+        refute LogjamAgent.logdevice_only?
+        @logger.info("logjam_only")
+      end
+      assert_equal 1, @lines.size
+      assert_equal "logjam_only", @lines.first.last
+      assert_equal 0, @device.lines.size
+    end
+
+    def test_logdevice_only_logging_adds_line_to_logdevice_but_not_to_request
+      LogjamAgent.logdevice_only do
+        refute LogjamAgent.logjam_only?
+        assert LogjamAgent.logdevice_only?
+        @logger.info("logdevice_only")
+      end
+      assert_equal [], @lines
+      assert_equal 1, @device.lines.size
+      assert_match(/logdevice_only\n/, @device.lines.first)
+    end
+
+    def test_select_logging_can_be_globally_disabled
+      LogjamAgent.selective_logging_enabled = false
+      LogjamAgent.logdevice_only do
+        refute LogjamAgent.logdevice_only?
+      end
+      LogjamAgent.logjam_only do
+        refute LogjamAgent.logjam_only?
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logjam_agent
 version: !ruby/object:Gem::Version
-  version: 0.34.3
+  version: 0.35.1
 platform: ruby
 authors:
 - Stefan Kaes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-05 00:00:00.000000000 Z
+date: 2022-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -244,12 +244,15 @@ files:
 - lib/logjam_agent/railtie.rb
 - lib/logjam_agent/receiver.rb
 - lib/logjam_agent/request.rb
+- lib/logjam_agent/request_handling.rb
+- lib/logjam_agent/selective_logging.rb
 - lib/logjam_agent/sinatra.rb
 - lib/logjam_agent/syslog_like_formatter.rb
 - lib/logjam_agent/util.rb
 - lib/logjam_agent/version.rb
 - lib/logjam_agent/zmq_forwarder.rb
 - test/request_test.rb
+- test/selective_logging_test.rb
 - test/sinatra_app.rb
 - test/sinatra_classic_app.rb
 - test/sinatra_classic_test.rb
@@ -282,6 +285,7 @@ specification_version: 4
 summary: Logjam client library to be used with logjam
 test_files:
 - test/sinatra_app.rb
+- test/selective_logging_test.rb
 - test/sinatra_classic_test.rb
 - test/sinatra_classic_app.rb
 - test/request_test.rb