autotuner 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 511df4fa38774e70c89c66a4d3692098537189c2281851896327ce7b7df6fc05
-  data.tar.gz: b97736b7e50e47753c0f487a37e32fd7fc3d3869ab50e6197cea4894978f7208
+  metadata.gz: 2110ae589a151476ac745ec4767d13e3146c890df830108745dc077c64f79f50
+  data.tar.gz: cea9ce8c687ae32214f41b65466e110abdab8bb00e1aab0596c9d787b510b496
 SHA512:
-  metadata.gz: 2bebcb6ee78c76d67b11436a4466629094e8157820a330fbcb93286d82a725b688cc0aad4ee9dd264a929a5669a30f9a8ab90f27a89a4b85885f9437a6b28070
-  data.tar.gz: 5e69496888210a882723e2d9d54af4daf35546c7ddf14a5c225c07e51aedcf331e8d90d998a6eba267d6d8abcfb9474bd54dbbbee76cd2828dcef6f2a429e35f
+  metadata.gz: 75e382f22166a16159065717da0bdff1e428986c6367d3c6598978bb7354ebf25074cb2b4a335ff5a1e252b1f6b377b7cd101f162addc990382e720bd99f8539
+  data.tar.gz: 61fabf37f9ebd55b403f023e545c94e8a56bfea52058006f9f7c8a34c07a9f8d12580ca704dab629c99390d741c27d65dfd6e0ca53ecce597c282b846f9d77c1

data/.devcontainer/devcontainer.json

@@ -0,0 +1,25 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+	"name": "autotuner",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "ghcr.io/rails/devcontainer/images/ruby:3.4.7",
+	"features": {
+		"ghcr.io/devcontainers/features/github-cli:1": {}
+	}
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "ruby --version",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

data/.ruby-version

@@ -1 +1 @@
-3.3.0
+3.4.7

data/Gemfile

@@ -5,8 +5,8 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in autotuner.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem "rake", "~> 13.2"
 
-gem "minitest", "~> 5.0"
+gem "minitest", "~> 5.26"
 
-gem "rubocop", "~> 1.21"
+gem "rubocop", "~> 1.81"

data/Gemfile.lock

@@ -1,57 +1,62 @@
 PATH
   remote: .
   specs:
-    autotuner (1.0.0)
+    autotuner (1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
-    json (2.7.1)
-    language_server-protocol (3.17.0.3)
-    minitest (5.22.3)
-    mocha (2.1.0)
+    ast (2.4.3)
+    json (2.15.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    minitest (5.26.0)
+    mocha (2.7.1)
       ruby2_keywords (>= 0.0.5)
-    parallel (1.24.0)
-    parser (3.3.0.5)
+    parallel (1.27.0)
+    parser (3.3.10.0)
       ast (~> 2.4.1)
       racc
-    racc (1.7.3)
+    prism (1.6.0)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.1.0)
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
-    rubocop (1.62.1)
+    rake (13.2.1)
+    regexp_parser (2.11.3)
+    rubocop (1.81.6)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.2)
-      parser (>= 3.3.0.4)
-    rubocop-minitest (0.35.0)
-      rubocop (>= 1.61, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-shopify (2.15.1)
-      rubocop (~> 1.51)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.47.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-minitest (0.38.2)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-shopify (2.17.1)
+      rubocop (~> 1.62)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
-    unicode-display_width (2.5.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   autotuner!
-  minitest (~> 5.0)
+  minitest (~> 5.26)
   mocha
-  rake (~> 13.0)
-  rubocop (~> 1.21)
+  rake (~> 13.2)
+  rubocop (~> 1.81)
   rubocop-minitest
   rubocop-shopify
 

data/README.md

@@ -64,11 +64,23 @@ While autotuner aims to comprehensively analyze your traffic to give the suggest
 ## Configuration
 
 - `Autotuner.enabled=`: (required, unless `Autotuner.sample_ratio` is set) Sets whether autotuner is enabled or not. When autotuner is disabled, data is not collected and suggestions are not given. Defaults to `false`.
-- `Autotuner.sample_ratio=`: (optional) Sets the portion of instances where autotuner is enabled. Pass a value between 0 (enabled on no intances) and 1.0 (enabled on all instances). Note that this does not sample requests, but rather samples the portion of instances that have autotuner enabled (it will be enabled for all requests on those instances). Do not configure `Autotuner.enabled=` when you use this option.
+- `Autotuner.sample_ratio=`: (optional) Sets the portion of instances where autotuner is enabled. Pass a value between 0 (enabled on no instances) and 1.0 (enabled on all instances). Note that this does not sample requests, but rather samples the portion of instances that have autotuner enabled (it will be enabled for all requests on those instances). Do not configure `Autotuner.enabled=` when you use this option.
 - `Autotuner.reporter=`: (required) Callback called when a heuristic is ready to give a suggestion. The callback will be called with one argument which will be an instance of `Autotuner::Report::Base`. Call `#to_s` on this object to get a string containing instructions and recommendations. You must set this when autotuner is enabled.
 - `Autotuner.debug_reporter=`: (optional) Callback to periodically emit debug messages of internal state of heuristics. The callback will be called with one argument which will be a hash with the heuristic name as the key and the debug message as the value. Regular users do not need to configure this as this is only useful for debugging purposes.
 - `Autotuner.metrics_reporter=`: (optional) Callback to emit useful metrics about your service. The callback will be called with a hash containing the metric names (string) as the key and integer values.
 
+## Emitted Metrics
+
+The following metrics are passed to the `metrics_reporter` callback after each request.
+
+| Name                  | Description |
+| --------------------- | ----------- |
+| `diff.time`           | Time spent doing garbage collection during the request. Produced by [GC::stat](https://docs.ruby-lang.org/en/master/GC.html#method-c-stat) |
+| `diff.minor_gc_count` | Number of minor garbage collections that occurred during the request. Produced by [GC::stat](https://docs.ruby-lang.org/en/master/GC.html#method-c-stat) |
+| `diff.major_gc_count` | Number of major garbage collections that occurred during the request. Produced by [GC::stat](https://docs.ruby-lang.org/en/master/GC.html#method-c-stat) |
+| `heap_pages`          | Number of heap pages in use after the request. Produced by [GC::stat](https://docs.ruby-lang.org/en/master/GC.html#method-c-stat) |
+| `request_time`        | Total duration of the request. |
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/autotuner.

data/autotuner.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/autotuner/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "autotuner"
+  spec.version = Autotuner::VERSION
+  spec.authors = ["Peter Zhu"]
+  spec.email = ["peter@peterzhu.ca"]
+
+  spec.summary = "Get suggestions to tune Ruby's garbage collector"
+  spec.homepage = "https://github.com/Shopify/autotuner"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Shopify/autotuner"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    %x(git ls-files -z).split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency("mocha")
+  spec.add_development_dependency("rubocop-minitest")
+  spec.add_development_dependency("rubocop-shopify")
+end

data/lib/autotuner/data_structure/data_points.rb

@@ -70,7 +70,7 @@ module Autotuner
           sum_x_y += x_val * y_val
         end
 
-        ((length * sum_x_y) - (sum_x * sum_y)).to_f / \
+        ((length * sum_x_y) - (sum_x * sum_y)).to_f /
           (Math.sqrt((length * sum_x_2) - (sum_x**2)) * Math.sqrt((length * sum_y_2) - (sum_y**2)))
       end
 

data/lib/autotuner/heuristic/base.rb

@@ -5,15 +5,13 @@ module Autotuner
     class Base
       class << self
         def enabled?
-          supported? && !@disabled
+          !@disabled
         end
 
         def disable!
           @disabled = true
         end
 
-        private
-
         def supported?
           raise NotImplementedError
         end

data/lib/autotuner/heuristic/gc_compact.rb

@@ -4,8 +4,6 @@ module Autotuner
   module Heuristic
     class GCCompact < Base
       class << self
-        private
-
         def supported?
           true
         end
@@ -33,7 +31,7 @@ module Autotuner
         # Don't give suggestion twice
         @called_gc_compact = true
 
-        Report::String.new(<<~MSG)
+        Report::String.new(name, <<~MSG)
           The following suggestion runs compaction at boot time, which reduces fragmentation inside of the Ruby heap. This can improve performance and reduce memory usage in forking web servers.
 
           Before forking your web server, run the following Ruby code:
@@ -41,10 +39,18 @@ module Autotuner
             3.times { GC.start }
             GC.compact
 
-          For example, in Puma, add the following code into config/puma.rb:
+          For example, with Puma, which runs its before fork hook once on boot (before the initial fork), add the following code into config/puma.rb:
+
+            before_fork do
+              3.times { GC.start }
+              GC.compact
+            end
+
+          With Unicorn, which runs its before fork hook before each fork, add the following code into config/unicorn.rb:
 
             compacted = false
             before_fork do
+              # avoid invalidating heap pages shared with previously forked children
               unless compacted
                 3.times { GC.start }
                 GC.compact

data/lib/autotuner/heuristic/heap_size_warmup.rb

@@ -4,8 +4,6 @@ module Autotuner
   module Heuristic
     class HeapSizeWarmup < Base
       class << self
-        private
-
         def supported?
           # Ruby 3.2 uses multiple heaps but does not support the
           # RUBY_GC_HEAP_%d_INIT_SLOTS environment variables, so we cannot
@@ -99,7 +97,13 @@ module Autotuner
         # Don't generate report if there is nothing to report
         return if suggested_values.empty?
 
-        Report::MultipleEnvironmentVariables.new(REPORT_ASSIST_MESSAGE, env_names, suggested_values, configured_values)
+        Report::MultipleEnvironmentVariables.new(
+          name,
+          REPORT_ASSIST_MESSAGE,
+          env_names,
+          suggested_values,
+          configured_values,
+        )
       end
 
       def debug_state

data/lib/autotuner/heuristic/malloc.rb

@@ -4,8 +4,6 @@ module Autotuner
   module Heuristic
     class Malloc < Base
       class << self
-        private
-
         def supported?
           true
         end
@@ -67,6 +65,7 @@ module Autotuner
         @given_suggestion = true
 
         Report::MultipleEnvironmentVariables.new(
+          name,
           <<~MSG,
             The following suggestions reduce the number of minor garbage collection cycles, specifically a cycle called "malloc". Your app runs malloc cycles in approximately #{format("%.2f", malloc_gc_ratio * 100)}% of all minor garbage collection cycles.
 

data/lib/autotuner/heuristic/oldmalloc.rb

@@ -4,8 +4,6 @@ module Autotuner
   module Heuristic
     class Oldmalloc < Base
       class << self
-        private
-
         def supported?
           true
         end
@@ -66,6 +64,7 @@ module Autotuner
         @given_suggestion = true
 
         Report::MultipleEnvironmentVariables.new(
+          name,
           <<~MSG,
             The following suggestions reduce the number of major garbage collection cycles, specifically a cycle called "oldmalloc". Your app runs oldmalloc cycles in approximately #{format("%.2f", oldmalloc_gc_ratio * 100)}% of all major garbage collection cycles.
 

data/lib/autotuner/heuristic/remembered_wb_unprotected_objects.rb

@@ -4,8 +4,6 @@ module Autotuner
   module Heuristic
     class RememberedWBUnprotectedObjects < Base
       class << self
-        private
-
         def supported?
           # Ruby 3.3.0 and later have support RUBY_GC_HEAP_REMEMBERED_WB_UNPROTECTED_OBJECTS_LIMIT_RATIO
           RUBY_VERSION >= "3.3.0"
@@ -64,6 +62,7 @@ module Autotuner
         @given_suggestion = true
 
         Report::SingleEnvironmentVariable.new(
+          name,
           <<~MSG,
             The following suggestions reduce the number of major garbage collection cycles, specifically a cycle called "remembered write barrier unprotected" (also know as "shady" due to historical reasons). Your app runs remembered write barrier unprotected cycles in approximately #{format("%.2f", wb_unprotected_gc_ratio * 100)}% of all major garbage collection cycles.
 

data/lib/autotuner/heuristics.rb

@@ -3,10 +3,10 @@
 module Autotuner
   module Heuristics
     HEURISTICS = Heuristic::Base.subclasses.freeze
-    ENABLED_HEURISTICS = HEURISTICS.dup.keep_if(&:enabled?).freeze
+    SUPPORTED_HEURISTICS = HEURISTICS.dup.keep_if(&:supported?).freeze
 
-    def enabled_heuristics
-      ENABLED_HEURISTICS
+    def supported_heuristics
+      SUPPORTED_HEURISTICS
     end
   end
 end

data/lib/autotuner/report/base.rb

@@ -7,9 +7,10 @@ module Autotuner
         It is always recommended to experiment with these suggestions as some suggestions may not always yield positive performance improvements. The recommended method is to perform A/B testing where a portion of traffic does not have the these suggested values and a portion of traffic with these suggested values.
       MSG
 
-      attr_reader :assist_message
+      attr_reader :heuristic_name, :assist_message
 
-      def initialize(assist_message)
+      def initialize(heuristic_name, assist_message)
+        @heuristic_name = heuristic_name
         @assist_message = assist_message
       end
 

data/lib/autotuner/report/multiple_environment_variables.rb

@@ -7,8 +7,8 @@ module Autotuner
       attr_reader :suggested_value
       attr_reader :configured_value
 
-      def initialize(assist_message, env_name, suggested_value, configured_value)
-        super(assist_message)
+      def initialize(heuristic_name, assist_message, env_name, suggested_value, configured_value)
+        super(heuristic_name, assist_message)
         @env_name = env_name
         @suggested_value = suggested_value
         @configured_value = configured_value
@@ -25,7 +25,7 @@ module Autotuner
       end
 
       def suggested_tuning_str(env, suggested, configured)
-        str = +"  #{env}=#{suggested}"
+        str = "  #{env}=#{suggested}"
         str << " (configured value: #{configured})" if configured
         str << "\n"
         str

data/lib/autotuner/report/single_environment_variable.rb

@@ -7,8 +7,8 @@ module Autotuner
       attr_reader :suggested_value
       attr_reader :configured_value
 
-      def initialize(assist_message, env_name, suggested_value, configured_value)
-        super(assist_message)
+      def initialize(heuristic_name, assist_message, env_name, suggested_value, configured_value)
+        super(heuristic_name, assist_message)
 
         @env_name = env_name
         @suggested_value = suggested_value

data/lib/autotuner/request_collector.rb

@@ -5,8 +5,6 @@ module Autotuner
     HEURISTICS_POLLING_FREQUENCY = 100
     DEBUG_EMIT_FREQUENCY = 1000
 
-    attr_reader :heuristics
-
     def initialize
       @request_count = 0
 
@@ -14,7 +12,7 @@ module Autotuner
 
       @system_context = SystemContext.new
 
-      @heuristics = Autotuner.enabled_heuristics.map { |h| h.new(@system_context) }
+      @heuristics = Autotuner.supported_heuristics.map { |h| h.new(@system_context) }
     end
 
     def request
@@ -27,6 +25,16 @@ module Autotuner
 
     private
 
+    def enabled_heuristics
+      Enumerator.new do |y|
+        @heuristics.each do |heuristic|
+          next unless heuristic.class.enabled?
+
+          y << heuristic
+        end
+      end
+    end
+
     def before_request
       @request_context.before_request
 
@@ -38,7 +46,7 @@ module Autotuner
 
       @system_context.update(@request_context)
 
-      heuristics.each do |heuristic|
+      enabled_heuristics.each do |heuristic|
         heuristic.call(@request_context)
       end
 
@@ -48,7 +56,7 @@ module Autotuner
     end
 
     def emit_heuristic_reports
-      heuristics.each do |heuristic|
+      enabled_heuristics.each do |heuristic|
         report = heuristic.tuning_report
 
         next unless report
@@ -68,7 +76,7 @@ module Autotuner
         system_context: @system_context.debug_state,
       }
 
-      heuristics.each do |h|
+      enabled_heuristics.each do |h|
         debug_states[h.name] = h.debug_state
       end
 

data/lib/autotuner/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Autotuner
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: autotuner
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Peter Zhu
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -52,13 +51,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - peter@peterzhu.ca
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/devcontainer.json"
 - ".rubocop.yml"
 - ".ruby-version"
 - Gemfile
@@ -66,6 +65,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- autotuner.gemspec
 - lib/autotuner.rb
 - lib/autotuner/configuration.rb
 - lib/autotuner/data_structure/data_points.rb
@@ -92,7 +92,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/Shopify/autotuner
   source_code_uri: https://github.com/Shopify/autotuner
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -107,8 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Get suggestions to tune Ruby's garbage collector
 test_files: []