logjam_agent 0.33.3 → 0.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb075dc1c42d045d800df979adde0ba2a4861de680c5154e42fb04552d2d4019
-  data.tar.gz: 6f0bf552907f852f0d6e16dcbf05f66b7d0ec5488c36e206046ae4edd5319db3
+  metadata.gz: f3cc7aaf7edaf4f4a2ab8b0cbb9922449fcadf2ca515add756d9052ca30f104a
+  data.tar.gz: 9c648bc52c752ebd7a394b9b74f5a2d2ff1f92aff23393a37dcd714b324339ea
 SHA512:
-  metadata.gz: 30597a450700826424e80d43bdd1e210b0a11e27ba1576bdfe3498fa71d3bd122d30e36b8ba5038a1e2544e30e0a7b63b2ef2e3214df7719276fbdd311d8693f
-  data.tar.gz: 271462e2feac5b3ef4eaa29197b64b7d627b6f2561b699f3f0f24ec90a567ef3925d888486e40820f69b410528215f5f790d5f6a0248a2e4a66ec22dd323e7ca
+  metadata.gz: 29350bbdb8502910e181ee155a369d0a16793a916430b4150aee46e956e931aac3ba697d9066e0bc14c6826918b1085022b492e13d283f3f49b19cd10a2a2c22
+  data.tar.gz: 1798f1ce01b48e947fd4b54455c8f446551e474b93120fed751eefc0ea72584e68b610d7d2cbe4fa7f46b4f6d97a9a82d50049339cb477b5dfad62b9a57c005f

data/lib/logjam_agent/buffered_logger.rb

@@ -27,17 +27,21 @@ end
 module LogjamAgent
   class BufferedLogger < ActiveSupport::Logger
 
-    attr_accessor :formatter
-
     # for backwards compatibility. needs to go away.
     include LogjamAgent::RequestHandling
 
     def initialize(*args)
       super(*args)
-      @formatter = lambda{|_, _, _, message| message}
+      # make sure we always have a formatter
+      self.formatter = Logger::Formatter.new
+    end
+
+    def formatter=(formatter)
+      super
+      @formatter.extend LoggingAttributes
     end
 
-    def add(severity, message = nil, progname = nil, tags_text = nil, &block)
+    def add(severity, message = nil, progname = nil, &block)
       return if level > severity
       message = progname if message.nil?
       progname = nil
@@ -53,18 +57,12 @@ module LogjamAgent
         end
       end
       log_to_log_device = LogjamAgent.log_to_log_device?(severity, message)
-      message = "#{tags_text}#{message}" unless tags_text.blank?
+      attributes = formatter.render_attributes
+      message = "[#{attributes}] #{message}" if attributes
       time = Time.now
       if log_to_log_device
-        formatted_message = formatter.call(severity, time, progname, message)
-        if respond_to?(:buffer)
-          buffer <<  formatted_message << "\n"
-          auto_flush
-        elsif @log # @log is a logger (or nil for rails 4)
-          @log << "#{formatted_message}\n"
-        elsif @logdev
-          @logdev.write(formatted_message)
-        end
+        formatted_message = formatter.call(format_severity(severity), time, progname, message)
+        @logdev.write(formatted_message)
       end
       request.add_line(severity, time, message) if request
       message
@@ -72,18 +70,22 @@ module LogjamAgent
 
     def logdev=(log_device)
       raise "cannot connect logger to new log device" unless log_device.respond_to?(:write)
-      if respond_to?(:buffer)
-        @log = log_device
-      else
-        (@log||self).instance_eval do
-          raise "cannot set log device" unless defined?(@logdev)
-          @logdev = log_device
-        end
-      end
+      raise "cannot set log device" unless defined?(@logdev)
+      @logdev = log_device
     end
 
     private
 
+    SEV_LABEL_CACHE = SEV_LABEL.map{|sev| "%-5s" % sev}
+
+    def format_severity(severity)
+      if severity.is_a?(String)
+        "%-5s" % severity
+      else
+        SEV_LABEL_CACHE[severity] || 'ALIEN'
+      end
+    end
+
     def detect_logged_exception(message)
       (matcher = LogjamAgent.exception_matcher) && message[matcher]
     end

data/lib/logjam_agent/logging_attributes.rb

@@ -0,0 +1,33 @@
+module LogjamAgent
+  module LoggingAttributes
+
+    extend self
+
+    def attributes=(attributes)
+      Thread.current.thread_variable_set(:__logjam_agent_logging_attributes__, attributes)
+    end
+
+    def attributes
+      Thread.current.thread_variable_get(:__logjam_agent_logging_attributes__) ||
+        Thread.current.thread_variable_set(:__logjam_agent_logging_attributes__, [])
+    end
+
+    def set_attribute(name, value)
+      if attribute = attributes.detect{|n,v| n == name}
+        attribute[1] = value
+      else
+        attributes << [name, value]
+      end
+    end
+
+    def reset_attributes
+      self.attributes = []
+    end
+
+    def render_attributes
+      attrs = attributes.select{|k,v| !k.nil? }
+      attrs.empty? ? nil : attrs.map{|k,v| "#{k}=#{v}"}.join(" ")
+    end
+
+  end
+end

data/lib/logjam_agent/railtie.rb

@@ -8,9 +8,9 @@ module LogjamAgent
   autoload :Middleware, 'logjam_agent/middleware'
 
   class Railtie < Rails::Railtie
+
     def logjam_log_path(app)
-      paths = app.config.paths
-      (Rails::VERSION::STRING < "3.1" ? paths.log.to_a : paths['log']).first.to_s
+      app.config.paths['log'].first.to_s
     end
 
     initializer "initialize_logjam_agent_logger", :before => :initialize_logger do |app|
@@ -18,27 +18,21 @@ module LogjamAgent
         begin
           path = ENV["RAILS_LOG_TO_STDOUT"].present? ? STDOUT : logjam_log_path(app)
           logger = LogjamAgent::BufferedLogger.new(path)
+          logger.formatter = app.config.log_formatter || LogjamAgent::SyslogLikeFormatter.new
+          logger = ActiveSupport::TaggedLogging.new(logger)
           logger.level = ::Logger.const_get(app.config.log_level.to_s.upcase)
           LogjamAgent.log_device_log_level = logger.level
-          logger.formatter = LogjamAgent::SyslogLikeFormatter.new
-          logger.auto_flushing = false if Rails.env.production? && Rails::VERSION::STRING < "3.2"
-          logger = ActiveSupport::TaggedLogging.new(logger) if Rails::VERSION::STRING >= "3.2"
           LogjamAgent.logger = logger
-          logger
         rescue StandardError
           logger = LogjamAgent::BufferedLogger.new(STDERR)
-          logger = ActiveSupport::TaggedLogging.new(logger) if Rails::VERSION::STRING >= "3.2"
-          LogjamAgent.logger = logger
+          logger = ActiveSupport::TaggedLogging.new(logger)
           logger.level = ::Logger::WARN
           logger.warn(
-                      "Logging Error: Unable to access log file. Please ensure that #{path} exists and is writable. " +
-                      "The log level has been raised to WARN and the output directed to STDERR until the problem is fixed."
-                      )
-          logger
+            "Logging Error: Unable to access log file. Please ensure that #{path} exists and is writable. " +
+            "The log level has been raised to WARN and the output directed to STDERR until the problem is fixed."
+          )
+          LogjamAgent.logger = logger
         end
-      if Rails::VERSION::STRING < "3.2"
-        at_exit { Rails.logger.flush if Rails.logger.respond_to?(:flush) }
-      end
     end
 
     initializer "logjam_agent", :after => "time_bandits" do |app|

data/lib/logjam_agent/syslog_like_formatter.rb

@@ -1,32 +1,8 @@
-require 'logger'
-
 module LogjamAgent
   class SyslogLikeFormatter
     def initialize
       @hostname = LogjamAgent.hostname
       @app_name = "rails"
-      @newline = ActiveSupport::VERSION::STRING < "4.0" ? "" : "\n"
-    end
-
-    def attributes=(attributes)
-      Thread.current.thread_variable_set(:__logjam_formatter_attributes__, attributes)
-    end
-
-    def attributes
-      unless attributes = Thread.current.thread_variable_get(:__logjam_formatter_attributes__)
-        attributes = Thread.current.thread_variable_set(:__logjam_formatter_attributes__, [])
-      end
-      attributes
-    end
-
-    SEV_LABEL = Logger::SEV_LABEL.map{|sev| "%-5s" % sev}
-
-    def format_severity(severity)
-      if severity.is_a?(String)
-        "%-5s" % severity
-      else
-        SEV_LABEL[severity] || 'ALIEN'
-      end
     end
 
     def format_time(timestamp)
@@ -38,7 +14,7 @@ module LogjamAgent
     end
 
     def call(severity, timestamp, progname, msg)
-      "#{format_severity(severity)} #{format_time(timestamp)}#{render_attributes}#{format_host_info(progname)}: #{format_message(msg)}#{@newline}"
+      "#{severity} #{format_time(timestamp)}#{format_host_info(progname)}: #{format_message(msg)}\n"
     end
 
     if !defined?(Rails::Railtie) || Rails.env.development?
@@ -49,20 +25,5 @@ module LogjamAgent
       end
     end
 
-    def render_attributes
-      attributes.map{|key, value| " #{key}[#{value}]"}.join
-    end
-
-    def set_attribute(name, value)
-      if attribute = attributes.detect{|n,v| n == name}
-        attribute[1] = value
-      else
-        attributes << [name, value]
-      end
-    end
-
-    def reset_attributes
-      self.attributes = []
-    end
   end
 end

data/lib/logjam_agent/version.rb

@@ -1,3 +1,3 @@
 module LogjamAgent
-  VERSION = "0.33.3"
+  VERSION = "0.34.0"
 end

data/lib/logjam_agent.rb

@@ -2,6 +2,12 @@ require "socket"
 require "time_bandits"
 require "logjam_agent/monkey_patches/ffi-rzmq-patch"
 
+# monkey patch log levels to include NONE
+require "logger"
+module Logger::Severity
+  NONE = UNKNOWN + 1
+end
+
 module LogjamAgent
   module RequestHandling
     def request
@@ -35,16 +41,10 @@ require "logjam_agent/zmq_forwarder"
 require "logjam_agent/forwarders"
 require "logjam_agent/request"
 require "logjam_agent/buffered_logger"
+require "logjam_agent/logging_attributes"
 require "logjam_agent/syslog_like_formatter"
-
 require "logjam_agent/railtie" if defined?(Rails::Railtie)
 
-# monkey patch log levels to include NONE
-require 'logger'
-module Logger::Severity
-  NONE = UNKNOWN + 1
-end
-
 module LogjamAgent
 
   class ForwardingError < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logjam_agent
 version: !ruby/object:Gem::Version
-  version: 0.33.3
+  version: 0.34.0
 platform: ruby
 authors:
 - Stefan Kaes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-29 00:00:00.000000000 Z
+date: 2022-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -235,6 +235,7 @@ files:
 - lib/logjam_agent/active_support/parameter_filter.rb
 - lib/logjam_agent/buffered_logger.rb
 - lib/logjam_agent/forwarders.rb
+- lib/logjam_agent/logging_attributes.rb
 - lib/logjam_agent/middleware.rb
 - lib/logjam_agent/monkey_patches/ffi-rzmq-patch.rb
 - lib/logjam_agent/rack/logger.rb
@@ -275,16 +276,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.15
+rubygems_version: 3.3.19
 signing_key:
 specification_version: 4
 summary: Logjam client library to be used with logjam
 test_files:
-- test/request_test.rb
 - test/sinatra_app.rb
-- test/sinatra_classic_app.rb
 - test/sinatra_classic_test.rb
-- test/sinatra_test.rb
-- test/test_helper.rb
-- test/util_test.rb
+- test/sinatra_classic_app.rb
+- test/request_test.rb
 - test/zmq_forwarder_test.rb
+- test/util_test.rb
+- test/test_helper.rb
+- test/sinatra_test.rb