logjam_agent 0.35.1 → 0.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f6c65ee6f965cad2efa823e0c7bbdc2445bcc03b5eb5b925a80a3cf5750440b
-  data.tar.gz: cfc487c0f873c6eeb63e90c2680c31394eb112231a9a8f17273864bf26f1f5a3
+  metadata.gz: b0980fb837410c08361600e378f44a6bacf83a36ecd95fa3090348f4dc0ca5d9
+  data.tar.gz: 8f191a84d982672fee5a7b00bfc8faf9d37c98f6573ecd2c72911fc00584986e
 SHA512:
-  metadata.gz: 9465b7e6caf9e029b6d68112829a5720f2ee3d3ffc31b53cf3331b24497a9c46f971f3cd30b683feba7022bb56066797fb18b8fc35bd2f542510fd2a9d844eb3
-  data.tar.gz: f5217174aaf9331df102b3a367d6e1d755cc2a689c8e778c7b676d8469e9ba32159b3c06d8d4dccdad956811f55ec86e50e6af935be698ad9f7bb0179b22aff6
+  metadata.gz: 9f7c46d32b4c7dd42279a9e20a4b834baad1082201234fb8ccd26466846d04572139d1542abe5c637bba39cc722177952fa67a639bc05d6f8c379d19867fbece
+  data.tar.gz: 2f56ac4b0f6e6b0a9e7c11e5b7b6314343726f8fa9c164181f2c5dd7b262e207ef5b6739d90f5afb38fb6857c87168a07457c25a371d094d66b86541af961735

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,11 @@ 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.log_info[:path] = path
+        logjam_request.log_info[:method] = request.method
 
         logjam_request.start_time = start_time
         logjam_fields = logjam_request.fields
@@ -111,7 +122,9 @@ 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?
+        LogjamAgent.logjam_only do
+          info "Started #{request.request_method} \"#{path}\" for #{ip} at #{start_time.to_default_s}" unless logjam_request.ignored?(:asset)
+        end
         if spoofed
           error spoofed
           raise spoofed
@@ -138,9 +151,20 @@ module LogjamAgent
           warn LogjamAgent::NegativeWaitTime.new("#{wait_time_ms} ms")
         end
 
-        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?
+        http_status = "#{status} #{::Rack::Utils::HTTP_STATUS_CODES[status]}"
+        LogjamAgent.logjam_only do
+          message = "Completed #{http_status} in %.1fms" % run_time_ms
+          message << " (#{additions.join(' | ')})" unless additions.blank?
+          info message unless logjam_request.ignored?(:asset)
+        end
+        if LogjamAgent.selective_logging_enabled
+          LogjamAgent.logdevice_only do
+            logjam_request.log_info[:status] = status
+            logjam_request.log_info[:duration] = run_time_ms
+            # logjam_request.log_info[:metrics] = TimeBandits.metrics.reject{|k,v| v.zero?}
+            info "Completed #{http_status} #{logjam_request.log_info.to_json}"
+          end
+        end
 
         ActiveSupport::LogSubscriber.flush_all!
         request_info = { :total_time => run_time_ms, :code => status }

data/lib/logjam_agent/rack/rails_support.rb

@@ -16,10 +16,18 @@ module ActionController #:nodoc:
       full_name = "#{controller}##{action}"
       action_name = LogjamAgent.action_name_proc.call(full_name)
 
-      LogjamAgent.request.fields[:action] = action_name
+      request = LogjamAgent.request
+      request.fields[:action] = action_name
 
-      info "Processing by #{full_name} as #{format}"
-      info "  Parameters: #{params.inspect}" unless params.empty?
+      request.log_info[:action] = action
+      request.log_info[:controller] = controller
+      request.log_info[:format] = format
+      # request.log_info[:params] = params
+
+      LogjamAgent.logjam_only do
+        info "Processing by #{full_name} as #{format}"
+        info "  Parameters: #{params.inspect}" unless params.empty?
+      end
     end
   end
 

data/lib/logjam_agent/request.rb

@@ -6,7 +6,7 @@ end
 
 module LogjamAgent
   class Request
-    attr_reader :fields, :uuid, :start_time
+    attr_reader :fields, :uuid, :start_time, :log_info
     attr_accessor :log_device_ignored_lines
 
     def initialize(app, env, initial_fields)
@@ -39,6 +39,7 @@ module LogjamAgent
       @max_bytes_all_lines = LogjamAgent.max_bytes_all_lines
       @max_line_length = LogjamAgent.max_line_length
       @lines_dropped = false
+      @log_info = {}
     end
 
     def start_time=(start_time)
@@ -47,12 +48,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/version.rb

@@ -1,3 +1,3 @@
 module LogjamAgent
-  VERSION = "0.35.1"
+  VERSION = "0.37.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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logjam_agent
 version: !ruby/object:Gem::Version
-  version: 0.35.1
+  version: 0.37.0
 platform: ruby
 authors:
 - Stefan Kaes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-17 00:00:00.000000000 Z
+date: 2022-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake