logjam_agent 0.32.4 → 0.33.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 882e0807f2b78aa878d7af652e4cb3ab6d0a77115e2add1792fc85091c629d15
-  data.tar.gz: 0500627f55dd0c1e10013db3e2cdba1c23f15b587d3ceb440fe2bd0921cd3a2e
+  metadata.gz: f7a947089e6779f029fce195520f09439948a72164dd4ee53671e129631406a9
+  data.tar.gz: 21daffea283fec4e44bd3d9fac3d6a47ea14c35ee1bf8b982e7a2c2c3fbd1341
 SHA512:
-  metadata.gz: f37a0ce94d7a2cc233eb5ff2c9a84c39b2396b1c99a0349df185bae8716e46b24caf8e6d341bca6ed503914721b59142ee7db2221ada9d3c7a544c86648b80f8
-  data.tar.gz: d8c839977ec58a66e87381ca1cb76877988eacde9eaf59f7d4b2d102848c11c84ddc370c14bb1b0c559c1dab8e9a718de82a24d68982c61b94a49a69acd86fda
+  metadata.gz: 40973d3ac9de2bf532f94b4b4aa1f5ede0aa166b9bd5182291cf21063908b06b37e281042497ff9961a8342f2d589148f685f25a8a78a516e9662fb0e2bae982
+  data.tar.gz: 8fb0c2d199b12967e4d9e099f73e651ff5273c433ea992495963da1a5379f01e93471239b2dc4e22c165536a0abf71e13a747a28f9118a4e1f12cd723cecf0f7

data/README.md

@@ -10,7 +10,8 @@ Has experimental support for Sinatra.
 Currently only one mechanism is available for data transport:
 ZeroMQ. Support for AMQP has been dropped.
 
-[![Travis](https://travis-ci.org/skaes/logjam_agent.svg?branch=master)](https://travis-ci.org/github/skaes/logjam_agent)
+
+![Build](https://github.com/skaes/logjam_agent/actions/workflows/run-tests.yml/badge.svg)
 
 
 ## Usage

data/lib/logjam_agent/middleware.rb

@@ -50,9 +50,11 @@ module LogjamAgent
       env_name      = env["logjam_agent.environment_name"] || LogjamAgent.environment_name
       caller_id     = env["HTTP_X_LOGJAM_CALLER_ID"] || ""
       caller_action = env["HTTP_X_LOGJAM_ACTION"] || ""
+      trace_id      = env["HTTP_X_LOGJAM_TRACE_ID"] || ""
       extra_fields = {}
       extra_fields[:caller_id] = caller_id if caller_id.present?
       extra_fields[:caller_action] = caller_action if caller_action.present?
+      extra_fields[:trace_id] = trace_id if trace_id.present?
       LogjamAgent.start_request(app_name, env_name, extra_fields)
     end
 

data/lib/logjam_agent/rack/logger.rb

@@ -32,23 +32,16 @@ module LogjamAgent
 
       def call_app(request, env)
         start_time = Time.now
-        start_time_header = env['HTTP_X_STARTTIME']
-        if start_time_header
-          if start_time_header =~ /\At=(\d+)\z/
-            # HTTP_X_STARTTIME is microseconds since the epoch (UTC)
-            http_start_time = Time.at($1.to_f / 1_000_000.0)
-          elsif start_time_header =~ /\Ats=(\d+)(?:\.(\d+))?\z/
-            # HTTP_X_STARTTIME is seconds since the epoch (UTC) with a milliseconds resolution
-            http_start_time = Time.at($1.to_f + $2.to_f / 1000)
-          end
-
-          if http_start_time && (wait_time_ms = (start_time - http_start_time) * 1000) > 0
+        wait_time_ms = 0.0
+        if http_start_time = extract_http_start_time(env)
+          wait_time_ms = (start_time - http_start_time) * 1000
+          if wait_time_ms > 0
             start_time = http_start_time
+          else
+            wait_time_ms = 0.0
           end
-        else
-          wait_time_ms = 0.0
         end
-        before_dispatch(request, env, start_time)
+        before_dispatch(request, env, start_time, wait_time_ms)
         result = @app.call(env)
       rescue ActionDispatch::RemoteIp::IpSpoofAttackError
         result = [403, {}, ['Forbidden']]
@@ -57,6 +50,20 @@ module LogjamAgent
         after_dispatch(env, result, run_time_ms, wait_time_ms)
       end
 
+      def extract_http_start_time(env)
+        start_time_header = env['HTTP_X_STARTTIME']
+        if start_time_header
+          if start_time_header =~ /\At=(\d+)\z/
+            # HTTP_X_STARTTIME is microseconds since the epoch (UTC)
+            return Time.at($1.to_f / 1_000_000.0)
+          elsif start_time_header =~ /\Ats=(\d+)(?:\.(\d+))?\z/
+            # HTTP_X_STARTTIME is seconds since the epoch (UTC) with a milliseconds resolution
+            return Time.at($1.to_f + $2.to_f / 1000)
+          end
+        end
+        return nil
+      end
+
       def compute_tags(request)
         @taggers.collect do |tag|
           case tag
@@ -78,7 +85,7 @@ module LogjamAgent
         false
       end
 
-      def before_dispatch(request, env, start_time)
+      def before_dispatch(request, env, start_time, wait_time_ms)
         logger.formatter.reset_attributes if logger.formatter.respond_to?(:reset_attributes)
         TimeBandits.reset
         Thread.current.thread_variable_set(:time_bandits_completed_info, nil)
@@ -90,6 +97,7 @@ module LogjamAgent
 
         logjam_request.start_time = start_time
         logjam_fields = logjam_request.fields
+        logjam_fields[:wait_time] = wait_time_ms if wait_time_ms > 0.0
         spoofed = nil
         ip = nil
         begin
@@ -125,7 +133,6 @@ module LogjamAgent
 
         if wait_time_ms < 0
           warn LogjamAgent::NegativeWaitTime.new("#{wait_time_ms} ms")
-          wait_time_ms = 0.0
         end
 
         message = "Completed #{status} #{::Rack::Utils::HTTP_STATUS_CODES[status]} in %.1fms" % run_time_ms
@@ -135,7 +142,6 @@ module LogjamAgent
         ActiveSupport::LogSubscriber.flush_all!
         request_info = { :total_time => run_time_ms, :code => status }
         request_info[:view_time] = view_time if view_time
-        request_info[:wait_time] = wait_time_ms if wait_time_ms > 0
         logjam_request.fields.merge!(request_info)
 
         env["time_bandits.metrics"] = TimeBandits.metrics

data/lib/logjam_agent/request.rb

@@ -17,6 +17,7 @@ module LogjamAgent
       @uuid = LogjamAgent.generate_uuid
       @fields = initial_fields.merge(:request_id => @uuid, :host => LogjamAgent.hostname,
                                      :process_id => Process.pid, :lines => @lines)
+      @fields[:trace_id] ||= @uuid
       unless (revision = LogjamAgent.application_revision).blank?
         @fields[:revision] = revision
       end
@@ -70,6 +71,10 @@ module LogjamAgent
       @fields[:caller_action]
     end
 
+    def trace_id
+      @fields[:trace_id]
+    end
+
     def add_line(severity, timestamp, message)
       @mutex.synchronize do
         if @bytes_all_lines > @max_bytes_all_lines

data/lib/logjam_agent/version.rb

@@ -1,3 +1,3 @@
 module LogjamAgent
-  VERSION = "0.32.4"
+  VERSION = "0.33.2"
 end

data/lib/logjam_agent/zmq_forwarder.rb

@@ -45,7 +45,8 @@ module LogjamAgent
           begin
             require 'ffi-rzmq'
             context = ZMQ::Context.new(1)
-            at_exit { context.terminate }
+            pid = Process.pid
+            at_exit { context.terminate if Process.pid == pid }
             context
           end
       end
@@ -59,7 +60,8 @@ module LogjamAgent
 
     def ensure_ping_at_exit
       return if @ping_ensured
-      at_exit { ping; reset }
+      pid = Process.pid
+      at_exit { (ping; reset) if Process.pid == pid }
       @ping_ensured = true
     end
 
@@ -99,7 +101,8 @@ module LogjamAgent
       if LogjamAgent.ensure_ping_at_exit
         ensure_ping_at_exit
       else
-        at_exit { reset }
+        pid = Process.pid
+        at_exit { reset if Process.pid == pid}
       end
       @socket.setsockopt(ZMQ::LINGER, @config[:linger])
       @socket.setsockopt(ZMQ::SNDHWM, @config[:snd_hwm])

data/test/request_test.rb

@@ -44,6 +44,16 @@ module LogjamAgent
       assert_equal TRUNCATED_LINE, lines(@request)[1][2]
     end
 
+    def test_sets_trace_id_to_request_id_if_not_passed_in
+      assert_equal @request.uuid, @request.fields[:trace_id]
+    end
+
+    def test_sets_trace_id_to_passed_in_field_value
+      trace_id = "murks"
+      request = Request.new("app", "env", {trace_id: trace_id})
+      assert_equal trace_id, request.fields[:trace_id]
+    end
+
     private
 
     def lines(request)

data/test/sinatra_test.rb

@@ -37,6 +37,7 @@ module LogjamAgent
       assert_kind_of String, payload["started_at"]
       assert_kind_of Integer, payload["started_ms"]
       assert_kind_of String, payload["ip"]
+      assert_nil payload["wait_time"]
       # assert_kind_of Float, payload["view_time"]
       lines = payload["lines"]
       assert_match(/Started GET.*password=\[FILTERED\]/, lines[0][2])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logjam_agent
 version: !ruby/object:Gem::Version
-  version: 0.32.4
+  version: 0.33.2
 platform: ruby
 authors:
 - Stefan Kaes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2022-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -275,16 +275,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.7
+rubygems_version: 3.3.15
 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_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_classic_test.rb
 - test/sinatra_test.rb
+- test/test_helper.rb
+- test/util_test.rb
+- test/zmq_forwarder_test.rb