promenade 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21a119e5d3d87a758957487577e0167dfff5f3d9bf04938b9c2b257f91d46c7c
-  data.tar.gz: 37698954cc28bdfca381663448821c190bfb5e5d4f67373780668c45e90669e5
+  metadata.gz: c8f195d39a6967000ebf64da2a2143a85c934ad0a37b7303eb91511dd1f458bf
+  data.tar.gz: '030960d747dd81a33a2feea7b6f3a3460fdc3952160b4c000900645df163d402'
 SHA512:
-  metadata.gz: 9fc56c5ea2851e9dfaeae6e56ef63795cab6e2acbd11eed8ecc0e70b9f8198186f92ca74d37afaa92bba579db826b06820fad7b78ee2dcd756aa019d8dd7967f
-  data.tar.gz: dd5269ee49251537374407c60cf9f31a00d3fcb6ffcfa7c0c0bfa9e8b76d23ca29c868d25ff5732a815e9adef193d73d4da626dd3f223f90d61ae31b640a9340
+  metadata.gz: 3cb2cd2eaf07029afd1ac8ad574be62d5b5f848734ea67f1f94a919fe9a6f548c2bcb71d761b92a30077575114a7b505eebe21f20f380af47471401c62b898f6
+  data.tar.gz: 0e94c108cd6e98d0f1280e07412e2cb9a41ef7f5a0d7f33735d785c1253424246e46c5fc49ddc0757658301f697272baa1ee882f109327442d13ffa87e6f6429

data/.github/workflows/ci.yaml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.7', '3.0', "3.1"]
+        ruby: ['2.7', '3.0', "3.1", "3.2"]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2

data/.rubocop.yml

@@ -16,3 +16,7 @@ Rails/RakeEnvironment:
   Enabled: false
 Rails/EnvironmentVariableAccess:
   Enabled: false
+RSpec/DescribedClass:
+  Enabled: false
+Gemspec/DevelopmentDependencies:
+  Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    promenade (0.5.0)
+    promenade (0.7.0)
       actionpack
       activesupport (> 6.0, < 8.0)
       prometheus-client-mmap (~> 0.16.0)
@@ -109,6 +109,7 @@ GEM
     highline (2.0.3)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
+    json (2.6.3)
     loofah (2.18.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -138,9 +139,9 @@ GEM
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     parallel (1.22.1)
-    parser (3.1.2.0)
+    parser (3.2.1.0)
       ast (~> 2.4.1)
-    prometheus-client-mmap (0.16.0)
+    prometheus-client-mmap (0.16.2)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -176,7 +177,7 @@ GEM
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.5.0)
+    regexp_parser (2.7.0)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -199,17 +200,20 @@ GEM
       rspec-mocks (~> 3.10)
       rspec-support (~> 3.10)
     rspec-support (3.11.0)
-    rubocop (1.30.1)
+    rubocop (1.46.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.18.0, < 2.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
-      parser (>= 3.1.1.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
     rubocop-performance (1.14.2)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
@@ -217,6 +221,9 @@ GEM
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.7.0, < 2.0)
+    rubocop-rspec (2.18.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)
       docile (~> 1.1)
@@ -236,7 +243,7 @@ GEM
       sync
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.4.2)
     webrick (1.7.0)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
@@ -262,6 +269,7 @@ DEPENDENCIES
   rubocop
   rubocop-performance
   rubocop-rails
+  rubocop-rspec
   simplecov
   webrick
 

data/README.md

@@ -181,6 +181,20 @@ Rails.application.config.middleware.insert_after ActionDispatch::ShowExceptions,
         exception_handler: exception_handler
 ```
 
+#### Customising the histogram buckets
+
+The default buckets cover a range of latencies from 5 ms to 10s see [Promenade::Configuration::DEFAULT_RACK_LATENCY_BUCKETS](https://github.com/errm/promenade/blob/ea7eb54c04257770a601b7e28b3e13db5d2430bb/lib/promenade/configuration.rb#L5). This is intended to capture the typical range of latencies for a web application. However, this might not be suitable for your Service-Level Agreements (SLAs), and other bucket size intervals may be required (see [histogram bins](https://en.wikipedia.org/wiki/Histogram#Number_of_bins_and_width)).
+
+If you would like to customise the histogram buckets, you can do so by configuring Promenade in an initializer:
+
+```ruby
+# config/initializers/promenade.rb
+
+Promenade.configure do |config|
+  config.rack_latency_buckets = [0.25, 0.350, 0.5, 1, 1.5, 2.5, 5, 10, 15, 19]
+end
+```
+
 ### Configuration
 
 If you are using rails it should load a railtie and configure promenade.
@@ -205,6 +219,10 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/errm/p
 
 This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+## Acknowledgements
+
+The original code for the Rack middleware collector class was copied from [Prometheus Client MMap](https://gitlab.com/gitlab-org/prometheus-client-mmap/-/blob/master/lib/prometheus/client/rack/collector.rb).
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/exe/promenade

@@ -8,7 +8,7 @@ Promenade.setup
 
 app = Rack::Builder.app do
   use Rack::Deflater
-  use ::Prometheus::Client::Rack::Exporter
+  use Prometheus::Client::Rack::Exporter
   map "/health" do
     run lambda { |_env| [200, { "Content-Type" => "text/plain" }, ["OK"]] }
   end

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

@@ -1,6 +1,6 @@
 require "action_dispatch/middleware/exception_wrapper"
 require_relative "singleton_caller"
-require_relative "request_labeler"
+require_relative "request_controller_action_labeler"
 
 module Promenade
   module Client
@@ -8,21 +8,19 @@ module Promenade
       class ExceptionHandler
         extend SingletonCaller
 
-        attr_reader :histogram_name, :requests_counter_name, :exceptions_counter_name, :registry
+        attr_reader :histogram_name, :exceptions_counter_name, :registry
 
-        def initialize(histogram_name:, requests_counter_name:, exceptions_counter_name:, registry:)
+        def initialize(histogram_name:, exceptions_counter_name:, registry:)
           @histogram_name = histogram_name
-          @requests_counter_name = requests_counter_name
           @exceptions_counter_name = exceptions_counter_name
           @registry = registry
         end
 
         def call(exception, env_hash, duration)
-          labels = RequestLabeler.call(env_hash)
+          labels = RequestControllerActionLabeler.call(env_hash)
           labels.merge!(code: status_code_for_exception(exception))
 
           histogram.observe(labels, duration.to_f)
-          requests_counter.increment(labels)
           exceptions_counter.increment(exception: exception.class.name)
 
           raise exception
@@ -34,10 +32,6 @@ module Promenade
             registry.get(histogram_name)
           end
 
-          def requests_counter
-            registry.get(requests_counter_name)
-          end
-
           def exceptions_counter
             registry.get(exceptions_counter_name)
           end

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

@@ -0,0 +1,81 @@
+require "prometheus/client"
+require_relative "middleware_base"
+require_relative "request_controller_action_labeler"
+require_relative "exception_handler"
+require_relative "queue_time_duration"
+
+module Promenade
+  module Client
+    module Rack
+      class HTTPRequestDurationCollector < MiddlwareBase
+        REQUEST_DURATION_HISTOGRAM_NAME = :http_req_duration_seconds
+
+        EXCEPTIONS_COUNTER_NAME = :http_exceptions_total
+
+        private_constant :REQUEST_DURATION_HISTOGRAM_NAME,
+          :EXCEPTIONS_COUNTER_NAME
+
+        def initialize(app,
+                       registry: ::Prometheus::Client.registry,
+                       label_builder: RequestControllerActionLabeler,
+                       exception_handler: nil)
+
+          @latency_buckets = Promenade.configuration.rack_latency_buckets
+          @_exception_handler = exception_handler
+
+          super(app, registry: registry, label_builder: label_builder)
+        end
+
+        private
+
+          attr_reader :latency_buckets, :queue_time_buckets
+
+          def trace(env)
+            start = current_time
+            begin
+              response = yield
+              record_request_duration(labels(env, response), duration_since(start))
+              response
+            rescue StandardError => e
+              exception_handler.call(e, env, duration_since(start))
+            end
+          end
+
+          def record_request_duration(labels, duration)
+            durations_histogram.observe(labels, duration)
+          end
+
+          def duration_since(start_time)
+            current_time - start_time
+          end
+
+          def current_time
+            Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          end
+
+          def durations_histogram
+            registry.get(REQUEST_DURATION_HISTOGRAM_NAME)
+          end
+
+          def register_metrics!
+            registry.histogram(REQUEST_DURATION_HISTOGRAM_NAME,
+              "A histogram of the response latency.", {}, latency_buckets)
+            registry.counter(EXCEPTIONS_COUNTER_NAME,
+              "A counter of the total number of exceptions raised.")
+          end
+
+          def exception_handler
+            @_exception_handler ||= default_exception_handler
+          end
+
+          def default_exception_handler
+            ExceptionHandler.initialize_singleton(
+              histogram_name: REQUEST_DURATION_HISTOGRAM_NAME,
+              exceptions_counter_name: EXCEPTIONS_COUNTER_NAME,
+              registry: registry,
+            )
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+require "prometheus/client"
+require_relative "middleware_base"
+require_relative "request_labeler"
+require_relative "queue_time_duration"
+
+module Promenade
+  module Client
+    module Rack
+      class HTTPRequestQueueTimeCollector < MiddlwareBase
+        REQUEST_QUEUE_TIME_HISTOGRAM_NAME = :http_req_queue_time_seconds
+
+        private_constant :REQUEST_QUEUE_TIME_HISTOGRAM_NAME
+
+        def initialize(app,
+                       registry: ::Prometheus::Client.registry,
+                       label_builder: RequestLabeler)
+
+          @queue_time_buckets = Promenade.configuration.queue_time_buckets
+
+          super(app, registry: registry, label_builder: label_builder)
+        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
+          end
+
+          def record_request_queue_time(labels:, env:, request_received_time:)
+            request_queue_duration = QueueTimeDuration.new(env: env,
+              request_received_time: request_received_time)
+            return unless request_queue_duration.valid_header_present?
+
+            queue_time_histogram.observe(labels, request_queue_duration.queue_time_seconds)
+          end
+
+          def register_metrics!
+            registry.histogram(REQUEST_QUEUE_TIME_HISTOGRAM_NAME,
+              "A histogram of request queue time", {}, queue_time_buckets)
+          end
+
+          def queue_time_histogram
+            registry.get(REQUEST_QUEUE_TIME_HISTOGRAM_NAME)
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module Promenade
+  module Client
+    module Rack
+      class MiddlwareBase
+        def initialize(app, registry:, label_builder:)
+          @app = app
+          @registry = registry
+          @label_builder = label_builder
+
+          register_metrics!
+        end
+
+        def call(env)
+          trace(env) { app.call(env) }
+        end
+
+        private
+
+          attr_reader :app, :label_builder, :registry
+
+          def trace(env)
+            raise NotImplementedError,
+              "Please define #{__method__} in #{self.class}"
+          end
+
+          def labels(env, response)
+            label_builder.call(env).merge!(code: response.first.to_s)
+          end
+
+          def register_metrics!
+            # :noop:
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+module Promenade
+  module Client
+    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+))$/.freeze
+
+        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
+
+          freeze
+        end
+
+        def valid_header_present?
+          @valid_header_present
+        end
+
+        def queue_time_seconds
+          return unless valid_header_present?
+
+          queue_time.round(3)
+        end
+
+        private
+
+          attr_reader :env, :request_queued_time_ms, :request_received_time_ms
+
+          def queue_time
+            request_received_time_ms - request_queued_time_ms
+          end
+
+          def extract_request_queued_time_from_env(env_hash)
+            header_value = env_hash[REQUEST_START_HEADER] || env_hash[QUEUE_START_HEADER]
+            return if header_value.nil?
+
+            header_time_match = header_value.to_s.match(HEADER_VALUE_MATCHER)
+            return unless header_time_match
+
+            header_time_match[:timestamp].to_f
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+require_relative "request_labeler"
+module Promenade
+  module Client
+    module Rack
+      class RequestControllerActionLabeler < RequestLabeler
+        PARAMS_KEY = "action_dispatch.request.parameters".freeze
+
+        PATH_PARAMS_KEY = "action_dispatch.request.path_parameters".freeze
+
+        CONTROLLER = "controller".freeze
+
+        ACTION = "action".freeze
+
+        UNKNOWN = "unknown".freeze
+
+        SEPARATOR = "#".freeze
+
+        private_constant :PARAMS_KEY, :CONTROLLER, :ACTION, :UNKNOWN, :SEPARATOR
+
+        def call(env)
+          super.merge({
+            controller_action: controller_action_from_env(env),
+          })
+        end
+
+        private
+
+          def controller_action_from_env(env)
+            controller = env.dig(PARAMS_KEY, CONTROLLER) ||
+                         env.dig(PATH_PARAMS_KEY, CONTROLLER.to_sym) ||
+                         UNKNOWN
+
+            action = env.dig(PARAMS_KEY, ACTION) ||
+                     env.dig(PATH_PARAMS_KEY, ACTION.to_sym) ||
+                     UNKNOWN
+
+            [controller, action].join(SEPARATOR)
+          end
+      end
+    end
+  end
+end

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

@@ -9,41 +9,14 @@ module Promenade
 
         HTTP_HOST = "HTTP_HOST".freeze
 
-        PARAMS_KEY = "action_dispatch.request.parameters".freeze
-
-        PATH_PARAMS_KEY = "action_dispatch.request.path_parameters".freeze
-
-        CONTROLLER = "controller".freeze
-
-        ACTION = "action".freeze
-
-        UNKNOWN = "unknown".freeze
-
-        SEPARATOR = "#".freeze
-
-        private_constant :REQUEST_METHOD, :HTTP_HOST, :PARAMS_KEY, :CONTROLLER, :ACTION, :UNKNOWN, :SEPARATOR
+        private_constant :REQUEST_METHOD, :HTTP_HOST
 
         def call(env)
           {
             method: env[REQUEST_METHOD].to_s.downcase,
             host: env[HTTP_HOST].to_s,
-            controller_action: controller_action_from_env(env),
           }
         end
-
-        private
-
-          def controller_action_from_env(env)
-            controller = env.dig(PARAMS_KEY, CONTROLLER) ||
-                         env.dig(PATH_PARAMS_KEY, CONTROLLER.to_sym) ||
-                         UNKNOWN
-
-            action = env.dig(PARAMS_KEY, ACTION) ||
-                     env.dig(PATH_PARAMS_KEY, ACTION.to_sym) ||
-                     UNKNOWN
-
-            [controller, action].join(SEPARATOR)
-          end
       end
     end
   end

data/lib/promenade/configuration.rb

@@ -1,11 +1,14 @@
 module Promenade
   class Configuration
-    attr_accessor :rack_latency_buckets
+    attr_accessor :queue_time_buckets, :rack_latency_buckets
 
     DEFAULT_RACK_LATENCY_BUCKETS = [0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10].freeze
 
+    DEFAULT_QUEUE_TIME_BUCKETS = [0.01, 0.5, 1.0, 10.0, 30.0].freeze
+
     def initialize
       @rack_latency_buckets = DEFAULT_RACK_LATENCY_BUCKETS
+      @queue_time_buckets = DEFAULT_QUEUE_TIME_BUCKETS
     end
   end
 end

data/lib/promenade/railtie.rb

@@ -1,13 +1,16 @@
 require "promenade/setup"
 require "promenade/engine"
-require "promenade/client/rack/collector"
+require "promenade/client/rack/http_request_duration_collector"
+require "promenade/client/rack/http_request_queue_time_collector"
 
 module Promenade
   class Railtie < ::Rails::Railtie
     initializer "promenade.configure_rails_initialization" do
       Promenade.setup
       Rails.application.config.middleware.insert_after ActionDispatch::ShowExceptions,
-        Promenade::Client::Rack::Collector
+        Promenade::Client::Rack::HTTPRequestDurationCollector
+      Rails.application.config.middleware.insert 0,
+        Promenade::Client::Rack::HTTPRequestQueueTimeCollector
     end
   end
 end

data/lib/promenade/version.rb

@@ -1,3 +1,3 @@
 module Promenade
-  VERSION = "0.5.0".freeze
+  VERSION = "0.7.0".freeze
 end

data/lib/promenade.rb

@@ -1,7 +1,7 @@
 require "promenade/version"
 require "promenade/setup"
 require "promenade/configuration"
-require "promenade/railtie" if defined? ::Rails::Railtie
+require "promenade/railtie" if defined? Rails::Railtie
 require "promenade/prometheus"
 
 module Promenade

data/promenade.gemspec

@@ -2,7 +2,7 @@ lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "promenade/version"
 
-Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
   spec.name          = "promenade"
   spec.version       = Promenade::VERSION
   spec.authors       = ["Ed Robinson"]
@@ -22,7 +22,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.7", "< 3.2"
+  spec.required_ruby_version = ">= 2.7"
 
   spec.add_dependency "actionpack"
   spec.add_dependency "activesupport", "> 6.0", "< 8.0"
@@ -39,6 +39,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "rubocop-performance"
   spec.add_development_dependency "rubocop-rails"
+  spec.add_development_dependency "rubocop-rspec"
   spec.add_development_dependency "simplecov"
   spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: promenade
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ed Robinson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-23 00:00:00.000000000 Z
+date: 2023-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -232,6 +232,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -271,8 +285,12 @@ files:
 - bin/setup
 - exe/promenade
 - lib/promenade.rb
-- lib/promenade/client/rack/collector.rb
 - lib/promenade/client/rack/exception_handler.rb
+- lib/promenade/client/rack/http_request_duration_collector.rb
+- lib/promenade/client/rack/http_request_queue_time_collector.rb
+- lib/promenade/client/rack/middleware_base.rb
+- lib/promenade/client/rack/queue_time_duration.rb
+- lib/promenade/client/rack/request_controller_action_labeler.rb
 - lib/promenade/client/rack/request_labeler.rb
 - lib/promenade/client/rack/singleton_caller.rb
 - lib/promenade/configuration.rb
@@ -303,16 +321,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '2.7'
-  - - "<"
-    - !ruby/object:Gem::Version
-      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Promenade makes it simple to instrument Ruby apps for prometheus scraping

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

@@ -1,113 +0,0 @@
-require "prometheus/client"
-require_relative "request_labeler"
-require_relative "exception_handler"
-
-module Promenade
-  module Client
-    module Rack
-      # Original code taken from Prometheus Client MMap
-      # https://gitlab.com/gitlab-org/prometheus-client-mmap/-/blob/master/lib/prometheus/client/rack/collector.rb
-      #
-      # Collector is a Rack middleware that provides a sample implementation of
-      # a HTTP tracer. The default label builder can be modified to export a
-      # different set of labels per recorded metric.
-      class Collector
-        REQUEST_METHOD = "REQUEST_METHOD".freeze
-
-        HTTP_HOST = "HTTP_HOST".freeze
-
-        PATH_INFO = "PATH_INFO".freeze
-
-        HISTOGRAM_NAME = :http_req_duration_seconds
-
-        REQUESTS_COUNTER_NAME = :http_requests_total
-
-        EXCEPTIONS_COUNTER_NAME = :http_exceptions_total
-
-        private_constant *%i(
-          REQUEST_METHOD
-          HTTP_HOST
-          PATH_INFO
-          HISTOGRAM_NAME
-          REQUESTS_COUNTER_NAME
-          EXCEPTIONS_COUNTER_NAME
-        )
-
-        def initialize(app,
-                       registry: ::Prometheus::Client.registry,
-                       label_builder: RequestLabeler,
-                       exception_handler: nil)
-          @app = app
-          @registry = registry
-          @label_builder = label_builder
-          @latency_buckets = Promenade.configuration.rack_latency_buckets
-          @exception_handler = exception_handler || default_exception_handler
-          register_metrics!
-        end
-
-        def call(env)
-          trace(env) { app.call(env) }
-        end
-
-        private
-
-          attr_reader :app,
-            :registry,
-            :label_builder,
-            :latency_buckets,
-            :exception_handler
-
-          def trace(env)
-            start = current_time
-            begin
-              response = yield
-              record(labels(env, response), duration_since(start))
-              response
-            rescue StandardError => e
-              exception_handler.call(e, env, duration_since(start))
-            end
-          end
-
-          def labels(env, response)
-            label_builder.call(env).merge!(code: response.first.to_s)
-          end
-
-          def record(labels, duration)
-            requests_counter.increment(labels)
-            durations_histogram.observe(labels, duration)
-          end
-
-          def duration_since(start_time)
-            current_time - start_time
-          end
-
-          def current_time
-            Process.clock_gettime(Process::CLOCK_MONOTONIC)
-          end
-
-          def durations_histogram
-            registry.get(HISTOGRAM_NAME)
-          end
-
-          def requests_counter
-            registry.get(REQUESTS_COUNTER_NAME)
-          end
-
-          def register_metrics!
-            registry.counter(REQUESTS_COUNTER_NAME, "A counter of the total number of HTTP requests made.")
-            registry.histogram(HISTOGRAM_NAME, "A histogram of the response latency.", {}, latency_buckets)
-            registry.counter(EXCEPTIONS_COUNTER_NAME, "A counter of the total number of exceptions raised.")
-          end
-
-          def default_exception_handler
-            ExceptionHandler.initialize_singleton(
-              histogram_name: HISTOGRAM_NAME,
-              requests_counter_name: REQUESTS_COUNTER_NAME,
-              exceptions_counter_name: EXCEPTIONS_COUNTER_NAME,
-              registry: registry,
-            )
-          end
-      end
-    end
-  end
-end