logjam_agent 0.34.2 → 0.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2dfc15309d8eff89747771c28c14be766acdbffce10fa2121e07820b9d628d84
-  data.tar.gz: 32646c3d1020458de93151ed03f3c48248fe0bef27b404c21d1a87dfad05a82e
+  metadata.gz: c22b624762a595ee627fba548bc5e41a3ac3a0180fdc8fa067969138963dd116
+  data.tar.gz: ee6d22ec9272fea8c786e16ca7088c7711b258bf1e6a7dd665270a5e5b9a5b62
 SHA512:
-  metadata.gz: fb48957ea64f8da0a16770ff30ff927019c09d604ccec6ea018a9b43da9a67fb63eb656ea61d535e089516a340c5c5e42454f764acc9bdcefcab75b5dfba1f0f
-  data.tar.gz: 5bddcb2bc40fb7e5eade6dfe290fa9cde23b9b3fb69650f092a54b838ee780726d7a11e985f1e26f708bcbf6671cdb89910c4201fc82dc9ee57592191be3c85a
+  metadata.gz: aac5ad227a70fa16e232c01abb6cea2b4852d717a7b81dc681a137bbe91d71f3cf7fc23901fc280a6db65eece15ac6c1608bf22e140351a8436020ef80a7b1db
+  data.tar.gz: d63f3d7758b328f01b2f4855c2dc9ef51cd1c1ed1152c900c46a942d389d38915d554ee732255c0ab946118209afbf528e47186a0d9825e1dfa351363615c3ab

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,17 +60,16 @@ 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)
+        @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
 
     def logdev=(log_device)
       raise "cannot connect logger to new log device" unless log_device.respond_to?(:write)
-      raise "cannot set log device" unless defined?(@logdev)
       @logdev = log_device
     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,37 @@
+module LogjamAgent
+  module SelectiveLogging
+    extend self
+
+    def logjam_only
+      old_selector = logjam_log_selector
+      self.logjam_log_selector = :logjam_only
+      yield
+    ensure
+      self.logjam_log_selector = old_selector
+    end
+
+    def logdevice_only
+      old_selector = logjam_log_selector
+      self.logjam_log_selector = :logdevice_only
+      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.2"
+  VERSION = "0.35.0"
 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,59 @@
+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
+    end
+
+    def test_normal_logging_adds_line_to_request_and_logdevice
+      assert !LogjamAgent.logjam_only?
+      assert !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?
+        assert !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
+        assert !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
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logjam_agent
 version: !ruby/object:Gem::Version
-  version: 0.34.2
+  version: 0.35.0
 platform: ruby
 authors:
 - Stefan Kaes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-31 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