promenade 0.12.16 → 0.12.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87287b915d3e36771dab61be77a886365aed764ccdc59cf9284cf68151949878
-  data.tar.gz: b3c9fb42a27dba864fb22df20f09f5b46fe464fac39c9c45be59b8d94dff9131
+  metadata.gz: fb19b2faa9d9feb142950fd6993cf4f5029c7350ea0b7eff7999cc6abe8a3b6f
+  data.tar.gz: fc43cb15080915fb2a220c84d702f72977ce54e74c2122a9b8448bc0c8672ae8
 SHA512:
-  metadata.gz: e91a1d858ebf5edf65d110872d3b7ddea7d45aea642da783d99d2f05a7fa6813054b7e1274d6c53ab914cd369fe7c2326b5e1d1f86c98916086d4e66d3caa422
-  data.tar.gz: e8b74e8ed11e4fdf6b2586dfb69f8c1fb31bb3f168d559ce5bd3302a8a0e49a0abf0485f67c834eb0ee5a3a7ba873091fefdbf710b87cf0277c1bb85f2038b87
+  metadata.gz: 17d70f9a1e536b7785e253b0384dc9e0568f13d153a9e0183d58c7e35e9760b391dad9d364638a73298e6b24b567683830a694f2d72d9b61add77a0a0992f865
+  data.tar.gz: 334906934de06f85123301f8e6add30f9580186ae5d41440f70913af0de9a9ea38d5355dd74984aa37595ecd83975837f297e6796d91577696e63ff9bdbbb2af

data/lib/promenade/client/rack/http_request_queue_time_collector.rb

@@ -14,35 +14,24 @@ module Promenade
         def initialize(app,
                        registry: ::Prometheus::Client.registry,
                        label_builder: RequestLabeler)
-          @queue_time_buckets = Promenade.configuration.queue_time_buckets
-
           super
         end
 
         private
 
-          attr_reader :queue_time_buckets
-
           def trace(env)
-            start_timestamp = Time.now.utc
-            response = yield
-            record_request_queue_time(labels: labels(env, response),
-              env: env,
-              request_received_time: start_timestamp)
-            response
+            record_request_queue_time(env:)
+            yield
           end
 
-          def record_request_queue_time(labels:, env:, request_received_time:)
-            request_queue_duration = QueueTimeDuration.new(env:,
-              request_received_time:)
-            return unless request_queue_duration.valid_header_present?
-
-            queue_time_histogram.observe(labels, request_queue_duration.queue_time_seconds)
+          def record_request_queue_time(env:)
+            queue_time_seconds = QueueTimeDuration.new(env:).queue_time_seconds
+            queue_time_seconds && queue_time_histogram.observe(label_builder.call(env), queue_time_seconds)
           end
 
           def register_metrics!
             registry.histogram(REQUEST_QUEUE_TIME_HISTOGRAM_NAME,
-              "A histogram of request queue time", {}, queue_time_buckets)
+              "A histogram of request queue time", {}, Promenade.configuration.queue_time_buckets)
           end
 
           def queue_time_histogram

data/lib/promenade/client/rack/queue_time_duration.rb

@@ -3,40 +3,36 @@ module Promenade
     module Rack
       class QueueTimeDuration
         REQUEST_START_HEADER = "HTTP_X_REQUEST_START".freeze
-
         QUEUE_START_HEADER = "HTTP_X_QUEUE_START".freeze
 
         HEADER_VALUE_MATCHER = /^(?:t=)(?<timestamp>\d{10}(?:\.\d+))$/
 
-        def initialize(env:, request_received_time:)
-          @env = env
-          @request_queued_time_ms = extract_request_queued_time_from_env(env)
-          @valid_header_present = @request_queued_time_ms.is_a?(Float)
-          @request_received_time_ms = request_received_time.utc.to_f
-
+        def initialize(env:, request_received_time: Time.now.utc)
+          @request_enqueued_time = request_enqueued_time_from(env)
+          @request_received_time = request_received_time.utc.to_f
           freeze
         end
 
-        def valid_header_present?
-          @valid_header_present
-        end
-
         def queue_time_seconds
-          return unless valid_header_present?
+          # Enqueued time could not be parsed from headers
+          return unless request_enqueued_time
+
+          # A negative queue time is not valid
+          return if queue_time < 0
 
           queue_time.round(3)
         end
 
         private
 
-          attr_reader :env, :request_queued_time_ms, :request_received_time_ms
+          attr_reader :request_enqueued_time, :request_received_time
 
           def queue_time
-            request_received_time_ms - request_queued_time_ms
+            request_received_time - request_enqueued_time
           end
 
-          def extract_request_queued_time_from_env(env_hash)
-            header_value = env_hash[REQUEST_START_HEADER] || env_hash[QUEUE_START_HEADER]
+          def request_enqueued_time_from(env)
+            header_value = env.values_at(REQUEST_START_HEADER, QUEUE_START_HEADER).compact.first
             return if header_value.nil?
 
             header_time_match = header_value.to_s.match(HEADER_VALUE_MATCHER)

data/lib/promenade/client/rack/request_controller_action_labeler.rb

@@ -15,11 +15,14 @@ module Promenade
 
         SEPARATOR = "#".freeze
 
-        private_constant :PARAMS_KEY, :CONTROLLER, :ACTION, :UNKNOWN, :SEPARATOR
+        REQUEST_METHOD = "REQUEST_METHOD".freeze
+
+        private_constant :PARAMS_KEY, :CONTROLLER, :ACTION, :UNKNOWN, :SEPARATOR, :REQUEST_METHOD
 
         def call(env)
           super.merge({
             controller_action: controller_action_from_env(env),
+            method: env[REQUEST_METHOD].to_s.downcase,
           })
         end
 

data/lib/promenade/client/rack/request_labeler.rb

@@ -5,15 +5,12 @@ module Promenade
         require_relative "singleton_caller"
         extend SingletonCaller
 
-        REQUEST_METHOD = "REQUEST_METHOD".freeze
-
         HTTP_HOST = "HTTP_HOST".freeze
 
-        private_constant :REQUEST_METHOD, :HTTP_HOST
+        private_constant :HTTP_HOST
 
         def call(env)
           {
-            method: env[REQUEST_METHOD].to_s.downcase,
             host: env[HTTP_HOST].to_s,
           }
         end

data/lib/promenade/railtie.rb

@@ -14,11 +14,6 @@ module Promenade
       Rails.application.config.middleware.insert 0,
         Promenade::Client::Rack::HTTPRequestQueueTimeCollector
 
-      if defined?(::Raindrops) && (defined?(::Pitchfork) || defined?(::Unicorn))
-        require "promenade/raindrops/middleware"
-        Rails.application.config.middleware.use Promenade::Raindrops::Middleware
-      end
-
       if defined?(::Pitchfork)
         require "promenade/pitchfork/middleware"
         Rails.application.config.middleware.use Promenade::Pitchfork::Middleware

data/lib/promenade/version.rb

@@ -1,3 +1,3 @@
 module Promenade
-  VERSION = "0.12.16".freeze
+  VERSION = "0.12.18".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: promenade
 version: !ruby/object:Gem::Version
-  version: 0.12.16
+  version: 0.12.18
 platform: ruby
 authors:
 - Ed Robinson
@@ -311,7 +311,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Promenade makes it simple to instrument Ruby apps for prometheus scraping
 test_files: []