newrelic_gvl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d7d3d1e3a1f33185ab589571adb3ede1294c9e927de0da447161d8a5950a617
+  data.tar.gz: 746c08559b04aa4f8cf1cefffca2fc5df63413530606e7f48523651aa77fb959
+SHA512:
+  metadata.gz: bb3cf946338066a9f918fe48e919c9e0eecac63f429618468b28c649ecfef33bb170a5e72752321f56431c7e3a9d4be99f12d8c958cf439179ae00cb0c131767
+  data.tar.gz: 8aed237b54ee3ec2dfee686b491c9f864933c1e0405480c04b2fb69bcbfe485875f30a61da4c04c2c508a6e510e06267301d41b17bdee4e8fb4b247290348473

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-02
+
+- Initial release

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in newrelic_gvl.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest"
+gem "standard", "~> 1.3"
+
+gem "mocha", "~> 2.0"

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    newrelic_gvl (0.1.0)
+      gvltools (> 0)
+      newrelic_rpm (> 0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    gvltools (0.1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    minitest (5.17.0)
+    mocha (2.0.2)
+      ruby2_keywords (>= 0.0.5)
+    newrelic_rpm (8.15.0)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.2)
+    rexml (3.2.5)
+    rubocop (1.42.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    standard (1.22.1)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (= 1.42.0)
+      rubocop-performance (= 1.15.2)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  minitest
+  mocha (~> 2.0)
+  newrelic_gvl!
+  rake (~> 13.0)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.3.15

data/README.md

@@ -0,0 +1,41 @@
+# NewRelic GVL Stats
+
+Ruby 3.2.0 allows for tracking of GVL status. This gem utilizes that API via [gvltools](https://github.com/Shopify/gvltools) to report GVL status for Sidekiq jobs and Rack requests.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add newrelic_gvl
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install newrelic_gvl
+
+## Usage
+
+For rails:
+
+```
+config.middleware.use NewrelicGvl::Rack::Middleware
+```
+
+For sidekiq:
+
+```
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add NewrelicGvl::Sidekiq::Middleware
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gstark/newrelic_gvl.

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+require "standard/rake"
+
+Minitest::TestTask.create(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.warning = false
+  t.test_globs = FileList["test/test_helper.rb", "test/**/*_spec.rb"]
+end
+
+task default: :test

data/lib/newrelic_gvl/rack/middleware.rb

@@ -0,0 +1,20 @@
+require "gvltools"
+
+module NewrelicGvl
+  module Rack
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        before = GVLTools::LocalTimer.monotonic_time
+        @app.call(env).tap do |response|
+          wait_in_ms = (GVLTools::LocalTimer.monotonic_time - before) / 1_000_000.0
+
+          NewRelic::Agent.add_custom_attributes({gvl_wait: wait_in_ms})
+        end
+      end
+    end
+  end
+end

data/lib/newrelic_gvl/sidekiq/middleware.rb

@@ -0,0 +1,19 @@
+require "gvltools"
+
+module NewrelicGvl
+  module Sidekiq
+    class Middleware
+      include Sidekiq::ClientMiddleware if defined?(Sidekiq::ClientMiddleware)
+
+      def call(_worker, _job, _queue, _redis_pool)
+        before = GVLTools::LocalTimer.monotonic_time
+
+        yield
+      ensure
+        wait_in_ms = (GVLTools::LocalTimer.monotonic_time - before) / 1_000_000.0
+
+        NewRelic::Agent.add_custom_attributes({gvl_wait: wait_in_ms})
+      end
+    end
+  end
+end

data/lib/newrelic_gvl/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module NewrelicGvl
+  VERSION = "0.1.0"
+end

data/lib/newrelic_gvl.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module NewrelicGvl
+  class Error < StandardError; end
+end
+
+require_relative "newrelic_gvl/version"
+require_relative "newrelic_gvl/sidekiq/middleware"
+require_relative "newrelic_gvl/rack/middleware"

data/sig/newrelic_gvl.rbs

@@ -0,0 +1,4 @@
+module NewrelicGvl
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: newrelic_gvl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gavin Stark
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gvltools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: newrelic_rpm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: NewRelic middleware that measures time spent waiting on the GVL
+email:
+- gavin@gstark.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/newrelic_gvl.rb
+- lib/newrelic_gvl/rack/middleware.rb
+- lib/newrelic_gvl/sidekiq/middleware.rb
+- lib/newrelic_gvl/version.rb
+- sig/newrelic_gvl.rbs
+homepage: https://github.com/gstark/newrelic_gvl
+licenses: []
+metadata:
+  homepage_uri: https://github.com/gstark/newrelic_gvl
+  source_code_uri: https://github.com/gstark/newrelic_gvl
+  changelog_uri: https://github.com/gstark/newrelic_gvl/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: NewRelic middleware that measures time spent waiting on the GVL
+test_files: []