gvl_metrics_middleware 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9c303f29cd3924fceeeaa769037e69857a90f5b237c0ec10d5f94a412f5c03c
-  data.tar.gz: 52c7a388c144debe25968379af1769d1f406214fe634961727589ca98784b78d
+  metadata.gz: 49d838fbb9b6654650f146cff085b6dc40a1569c07c6d2e03453007bcbab6a58
+  data.tar.gz: ebad112fc9f619e494b54a100551c74859d885446d2c70b93d1119b0324dc99f
 SHA512:
-  metadata.gz: e83517c9c027b5329dcea41f6d051c1a2e5c685162a3057ee6c00294032289eb61aa8f444d4657284c9f6519d4e29458dcebd456f29018bd386a26b1cc4a9048
-  data.tar.gz: 4a992b0675b6f32161d796f142e47c2b9232eb647bbbd7e0a64d324577794be882b5d7131dbaa24adbc74517c17dd9c3a95abaa1a6a642c5c68ec6c6ee5dd06d
+  metadata.gz: 33ba9dfbd6c8f8b8bccb3820d830d1e713e8bee067598035eb17d094b1e0040ffbbbd1ea68e9badafe78a09da3e258fec5ad45d2c468180e6256200582472e97
+  data.tar.gz: 6f0fafc8ba4e04a8834e7e0c79b98bfd4570f7c5a531863be30ed54ce0c8190aa66f6b8189167754115ec51d7fdb79362054a834bc3d509206e1a53d4fa58598

data/CHANGELOG.md

@@ -1,10 +1,14 @@
 ## [Unreleased]
 
+## [0.4.0] - 2026-06-19
+
+- The Rack reporter now receives a `route:` keyword option: the request's route template — `"controller#action"` on Rails or the matched route on Sinatra (`nil` when no route matched). This lets reporters segment GVL metrics by endpoint (e.g. the CPU/IO ratio per action), mirroring the `queue`/`job_class` options the Sidekiq reporter already receives. Reporters defined as strict lambdas should accept the keyword (e.g. `->(total, running, io_wait, gvl_wait, **options) {}`); block-style reporters are unaffected.
+
 ## [0.3.0] - 2026-01-26
 
 - Add Ruby 4.0 support ([#25](https://github.com/speedshop/gvl_metrics_middleware/pull/25))
 - Add support for Sidekiq 5.2 ([#23](https://github.com/speedshop/gvl_metrics_middleware/pull/23))
-- Skip GVL measurement when no reporter is configured, improving performance ([#20](https://github.com/speedshop/gvl_metrics_middleware/pull/20))
+- Skip GVL measurement when no reporter is configured, improving performance ([#21](https://github.com/speedshop/gvl_metrics_middleware/pull/21))
 
 ## [0.2.1] - 2025-11-14
 

data/README.md

@@ -20,11 +20,14 @@ GvlMetricsMiddleware.configure do |config|
   # Optional: Set sampling rate (0.0 to 1.0, defaults to 0.01 for 1% sampling)
   config.sampling_rate = 0.1 # Sample 10% of requests/jobs
 
-  config.rack do |total, running, io_wait, gvl_wait|
+  config.rack do |total, running, io_wait, gvl_wait, options|
+    # options[:route] is the request's route — "controller#action" on Rails or the
+    # matched route on Sinatra (nil when no route matched).
     # Your code here...
   end
 
-  config.sidekiq do |total, running, io_wait, gvl_wait|
+  config.sidekiq do |total, running, io_wait, gvl_wait, options|
+    # options[:queue] and options[:job_class] describe the job.
     # Your code here...
   end
 end
@@ -38,11 +41,19 @@ GvlMetricsMiddleware.configure do |config|
   # Increase sampling from default 1% to 10% for more data
   config.sampling_rate = 0.1
 
-  config.rack do |total, running, io_wait, gvl_wait|
+  config.rack do |total, running, io_wait, gvl_wait, options|
     NewRelic::Agent.record_metric("Custom/Rack/GVL/total", total)
     NewRelic::Agent.record_metric("Custom/Rack/GVL/running", running)
     NewRelic::Agent.record_metric("Custom/Rack/GVL/io_wait", io_wait)
     NewRelic::Agent.record_metric("Custom/Rack/GVL/gvl_wait", gvl_wait)
+
+    # Segment by route ("users#show" on Rails, "GET /users/:id" on Sinatra) to see
+    # the CPU/IO ratio per action:
+    route = options[:route]
+    if route
+      NewRelic::Agent.record_metric("Custom/Rack/GVL/#{route}/running", running)
+      NewRelic::Agent.record_metric("Custom/Rack/GVL/#{route}/io_wait", io_wait)
+    end
   end
 
   config.sidekiq do |total, running, io_wait, gvl_wait, options|
@@ -75,6 +86,13 @@ The `gvl_metrics_middleware` reports these metrics. All metrics are in nanosecon
 - **`io_wait`**: The time spent waiting for I/O after the thread released the GVL. Comes from `GVLTiming::Timer#idle_duration`.
 - **`gvl_wait`**: The time spent waiting to get the GVL. Comes from `GVLTiming::Timer#stalled_duration`.
 
+## Per-request context
+
+Besides the four timing values, each callback receives a final `options` hash describing what was measured, so you can segment the metrics:
+
+- **Rack** — `options[:route]`: the request's route *template*. On Rails this is the `"controller#action"` pair (e.g. `users#show`, `admin/users#index`); on Sinatra it is the matched route (e.g. `GET /users/:id`). It is `nil` when no route matched (404s, or a plain Rack app). Only the route template is used — never the raw path — so it stays low-cardinality.
+- **Sidekiq** — `options[:queue]` and `options[:job_class]`: the queue the job ran on and its class name.
+
 ## Sampling
 
 By default, the middleware samples 1% of requests and jobs to keep overhead low. You can change this rate:

data/lib/gvl_metrics_middleware/rack.rb

@@ -29,7 +29,7 @@ module GvlMetricsMiddleware
       end
 
       begin
-        reporter.call(gvl_times.duration_ns, gvl_times.running_duration_ns, gvl_times.idle_duration_ns, gvl_times.stalled_duration_ns)
+        reporter.call(gvl_times.duration_ns, gvl_times.running_duration_ns, gvl_times.idle_duration_ns, gvl_times.stalled_duration_ns, route: route_for(env))
       rescue => exception
         GvlMetricsMiddleware.on_report_failure&.call("Rack", exception)
 
@@ -38,5 +38,24 @@ module GvlMetricsMiddleware
 
       response
     end
+
+    private
+
+    # The request's route template, passed to the reporter so it can segment GVL
+    # metrics by endpoint (for example, the CPU/IO ratio per action). On Rails it
+    # is the "controller#action" pair; on Sinatra it is the matched route. Only the
+    # route *template* is used -- never the raw path -- so it stays low-cardinality,
+    # and on Rails only :controller and :action are read (path_parameters also holds
+    # :id, :format, ...). Returns nil when no route matched (404s, or a plain Rack
+    # app), leaving any fallback to the reporter.
+    def route_for(env)
+      if (path_parameters = env["action_dispatch.request.path_parameters"]) # Rails
+        controller = path_parameters[:controller]
+        action = path_parameters[:action]
+        return "#{controller}##{action}" if controller && action
+      end
+
+      env["sinatra.route"] # Sinatra, e.g. "GET /users/:id"
+    end
   end
 end

data/lib/gvl_metrics_middleware/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GvlMetricsMiddleware
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gvl_metrics_middleware
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Nate Berkopec
@@ -119,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Rack and Sidekiq middlewares for GVL metrics
 test_files: []