promenade 0.2.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b4b2246b9bdf2b31727cfb898cf680facfe1bfcd9a6c3393eb7237c4c2ef870
-  data.tar.gz: 64f386aa492f3f953cb80d8de3067e4d2565de9e0d3d9379888596f2d88cd283
+  metadata.gz: 235f95d0b77870a9975ff9870428ed5a995b9174380b981c2df7d8a338519ffb
+  data.tar.gz: 7d6e327e2d602fd2b07342fb45c9be29e36ad266212ad4ed98a72eafee58bc9e
 SHA512:
-  metadata.gz: 7a7e963d14200c730bfbc8d609ff8571dffae97f136ec5ecf3e567877795d1d8e300c8c9256b905263eb73f422e35b46cf6cae211cbab9edf89675ade9ab1f57
-  data.tar.gz: d2387375708b46e7f9823ba481419cf1f46b0656ce4f3e42485b420635383aaec7953185bdf714f7a4c7ecb4b38edd0a22bd1ca232705876d087a8df05668971
+  metadata.gz: e8596f53e3110b636696cb38f2d3bfa872715de3e331fdf260da62e30c31949a1753702b935c3343545c7be19da56f0e30a65d89568eefd419b94a5ef80fe2f9
+  data.tar.gz: 7e65f494c50b2bc25b05b169794f73c02c64ad1548c3425399b1d2cb4e7077d930e0e7d9c99ea88088c76e1026bb64cfbda246ab1a6b09c057b4f2b717b130d8

data/.github/workflows/ci.yaml

@@ -2,14 +2,14 @@ name: CI
 on:
   push:
     branches:
-      -master
+      - master
   pull_request:
 jobs:
   test:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.6', '2.7', '3.0']
+        ruby: ['2.7', '3.0', "3.1"]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2

data/.gitignore

@@ -1,14 +1,16 @@
+.rspec_status
+.byebug_history
+.rubocop-https*yml
 /.bundle/
-/.yardoc
-/_yardoc/
 /coverage/
 /doc/
+/log/
 /pkg/
+/.sass-cache/
 /spec/reports/
+/spec/dummy/log
+/spec/dummy/tmp
 /tmp/
-.rubocop-https*yml
-.sass-cache/
-vendor
-
-# rspec failure tracking
-.rspec_status
+/vendor/
+/.yardoc
+/_yardoc/

data/.rubocop.yml

@@ -2,7 +2,7 @@ inherit_from:
   - https://raw.githubusercontent.com/cookpad/guides/master/.rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
   NewCops: enable
   Exclude:
     - vendor/**/*

data/Gemfile.lock

@@ -1,29 +1,92 @@
 PATH
   remote: .
   specs:
-    promenade (0.2.2)
-      activesupport
-      prometheus-client-mmap (~> 0.12.0)
+    promenade (0.6.0)
+      actionpack
+      activesupport (> 6.0, < 8.0)
+      prometheus-client-mmap (~> 0.16.0)
       rack
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.2)
+    actioncable (7.0.3)
+      actionpack (= 7.0.3)
+      activesupport (= 7.0.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.3)
+      actionpack (= 7.0.3)
+      activejob (= 7.0.3)
+      activerecord (= 7.0.3)
+      activestorage (= 7.0.3)
+      activesupport (= 7.0.3)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.3)
+      actionpack (= 7.0.3)
+      actionview (= 7.0.3)
+      activejob (= 7.0.3)
+      activesupport (= 7.0.3)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.3)
+      actionview (= 7.0.3)
+      activesupport (= 7.0.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.3)
+      actionpack (= 7.0.3)
+      activerecord (= 7.0.3)
+      activestorage (= 7.0.3)
+      activesupport (= 7.0.3)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.3)
+      activesupport (= 7.0.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.3)
+      activesupport (= 7.0.3)
+      globalid (>= 0.3.6)
+    activemodel (7.0.3)
+      activesupport (= 7.0.3)
+    activerecord (7.0.3)
+      activemodel (= 7.0.3)
+      activesupport (= 7.0.3)
+    activestorage (7.0.3)
+      actionpack (= 7.0.3)
+      activejob (= 7.0.3)
+      activerecord (= 7.0.3)
+      activesupport (= 7.0.3)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     ast (2.4.2)
-    backports (3.21.0)
+    backports (3.23.0)
     binding_of_caller (1.0.0)
       debug_inspector (>= 0.0.1)
-    climate_control (1.0.0)
-    codecov (0.5.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    climate_control (1.1.1)
+    codecov (0.6.0)
       simplecov (>= 0.15, < 0.22)
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
     debug_inspector (1.1.0)
     deep-cover (1.1.0)
       deep-cover-core (= 1.1.0)
@@ -37,53 +100,120 @@ GEM
       pry
       term-ansicolor
       terminal-table
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
+    digest (3.1.0)
     docile (1.4.0)
+    erubi (1.10.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
     highline (2.0.3)
-    i18n (1.8.10)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
+    loofah (2.18.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
     method_source (1.0.0)
-    minitest (5.14.4)
-    parallel (1.20.1)
-    parser (3.0.1.1)
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.0)
+    minitest (5.16.0)
+    net-imap (0.2.3)
+      digest
+      net-protocol
+      strscan
+    net-pop (0.1.1)
+      digest
+      net-protocol
+      timeout
+    net-protocol (0.1.3)
+      timeout
+    net-smtp (0.3.1)
+      digest
+      net-protocol
+      timeout
+    nio4r (2.5.8)
+    nokogiri (1.13.6)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    prometheus-client-mmap (0.12.0)
+    prometheus-client-mmap (0.16.2)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rack (2.2.3)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
+    racc (1.6.0)
+    rack (2.2.3.1)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (7.0.3)
+      actioncable (= 7.0.3)
+      actionmailbox (= 7.0.3)
+      actionmailer (= 7.0.3)
+      actionpack (= 7.0.3)
+      actiontext (= 7.0.3)
+      actionview (= 7.0.3)
+      activejob (= 7.0.3)
+      activemodel (= 7.0.3)
+      activerecord (= 7.0.3)
+      activestorage (= 7.0.3)
+      activesupport (= 7.0.3)
+      bundler (>= 1.15.0)
+      railties (= 7.0.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    railties (7.0.3)
+      actionpack (= 7.0.3)
+      activesupport (= 7.0.3)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.15.0)
+      rspec-support (~> 3.11.0)
+    rspec-rails (5.1.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.11.0)
+    rubocop (1.30.1)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.5.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.5.0)
-      parser (>= 3.0.1.1)
-    rubocop-performance (1.11.3)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.2)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.10.1)
+    rubocop-rails (2.15.0)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.7.0, < 2.0)
@@ -93,34 +223,42 @@ GEM
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
+    simplecov_json_formatter (0.1.4)
+    strscan (3.0.3)
     sync (0.5.0)
     term-ansicolor (1.7.1)
       tins (~> 1.0)
-    terminal-table (3.0.1)
+    terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    thor (1.1.0)
-    tins (1.29.1)
+    thor (1.2.1)
+    timeout (0.3.0)
+    tins (1.31.1)
       sync
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
     webrick (1.7.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
     with_progress (1.0.1)
       ruby-progressbar (~> 1.4)
-    zeitwerk (2.4.2)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 2.0)
+  byebug
   climate_control
   codecov
   deep-cover
   promenade!
-  rake (~> 13.0)
-  rspec (~> 3.0)
+  rails (> 3.0, < 8.0)
+  rake
+  rspec (~> 3.11)
+  rspec-rails (~> 5.1)
   rubocop
   rubocop-performance
   rubocop-rails
@@ -128,4 +266,4 @@ DEPENDENCIES
   webrick
 
 BUNDLED WITH
-   2.1.4
+   2.3.16

data/README.md

@@ -129,6 +129,72 @@ This is ideal if you are worried about accidentally exposing your metrics, are c
 
 The exporter runs by default on port `9394` and the metrics are available at the standard path of `/metrics`, the stand-alone exporter is configured to use gzip.
 
+
+### Rails Middleware
+
+Promenade provides custom Rack middleware to track HTTP response times for requests in your Rails application.
+
+This was originally inspired by [prometheus-client-mmap](https://gitlab.com/gitlab-org/prometheus-client-mmap/-/blob/master/lib/prometheus/client/rack/collector.rb).
+
+**This middleware is automatically added to your Rack stack if your application is a Ruby on Rails app.**
+
+We recommend you add the middleware after `ActionDispatch::ShowExceptions` in your stack, so you can accurately record the controller and action where an exception was raised.
+
+If you want to change the position, or customise the labels and exception handling behaviour, simply remove the middleware from the stack and re-insert it with your own preferences.
+
+``` ruby
+Rails.application.middleware.delete(Promenade::Client::Rack::Collector)
+Rails.application.middleware.insert_after(Rails::Rack::Logger, Promenade::Client::Rack::Collector)
+```
+
+#### Customising the labels recorded for each request
+
+If you would like to collect different labels with each request, you may do so by customising the middleware installation:
+
+``` ruby
+label_builder = Proc.new do |env|
+  {
+    method: env["REQUEST_METHOD"].to_s.downcase,
+    host: env["HTTP_HOST"].to_s,
+    controller: env.dig("action_dispatch.request.parameters", "controller") || "unknown",
+    action: env.dig("action_dispatch.request.parameters", "action") || "unknown"
+  }
+end
+Rails.application.config.middleware.insert_after ActionDispatch::ShowExceptions,
+        Promenade::Client::Rack::Collector
+        label_builder: label_builder
+```
+
+#### Customising how the middleware handles exceptions
+
+The default implementation will capture exceptions, count the execption class name (e.g. `"StandardError"`), and then re-raise the exception.
+
+If you would like to customise this behaviour, you may do so by customising the middleware installation:
+
+``` ruby
+exception_handler = Proc.new do |exception, exception_counter, env_hash, request_duration_seconds|
+  # This simple example just re-raises the execption
+  raise exception
+end
+Rails.application.config.middleware.insert_after ActionDispatch::ShowExceptions,
+        Promenade::Client::Rack::Collector
+        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.
@@ -153,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/bin/integration_test

@@ -4,14 +4,23 @@ require "bundler/setup"
 require "promenade"
 require "fileutils"
 require "net/http"
+require "./spec/support/integration_tests/metrics_line"
+require "./spec/support/integration_tests/label_value"
 
 def test_http_body(expected)
+  expectation = MetricsLine.new(expected)
   uri = URI("http://localhost:9394/metrics")
 
   Net::HTTP.start(uri.host, uri.port) do |http|
     request = Net::HTTP::Get.new uri
     response = http.request request
-    fail "#{response.body} didn't include #{expected}" unless response.body.split("\n").any?(expected)
+    unless response.body.each_line.detect do |string|
+      next if string.start_with?("#")
+
+      MetricsLine.new(string) == expectation
+    end
+      fail "#{response.body} didn't include #{expected}"
+    end
   end
 end
 

data/bin/rails

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path("..", __dir__)
+ENGINE_PATH = File.expand_path("../lib/promenade/engine", __dir__)
+APP_PATH = File.expand_path("../spec/dummy/config/application", __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails/all"
+require "rails/engine/commands"

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

@@ -0,0 +1,51 @@
+require "action_dispatch/middleware/exception_wrapper"
+require_relative "singleton_caller"
+require_relative "request_labeler"
+
+module Promenade
+  module Client
+    module Rack
+      class ExceptionHandler
+        extend SingletonCaller
+
+        attr_reader :histogram_name, :requests_counter_name, :exceptions_counter_name, :registry
+
+        def initialize(histogram_name:, requests_counter_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.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
+        end
+
+        private
+
+          def histogram
+            registry.get(histogram_name)
+          end
+
+          def requests_counter
+            registry.get(requests_counter_name)
+          end
+
+          def exceptions_counter
+            registry.get(exceptions_counter_name)
+          end
+
+          def status_code_for_exception(exception)
+            ActionDispatch::ExceptionWrapper.new(nil, exception).status_code.to_s
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+require "prometheus/client"
+require_relative "middleware_base"
+require_relative "request_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
+
+        REQUESTS_COUNTER_NAME = :http_requests_total
+
+        EXCEPTIONS_COUNTER_NAME = :http_exceptions_total
+
+        private_constant :REQUEST_DURATION_HISTOGRAM_NAME,
+          :REQUESTS_COUNTER_NAME,
+          :EXCEPTIONS_COUNTER_NAME
+
+        def initialize(app,
+                       registry: ::Prometheus::Client.registry,
+                       label_builder: RequestLabeler,
+                       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)
+            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(REQUEST_DURATION_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(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,
+              requests_counter_name: REQUESTS_COUNTER_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_labeler.rb

@@ -0,0 +1,50 @@
+module Promenade
+  module Client
+    module Rack
+      class RequestLabeler
+        require_relative "singleton_caller"
+        extend SingletonCaller
+
+        REQUEST_METHOD = "REQUEST_METHOD".freeze
+
+        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
+
+        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
+end

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

@@ -0,0 +1,19 @@
+module Promenade
+  module Client
+    module Rack
+      module SingletonCaller
+        def initialize_singleton(...)
+          @singleton = new(...)
+        end
+
+        def call(...)
+          singleton.call(...)
+        end
+
+        def singleton
+          @singleton || initialize_singleton
+        end
+      end
+    end
+  end
+end

data/lib/promenade/configuration.rb

@@ -0,0 +1,14 @@
+module Promenade
+  class Configuration
+    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/engine.rb

@@ -0,0 +1,5 @@
+module Promenade
+  class Engine < ::Rails::Engine
+    isolate_namespace Promenade
+  end
+end

data/lib/promenade/prometheus.rb

@@ -35,7 +35,7 @@ module Promenade
     class Options
       BUCKET_PRESETS = {
         network: [0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10].freeze,
-        memory: (0..10).map { |i| 128 * 2**i },
+        memory: (0..10).map { |i| 128 * (2**i) },
       }.freeze
 
       def initialize

data/lib/promenade/railtie.rb

@@ -1,9 +1,16 @@
 require "promenade/setup"
+require "promenade/engine"
+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::HTTPRequestDurationCollector
+      Rails.application.config.middleware.insert 0,
+        Promenade::Client::Rack::HTTPRequestQueueTimeCollector
     end
   end
 end

data/lib/promenade/setup.rb

@@ -1,16 +1,25 @@
 require "pathname"
 
 module Promenade
-  def self.root_dir
-    rails_root = defined?(Rails) && Rails.root
-    rails_root || Pathname.new(ENV.fetch("RAILS_ROOT", Dir.pwd))
+  module_function
+
+  def root_dir
+    if rails_defined?
+      Rails.root
+    else
+      Pathname.new(ENV.fetch("RAILS_ROOT", Dir.pwd))
+    end
+  end
+
+  def rails_defined?
+    defined?(Rails)
   end
 
-  def self.multiprocess_files_dir
+  def multiprocess_files_dir
     ENV.fetch("PROMETHEUS_MULTIPROC_DIR", root_dir.join("tmp", "promenade"))
   end
 
-  def self.setup
+  def setup
     unless File.directory? multiprocess_files_dir
       FileUtils.mkdir_p multiprocess_files_dir
     end

data/lib/promenade/version.rb

@@ -1,3 +1,3 @@
 module Promenade
-  VERSION = "0.2.2".freeze
+  VERSION = "0.6.0".freeze
 end

data/lib/promenade.rb

@@ -1,5 +1,6 @@
 require "promenade/version"
 require "promenade/setup"
+require "promenade/configuration"
 require "promenade/railtie" if defined? ::Rails::Railtie
 require "promenade/prometheus"
 
@@ -14,5 +15,13 @@ module Promenade
     def metric(name)
       Promenade::Prometheus.metric(name)
     end
+
+    def configuration
+      @_configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
   end
 end

data/promenade.gemspec

@@ -22,19 +22,23 @@ 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.5", "< 4"
+  spec.required_ruby_version = ">= 2.7", "< 3.2"
 
-  spec.add_dependency "activesupport"
-  spec.add_dependency "prometheus-client-mmap", "~> 0.12.0"
+  spec.add_dependency "actionpack"
+  spec.add_dependency "activesupport", "> 6.0", "< 8.0"
+  spec.add_dependency "prometheus-client-mmap", "~> 0.16.0"
   spec.add_dependency "rack"
-
   spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "byebug"
   spec.add_development_dependency "climate_control"
   spec.add_development_dependency "deep-cover"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rails", "> 3.0", "< 8.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.11"
+  spec.add_development_dependency "rspec-rails", "~> 5.1"
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "rubocop-performance"
   spec.add_development_dependency "rubocop-rails"
   spec.add_development_dependency "simplecov"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: promenade
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Ed Robinson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-21 00:00:00.000000000 Z
+date: 2022-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -24,20 +24,40 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: prometheus-client-mmap
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +86,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: climate_control
   requirement: !ruby/object:Gem::Requirement
@@ -94,34 +128,68 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: rake
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -199,9 +267,19 @@ files:
 - Rakefile
 - bin/console
 - bin/integration_test
+- bin/rails
 - bin/setup
 - exe/promenade
 - lib/promenade.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_labeler.rb
+- lib/promenade/client/rack/singleton_caller.rb
+- lib/promenade/configuration.rb
+- lib/promenade/engine.rb
 - lib/promenade/kafka.rb
 - lib/promenade/kafka/async_producer_subscriber.rb
 - lib/promenade/kafka/connection_subscriber.rb
@@ -217,7 +295,8 @@ files:
 homepage: https://github.com/errm/promenade
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -226,17 +305,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '4'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.18
 signing_key:
 specification_version: 4
 summary: Promenade makes it simple to instrument Ruby apps for prometheus scraping