autotuner 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6aa488d0dd08183c2fb01c791f8c6348161e5c986ac3a77d2e70b395823330aa
-  data.tar.gz: 205b668f35e3abe8c52bd0cd84438dad052efa9d26432ec86b19170f0c487e3c
+  metadata.gz: 2110ae589a151476ac745ec4767d13e3146c890df830108745dc077c64f79f50
+  data.tar.gz: cea9ce8c687ae32214f41b65466e110abdab8bb00e1aab0596c9d787b510b496
 SHA512:
-  metadata.gz: 5bc44e43c8851f850dfc542b9004ebdcb3f446036d0064947006815867bb9a4ad9502d2db0dd41fcfdebd68bf100d359a1537ed81b9e5147d936e0219a1fa8c5
-  data.tar.gz: 706cc7f127c5004e6dc8473531b5a305809e6eab762481b3f0bbf48571668bd807d2388e4d2a621d63bdb1e0ca5972848b61175707a3b01b13888bb0bee885ba
+  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.1)
+    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/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/gc_compact.rb

@@ -31,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:

data/lib/autotuner/heuristic/heap_size_warmup.rb

@@ -97,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

@@ -65,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

@@ -64,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

@@ -62,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/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/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: autotuner
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Peter Zhu
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-26 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: []