logjam_agent 0.35.0 → 0.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c22b624762a595ee627fba548bc5e41a3ac3a0180fdc8fa067969138963dd116
-  data.tar.gz: ee6d22ec9272fea8c786e16ca7088c7711b258bf1e6a7dd665270a5e5b9a5b62
+  metadata.gz: 238a6d18a9fdd1fdf660314a3e3de7706e658e08ab304aa4874d7e73985c787d
+  data.tar.gz: 208a910c0abadf9572d1e9f872eee8b90c8d3706e9a59bf8c550d64cb1144281
 SHA512:
-  metadata.gz: aac5ad227a70fa16e232c01abb6cea2b4852d717a7b81dc681a137bbe91d71f3cf7fc23901fc280a6db65eece15ac6c1608bf22e140351a8436020ef80a7b1db
-  data.tar.gz: d63f3d7758b328f01b2f4855c2dc9ef51cd1c1ed1152c900c46a942d389d38915d554ee732255c0ab946118209afbf528e47186a0d9825e1dfa351363615c3ab
+  metadata.gz: f1852e9eec5abceed5a8ddd8977188a1a86ae415c6883e01db30d5471e0d20def84c07ad1eadb947e1809860c61e72010ad8dbb2aaaf92c6c842f3f3029708e5
+  data.tar.gz: 5565c68259a98b4561240cc3f2a1bd1233598efa3aeca555db6c78183d0064376e5d3f1acfd13469bee5654e8565bee217843f7bd965b49d93a586662db4d1f3

data/README.md

@@ -62,6 +62,12 @@ module LogjamAgent
   # to debug asset request handling.
   self.ignore_asset_requests = Rails.env.development?
 
+  # Configure a list of URL patterns for which no data should be sent
+  # to logjam and nothing should be sent to the log device. Please not
+  # that the log lines will still show up in dev mode on the console.
+  # Defaults to the empty list.
+  # self.ignored_request_urls = [%r{/_system/}]
+
   # Disable ActiveSupport::Notifications (and thereby logging) of ActionView
   # render events. Defaults to false.
   # self.ignore_render_events = Rails.env.production?

data/lib/logjam_agent/buffered_logger.rb

@@ -57,6 +57,7 @@ module LogjamAgent
         end
       end
       log_to_log_device = LogjamAgent.log_to_log_device?(severity, message)
+      log_to_log_device = false if request && request.ignored?
       attributes = formatter.render_attributes
       message = "[#{attributes}] #{message}" if attributes
       time = Time.now

data/lib/logjam_agent/rack/logger.rb

@@ -11,6 +11,7 @@ module LogjamAgent
         @hostname = LogjamAgent.hostname
         @asset_prefix = Rails.application.config.assets.prefix rescue "---"
         @ignore_asset_requests = LogjamAgent.ignore_asset_requests
+        @ignored_request_urls = LogjamAgent.ignored_request_urls
       end
 
       def call(env)
@@ -88,6 +89,12 @@ module LogjamAgent
         false
       end
 
+      def ignored_request_url?(path)
+        @ignored_request_urls.any?{|url_pattern| path =~ url_pattern}
+      rescue
+        false
+      end
+
       def before_dispatch(request, env, start_time, wait_time_ms)
         logger.formatter.reset_attributes if logger.formatter.respond_to?(:reset_attributes)
         TimeBandits.reset
@@ -96,7 +103,8 @@ module LogjamAgent
         path = request.filtered_path
 
         logjam_request = LogjamAgent.request
-        logjam_request.ignore! if ignored_asset_request?(path)
+        logjam_request.ignore!(:asset) if ignored_asset_request?(path)
+        logjam_request.ignore!(:url) if ignored_request_url?(path)
 
         logjam_request.start_time = start_time
         logjam_fields = logjam_request.fields
@@ -111,7 +119,7 @@ module LogjamAgent
         logjam_fields.merge!(:ip => ip, :host => @hostname)
         logjam_fields.merge!(extract_request_info(request))
 
-        info "Started #{request.request_method} \"#{path}\" for #{ip} at #{start_time.to_default_s}" unless logjam_request.ignored?
+        info "Started #{request.request_method} \"#{path}\" for #{ip} at #{start_time.to_default_s}" unless logjam_request.ignored?(:asset)
         if spoofed
           error spoofed
           raise spoofed
@@ -140,7 +148,7 @@ module LogjamAgent
 
         message = "Completed #{status} #{::Rack::Utils::HTTP_STATUS_CODES[status]} in %.1fms" % run_time_ms
         message << " (#{additions.join(' | ')})" unless additions.blank?
-        info message unless logjam_request.ignored?
+        info message unless logjam_request.ignored?(:asset)
 
         ActiveSupport::LogSubscriber.flush_all!
         request_info = { :total_time => run_time_ms, :code => status }

data/lib/logjam_agent/request.rb

@@ -47,12 +47,12 @@ module LogjamAgent
       @fields[:started_ms] = start_time.tv_sec * 1000 + start_time.tv_usec / 1000
     end
 
-    def ignore!
-      @ignored = true
+    def ignore!(reason = nil)
+      @ignored = reason || :unknown
     end
 
-    def ignored?
-      @ignored
+    def ignored?(reason = nil)
+      reason ? @ignored == reason : @ignored
     end
 
     def id

data/lib/logjam_agent/selective_logging.rb

@@ -2,9 +2,12 @@ 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
+      self.logjam_log_selector = :logjam_only if selective_logging_enabled
       yield
     ensure
       self.logjam_log_selector = old_selector
@@ -12,7 +15,7 @@ module LogjamAgent
 
     def logdevice_only
       old_selector = logjam_log_selector
-      self.logjam_log_selector = :logdevice_only
+      self.logjam_log_selector = :logdevice_only  if selective_logging_enabled
       yield
     ensure
       self.logjam_log_selector = old_selector

data/lib/logjam_agent/version.rb

@@ -1,3 +1,3 @@
 module LogjamAgent
-  VERSION = "0.35.0"
+  VERSION = "0.36.0"
 end

data/lib/logjam_agent.rb

@@ -133,6 +133,9 @@ module LogjamAgent
   mattr_accessor :exception_matcher
   self.exception_matcher = nil
 
+  mattr_accessor :ignored_request_urls
+  self.ignored_request_urls = []
+
   mattr_accessor :ignore_asset_requests
   self.ignore_asset_requests = false
 

data/test/selective_logging_test.rb

@@ -22,11 +22,12 @@ module LogjamAgent
 
     def teardown
       LogjamAgent.request = nil
+      LogjamAgent.selective_logging_enabled = true
     end
 
     def test_normal_logging_adds_line_to_request_and_logdevice
-      assert !LogjamAgent.logjam_only?
-      assert !LogjamAgent.logdevice_only?
+      refute LogjamAgent.logjam_only?
+      refute LogjamAgent.logdevice_only?
       @logger.info("normal")
       assert_equal 1, @lines.size
       assert_equal "normal", @lines.first.last
@@ -37,7 +38,7 @@ module LogjamAgent
     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?
+        refute LogjamAgent.logdevice_only?
         @logger.info("logjam_only")
       end
       assert_equal 1, @lines.size
@@ -47,7 +48,7 @@ module LogjamAgent
 
     def test_logdevice_only_logging_adds_line_to_logdevice_but_not_to_request
       LogjamAgent.logdevice_only do
-        assert !LogjamAgent.logjam_only?
+        refute LogjamAgent.logjam_only?
         assert LogjamAgent.logdevice_only?
         @logger.info("logdevice_only")
       end
@@ -55,5 +56,15 @@ module LogjamAgent
       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.35.0
+  version: 0.36.0
 platform: ruby
 authors:
 - Stefan Kaes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-17 00:00:00.000000000 Z
+date: 2022-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake