gvl_metrics_middleware 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81e9afea6ad5c3271fb91da6b0f69efcd3e1f49153b7e5a278483701295ebbac
-  data.tar.gz: 22363d1d03ee82e7a5e6475226fdf73414d9b643728dd0da6c4b7f05b86c6b29
+  metadata.gz: e9c303f29cd3924fceeeaa769037e69857a90f5b237c0ec10d5f94a412f5c03c
+  data.tar.gz: 52c7a388c144debe25968379af1769d1f406214fe634961727589ca98784b78d
 SHA512:
-  metadata.gz: 4ba04171e7a5a1ae4eb7da1f9cbb32302d79e07679d05edc12f9d6dcc100bce0f514002368e94440f9b6cd00c313372d35b22accfda0905dae16083a29e26341
-  data.tar.gz: cdcf224fafb3879e806e8a033c5622431baf77c14fda3b76baef184f4e8cf60862ce41838527b31ebc831124349d6b4995da1248114d8af483e8a19027688fef
+  metadata.gz: e83517c9c027b5329dcea41f6d051c1a2e5c685162a3057ee6c00294032289eb61aa8f444d4657284c9f6519d4e29458dcebd456f29018bd386a26b1cc4a9048
+  data.tar.gz: 4a992b0675b6f32161d796f142e47c2b9232eb647bbbd7e0a64d324577794be882b5d7131dbaa24adbc74517c17dd9c3a95abaa1a6a642c5c68ec6c6ee5dd06d

data/Appraisals

@@ -31,3 +31,31 @@ appraise "rails_71" do
   gem "railties", "~> 7.1.0"
   gem "activesupport", "~> 7.1.0"
 end
+
+appraise "sidekiq_52" do
+  gem "sidekiq", "~> 5.2"
+  gem "rails", "~> 7.1.0"
+  gem "railties", "~> 7.1.0"
+  gem "activesupport", "~> 7.1.0"
+end
+
+appraise "sidekiq_6x" do
+  gem "sidekiq", "~> 6.5", ">= 6.5.12"
+  gem "rails", "~> 7.1.0"
+  gem "railties", "~> 7.1.0"
+  gem "activesupport", "~> 7.1.0"
+end
+
+appraise "sidekiq_7x" do
+  gem "sidekiq", "~> 7.3"
+  gem "rails", "~> 8.0.0"
+  gem "railties", "~> 8.0.0"
+  gem "activesupport", "~> 8.0.0"
+end
+
+appraise "sidekiq_8x" do
+  gem "sidekiq", "~> 8.1"
+  gem "rails", "~> 8.0.0"
+  gem "railties", "~> 8.0.0"
+  gem "activesupport", "~> 8.0.0"
+end

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [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))
+
 ## [0.2.1] - 2025-11-14
 
 - Fixed errors when middleware stack may have been modified ([#18](https://github.com/speedshop/gvl_metrics_middleware/pull/18))

data/README.md

@@ -1,13 +1,10 @@
 # GVL Metrics Middleware
 
-`gvl_metrics_middleware` is a Ruby gem that provides middleware for monitoring and gathering metrics on Global VM Lock (
-GVL) in multi-threaded Ruby applications. This gem leverages
-[the `gvl_timing` gem](https://github.com/jhawthorn/gvl_timing) to measure time spent in the GVL and invokes a provided
-callback with the collected metrics data.
+`gvl_metrics_middleware` is a Ruby gem that monitors the Global VM Lock (GVL) in multi-threaded Ruby applications. This gem uses [the `gvl_timing` gem](https://github.com/jhawthorn/gvl_timing) to measure time spent in the GVL. It then calls your callback with the metrics.
 
 ## Installation
 
-Add the gem to your application’s Gemfile, and run `bundle install` to install the gem:
+Add the gem to your application's Gemfile, and run `bundle install` to install the gem:
 
 ```bash
 gem 'gvl_metrics_middleware', git: "https://github.com/speedshop/gvl_metrics_middleware.git"
@@ -15,9 +12,7 @@ gem 'gvl_metrics_middleware', git: "https://github.com/speedshop/gvl_metrics_mid
 
 ## Usage
 
-The `gvl_metrics_middleware` automatically inserts the necessary middleware into your application’s stack. To get
-started, configure a callback to handle the GVL metrics. Place the following configuration in your
-application’s `config/initializers`directory:
+The `gvl_metrics_middleware` automatically adds itself to your application. To get started, set up a callback to handle the GVL metrics. Put this code in your application's `config/initializers` folder:
 
 ```ruby
 # config/initializers/gvl_metrics_middleware.rb
@@ -35,7 +30,7 @@ GvlMetricsMiddleware.configure do |config|
 end
 ```
 
-For example, if you would like to record the GVL metrics in New Relic, you can use the following configuration.
+For example, here is how to record the GVL metrics in New Relic.
 
 ```ruby
 # config/initializers/gvl_metrics_middleware.rb
@@ -67,28 +62,22 @@ GvlMetricsMiddleware.configure do |config|
 end
 ```
 
-After configuring, you should be able to set up custom charts in New Relic to visualize the GVL metrics. Here is an
-example chart:
+After you set this up, you can create custom charts in New Relic to see the GVL metrics. Here is an example chart:
 
 ![Screenshot of the GVL metrics chart on New Relic](gvl-metrics.png)
 
 ## Available Metrics
 
-The `gvl_metrics_middleware` reports the following metrics. The metrics are all reported in nanoseconds.
+The `gvl_metrics_middleware` reports these metrics. All metrics are in nanoseconds.
 
-- **`total`**: The total duration of the request processing time, which is the sum of `running`, `io_wait`,
-  and `gvl_wait`. This corresponds to the returned value from the value returned by the `GVLTiming::Timer#duration`
-  method in `gvl_timing`.
-- **`running`**: The time a thread held the GVL and performed work (a.k.a CPU time). This corresponds to the
-  value returned by the `GVLTiming::Timer#cpu_duration` method.
-- **`io_wait`**: The time spent waiting for I/O operations after releasing the GVL. This corresponds to the
-  value returned by the `GVLTiming::Timer#idle_duration` method.
-- **`gvl_wait`**: The time spent waiting to acquire the GVL. This corresponds to the value returned by
-  the `GVLTiming::Timer#stalled_duration` method.
+- **`total`**: The total time to process the request. This equals `running` + `io_wait` + `gvl_wait`. Comes from `GVLTiming::Timer#duration` in `gvl_timing`.
+- **`running`**: The time a thread held the GVL and did work. Also called CPU time. Comes from `GVLTiming::Timer#cpu_duration`.
+- **`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`.
 
 ## Sampling
 
-By default, the middleware samples 1% of requests and jobs to minimize overhead. You can adjust this sampling rate:
+By default, the middleware samples 1% of requests and jobs to keep overhead low. You can change this rate:
 ```ruby
 GvlMetricsMiddleware.configure do |config|
   # Sample 25% of requests/jobs
@@ -98,46 +87,32 @@ GvlMetricsMiddleware.configure do |config|
 end
 ```
 
-The `sampling_rate` option accepts a value between `0.0` (no sampling) and `1.0` (100% sampling). The default is `0.01` (1%).
+The `sampling_rate` option takes a value between `0.0` (no sampling) and `1.0` (100% sampling). The default is `0.01` (1%).
 
-The middleware will randomly decide whether to instrument each request or job based on the configured rate. The default 1% sampling provides meaningful metrics while maintaining minimal performance overhead.
+The middleware will randomly pick which requests or jobs to measure based on this rate. The default 1% sampling gives you useful metrics while keeping overhead low.
 
-**Important**: Your metrics will only represent the sampled portion of traffic. You may need to adjust your alerting and analysis accordingly.
+**Important**: Your metrics only show the sampled part of your traffic. You may need to adjust your alerts and analysis to match.
 
 ## Performance Overhead
 
-The overhead introduced by `gvl_metrics_middleware` is minimal. Benchmarking has shown only a 1% difference in response
-times between scenarios with and without GVL metrics collection. This result has been validated through an A/A test,
-where both the control and experiment groups ran identical code, and the difference remained at 1%. This 1% overhead is
-consistent with those reported in [Shopify's `gvltools`](https://github.com/Shopify/gvltools?tab=readme-ov-file#usage),
-where the overhead was measured at 1-5% in a production environment.
+The overhead from `gvl_metrics_middleware` is small. Tests show only a 1% difference in response times. We ran tests with and without GVL metrics. We checked this with an A/A test. Both groups ran the same code. The difference stayed at 1%. This matches what [Shopify's `gvltools`](https://github.com/Shopify/gvltools?tab=readme-ov-file#usage) found. Their overhead was 1-5% in production.
 
-As stated in [the README of `gvltools`](https://github.com/Shopify/gvltools?tab=readme-ov-file#usage), the exact
-overhead is not yet known. However, unless you observe an immediate, significant jump in response times after
-deployment, the overhead is negligible and should not impact application performance. This makes the middleware a
-reliable choice for tracking GVL metrics in production environments.
+As [the README of `gvltools`](https://github.com/Shopify/gvltools?tab=readme-ov-file#usage) says, the exact overhead is not known yet. But if you don't see a big jump in response times after you deploy, the overhead is small. It will not hurt your app's speed. This makes the middleware good for tracking GVL metrics in production.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can
-also run `bin/console` for an interactive prompt that will allow you to experiment.
+After you check out the repo, run `bin/setup` to install what you need. Then run `rake test` to run the tests. You can also run `bin/console`. This gives you an interactive prompt where you can try things out.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
-version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version,
-push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem on your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`. Then run `bundle exec rake release`. This will create a git tag for the version. It will push git commits and the tag. It will also push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/speedshop/gvl_metrics_middleware. This
-project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
-the [code of conduct](https://github.com/speedshop/gvl_metrics_middleware/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/speedshop/gvl_metrics_middleware. This project should be a safe, welcoming place for everyone. All contributors must follow the [code of conduct](https://github.com/speedshop/gvl_metrics_middleware/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+This gem is open source under the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the GvlMetricsMiddleware project's codebases, issue trackers, chat rooms and mailing lists is
-expected to follow
-the [code of conduct](https://github.com/speedshop/gvl_metrics_middleware/blob/main/CODE_OF_CONDUCT.md).
+Everyone who uses the GvlMetricsMiddleware project must follow the [code of conduct](https://github.com/speedshop/gvl_metrics_middleware/blob/main/CODE_OF_CONDUCT.md). This includes codebases, issue trackers, chat rooms, and mailing lists.

data/gemfiles/sidekiq_52.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "minitest", "~> 5.16"
+gem "rake", "~> 13.0"
+gem "rubocop", require: false
+gem "rack-attack", "~> 6.8"
+gem "sidekiq", "~> 5.2"
+gem "rails", "~> 7.1.0"
+gem "railties", "~> 7.1.0"
+gem "activesupport", "~> 7.1.0"
+
+gemspec path: "../"

data/gemfiles/sidekiq_6x.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "minitest", "~> 5.16"
+gem "rake", "~> 13.0"
+gem "rubocop", require: false
+gem "rack-attack", "~> 6.8"
+gem "sidekiq", "~> 6.5", ">= 6.5.12"
+gem "rails", "~> 7.1.0"
+gem "railties", "~> 7.1.0"
+gem "activesupport", "~> 7.1.0"
+
+gemspec path: "../"

data/gemfiles/sidekiq_7x.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "minitest", "~> 5.16"
+gem "rake", "~> 13.0"
+gem "rubocop", require: false
+gem "rack-attack", "~> 6.8"
+gem "sidekiq", "~> 7.3"
+gem "rails", "~> 8.0.0"
+gem "railties", "~> 8.0.0"
+gem "activesupport", "~> 8.0.0"
+
+gemspec path: "../"

data/gemfiles/sidekiq_8x.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "minitest", "~> 5.16"
+gem "rake", "~> 13.0"
+gem "rubocop", require: false
+gem "rack-attack", "~> 6.8"
+gem "sidekiq", "~> 8.1"
+gem "rails", "~> 8.0.0"
+gem "railties", "~> 8.0.0"
+gem "activesupport", "~> 8.0.0"
+
+gemspec path: "../"

data/lib/gvl_metrics_middleware/rack.rb

@@ -19,7 +19,8 @@ module GvlMetricsMiddleware
     end
 
     def call(env)
-      return @app.call(env) unless GvlMetricsMiddleware.should_sample?
+      reporter = self.class.reporter
+      return @app.call(env) if reporter.nil? || !GvlMetricsMiddleware.should_sample?
 
       response = nil
 
@@ -28,7 +29,7 @@ module GvlMetricsMiddleware
       end
 
       begin
-        self.class.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)
       rescue => exception
         GvlMetricsMiddleware.on_report_failure&.call("Rack", exception)
 

data/lib/gvl_metrics_middleware/sidekiq.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 require "gvl_timing"
-require "sidekiq/middleware/modules"
+
+if ::Sidekiq::VERSION >= "6.5.0"
+  require "sidekiq/middleware/modules"
+end
 
 module GvlMetricsMiddleware
   class Sidekiq
@@ -15,15 +18,18 @@ module GvlMetricsMiddleware
       end
     end
 
-    include ::Sidekiq::ServerMiddleware
+    if ::Sidekiq::VERSION >= "6.5.0"
+      include ::Sidekiq::ServerMiddleware
+    end
 
     def call(job_instance, _job_payload, queue)
-      return yield unless GvlMetricsMiddleware.should_sample?
+      reporter = self.class.reporter
+      return yield if reporter.nil? || !GvlMetricsMiddleware.should_sample?
 
       gvl_times = GVLTiming.measure { yield }
 
       begin
-        self.class.reporter&.call(gvl_times.duration_ns, gvl_times.running_duration_ns, gvl_times.idle_duration_ns, gvl_times.stalled_duration_ns, job_class: job_instance.class.to_s, queue: queue)
+        reporter.call(gvl_times.duration_ns, gvl_times.running_duration_ns, gvl_times.idle_duration_ns, gvl_times.stalled_duration_ns, job_class: job_instance.class.to_s, queue: queue)
       rescue => exception
         GvlMetricsMiddleware.on_report_failure&.call("Sidekiq", exception)
 

data/lib/gvl_metrics_middleware/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gvl_metrics_middleware
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Nate Berkopec
@@ -86,6 +86,10 @@ files:
 - gemfiles/rails_80.gemfile
 - gemfiles/rails_81.gemfile
 - gemfiles/rails_edge.gemfile
+- gemfiles/sidekiq_52.gemfile
+- gemfiles/sidekiq_6x.gemfile
+- gemfiles/sidekiq_7x.gemfile
+- gemfiles/sidekiq_8x.gemfile
 - gvl-metrics.png
 - lib/gvl_metrics_middleware.rb
 - lib/gvl_metrics_middleware/rack.rb
@@ -115,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Rack and Sidekiq middlewares for GVL metrics
 test_files: []