autotuner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3224324bc9bd16905431bdb2e97bc121eb6902945e3b8fcdc4d65037d8805670
+  data.tar.gz: 064b353800288f8b2342926a01b8bcc1bbfdfa58624b317c1b3deca3e9092629
+SHA512:
+  metadata.gz: 6d3ece545d282a2bebe07e35fc4ef280d4f262a0976a0ab92ec852abd2a1e7d0e9cf9ea0ef517372df69d4930e0ef40a00925665765cbc5c92db962df8beba70
+  data.tar.gz: 1d30e3154fa03d204b9c89e61ff079046519559f0c5ffa1b50451b915199217a03e0180cd66fcc1b57d17b4f0e57bd1ba7ec6bf465e640542599cf3540793b9a

data/.rubocop.yml

@@ -0,0 +1,20 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+require: rubocop-minitest
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gc_tuner.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Peter Zhu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# GcTuner
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gc_tuner`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+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/[USERNAME]/gc_tuner.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: [:test, :rubocop]

data/lib/gc_tuner/configuration.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module GCTuner
+  module Configuration
+    attr_reader :sample_ratio
+    attr_writer :enabled
+
+    def enabled?
+      @enabled
+    end
+
+    def sample_ratio=(ratio)
+      raise ArgumentError, "ratio must be between 0 and 1.0" unless (0..1.0).include?(ratio)
+
+      @sample_ratio = ratio
+
+      self.enabled = rand < ratio
+    end
+  end
+end

data/lib/gc_tuner/data_structure/data_points.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module GCTuner
+  module DataStructure
+    class DataPoints
+      STABLE_RATIO = 0.5
+
+      attr_reader :samples, :length, :compression_ratio
+
+      def initialize(capacity)
+        raise "Capacity must be even" if capacity.odd?
+
+        @samples = Array.new(capacity)
+
+        @temp_sample = 0
+        @temp_sample_count = 0
+
+        @length = 0
+        @compression_ratio = 1
+      end
+
+      def insert(value)
+        compress if @length == @samples.length
+
+        @temp_sample += value
+        @temp_sample_count += 1
+
+        return unless @temp_sample_count == @compression_ratio
+
+        @samples[@length] = @temp_sample / @temp_sample_count
+
+        @length += 1
+        @temp_sample = 0
+        @temp_sample_count = 0
+      end
+
+      def stable_region_slope
+        # Find line of best fit for the last 50%
+        range = (@length * STABLE_RATIO).to_i...@length
+
+        slope(range)
+      end
+
+      def plateaued?(delta = 0.1)
+        # Not enough data until filled
+        return false if @compression_ratio == 1
+
+        stable_region_slope.abs <= delta
+      end
+
+      def correlation(y)
+        raise "Length not equal" unless length == y.length
+        raise "Compression ratio not equal" unless compression_ratio == y.compression_ratio
+
+        # Find the correlation between this and y
+        # https://www.mathsisfun.com/data/correlation.html
+        sum_x = 0
+        sum_y = 0
+        sum_x_2 = 0
+        sum_y_2 = 0
+        sum_x_y = 0
+        length.times do |i|
+          x_val = @samples[i]
+          y_val = y.samples[i]
+
+          sum_x += x_val
+          sum_y += y_val
+          sum_x_2 += x_val**2
+          sum_y_2 += y_val**2
+          sum_x_y += x_val * y_val
+        end
+
+        ((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
+
+      def to_s
+        inspect
+      end
+
+      private
+
+      def compress
+        (@length / 2).times do |i|
+          @samples[i] = (@samples[i * 2] + @samples[i * 2 + 1]) / 2.0
+        end
+
+        @length /= 2
+        @compression_ratio *= 2
+      end
+
+      def slope(range)
+        # Find the slope for the area in range using least squares
+        # https://www.mathsisfun.com/data/least-squares-regression.html
+        sum_x = 0
+        sum_y = 0
+        sum_x_2 = 0
+        sum_x_y = 0
+        range.each do |i|
+          sum_x += i
+          sum_y += @samples[i]
+          sum_x_2 += i**2
+          sum_x_y += i * @samples[i]
+        end
+
+        (range.size * sum_x_y - (sum_x * sum_y)).to_f / (range.size * sum_x_2 - (sum_x**2))
+      end
+    end
+  end
+end

data/lib/gc_tuner/gc_context.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module GCTuner
+  class GCContext
+    attr_reader :stat, :stat_heap
+
+    def initialize
+      @stat = GC.stat
+      @stat_heap = GC.stat_heap
+    end
+
+    def update
+      GC.stat(@stat)
+      GC.stat_heap(nil, @stat_heap)
+    end
+  end
+end

data/lib/gc_tuner/heuristic/base.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module GCTuner
+  module Heuristic
+    class Base
+      class << self
+        def enabled?
+          supported? && !@disabled
+        end
+
+        def disable!
+          @disabled = true
+        end
+
+        private
+
+        def supported?
+          raise NotImplementedError
+        end
+      end
+
+      def call(request_time, before_gc_context, after_gc_context)
+        raise NotImplementedError
+      end
+
+      def tuning_message
+        raise NotImplementedError
+      end
+
+      def debug_message
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/gc_tuner/heuristic/size_pool_warmup.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module GCTuner
+  module Heuristic
+    class SizePoolWarmup < Base
+      DATA_POINTS_COUNT = 1_000
+      SIZE_POOL_CONFIGURATION_DELTA_RATIO = 0.01
+      SIZE_POOL_CONFIGURATION_DELTA = 1
+
+      class << self
+        private
+
+        def supported?
+          # Ruby 3.3.0 and later have support RUBY_GC_HEAP_INIT_SIZE_%d_SLOTS
+          # RUBY_VERSION >= "3.3.0"
+          # TODO: use the check above
+          true
+        end
+      end
+
+      def initialize
+        super
+
+        @request_time_data = DataStructure::DataPoints.new(DATA_POINTS_COUNT)
+
+        @size_pool_count = GC::INTERNAL_CONSTANTS[:SIZE_POOL_COUNT]
+        @size_pools_data = Array.new(@size_pool_count)
+        @size_pools_tuning_configuration = Array.new(@size_pool_count)
+        @size_pool_count.times do |i|
+          @size_pools_data[i] = DataStructure::DataPoints.new(DATA_POINTS_COUNT)
+          @size_pools_tuning_configuration[i] = ENV[env_name_for_size_pool(i)].to_i
+        end
+
+        @plateaued = false
+      end
+
+      def call(request_time, _before_gc_context, after_gc_context)
+        # We only want to collect data at boot until the request time plateaus
+        return if @plateaued
+
+        insert_data(request_time, after_gc_context)
+
+        return unless @request_time_data.plateaued?
+
+        @plateaued = true
+      end
+
+      def tuning_message
+        msg = nil
+
+        if @plateaued
+          size_pool_messages = @size_pool_count.times.map do |i|
+            tuning_message_for_size_pool(i)
+          end.compact
+
+          unless size_pool_messages.empty?
+            msg = <<~MSG
+              Here are the recommended tuning values for size pools and the confidence scores.
+              Confidence scores are between 0 and 1.0 and represent the correlation between
+              the tuning value and the response time.
+
+            MSG
+
+            msg += size_pool_messages.join
+          end
+        else
+          msg = <<~MSG.chomp
+            There is not enough data and/or response times have not plateaued.
+          MSG
+        end
+
+        msg
+      end
+
+      def debug_message
+        msg = <<~MSG
+          plateaued: #{@plateaued}
+          request_time_data: #{@request_time_data}
+        MSG
+
+        @size_pools_data.each_with_index do |data, i|
+          msg += "size_pools_data[#{i}]: #{data}\n"
+        end
+
+        if @plateaued
+          msg += @size_pool_count.times.map do |i|
+            tuning_message_for_size_pool(i, debug: true)
+          end.join
+        end
+
+        msg
+      end
+
+      private
+
+      def insert_data(request_time, after_gc_context)
+        @request_time_data.insert(request_time)
+
+        @size_pools_data.each_with_index do |data, i|
+          data.insert(after_gc_context.stat_heap[i][:heap_eden_pages])
+        end
+      end
+
+      def env_name_for_size_pool(size_pool)
+        slot_size = GC::INTERNAL_CONSTANTS[:BASE_SLOT_SIZE] * (2**size_pool)
+
+        "RUBY_GC_HEAP_INIT_SIZE_#{slot_size}_SLOTS"
+      end
+
+      def tuning_message_for_size_pool(size_pool, debug: false)
+        configured_value = @size_pools_tuning_configuration[size_pool]
+
+        data = @size_pools_data[size_pool]
+        suggested_value = data.samples[data.length - 1].to_i
+
+        diff = (configured_value - suggested_value).abs
+        if debug ||
+            (diff > configured_value * SIZE_POOL_CONFIGURATION_DELTA_RATIO && diff > SIZE_POOL_CONFIGURATION_DELTA)
+          confidence = @request_time_data.correlation(data).abs
+
+          msg = ""
+          msg += "#{env_name_for_size_pool(size_pool)}=#{suggested_value} (confidence: #{format("%.2f", confidence)}"
+          msg += ", tuned value: #{configured_value}" if configured_value > 0
+          msg += ")\n"
+
+          msg
+        end
+      end
+    end
+  end
+end

data/lib/gc_tuner/heuristics.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module GCTuner
+  module Heuristics
+    HEURISTICS = [
+      Heuristic::SizePoolWarmup,
+    ].freeze
+
+    def heuristics
+      @heuristics ||= enabled_heuristics.map(&:new)
+    end
+
+    def tuning_messages
+      heuristics.map(&:tuning_message)
+    end
+
+    def debug_messages
+      heuristics.map(&:debug_message)
+    end
+
+    private
+
+    def enabled_heuristics
+      HEURISTICS.dup.keep_if(&:enabled?)
+    end
+  end
+end

data/lib/gc_tuner/rack_plugin.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module GCTuner
+  class RackPlugin
+    def initialize(app)
+      @app = app
+      @request_collector = RequestCollector.new
+    end
+
+    def call(env)
+      if GCTuner.enabled?
+        @request_collector.request do
+          @app.call(env)
+        end
+      else
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/gc_tuner/request_collector.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module GCTuner
+  class RequestCollector
+    def initialize
+      @before_gc_context = GCContext.new
+      @after_gc_context = GCContext.new
+
+      @start_time_ms = 0.0
+    end
+
+    def request
+      before_request
+
+      yield
+    ensure
+      after_request
+    end
+
+    private
+
+    def before_request
+      @before_gc_context.update
+      @start_time_ms = Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_millisecond)
+    end
+
+    def after_request
+      request_time = Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_millisecond) - @start_time_ms
+      @after_gc_context.update
+
+      GCTuner.heuristics.each do |heuristic|
+        heuristic.call(request_time, @before_gc_context, @after_gc_context)
+      end
+    end
+  end
+end

data/lib/gc_tuner/version.rb

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

data/lib/gc_tuner.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "gc_tuner/data_structure/data_points"
+
+require_relative "gc_tuner/heuristic/base"
+require_relative "gc_tuner/heuristic/size_pool_warmup"
+
+require_relative "gc_tuner/configuration"
+require_relative "gc_tuner/gc_context"
+require_relative "gc_tuner/heuristics"
+require_relative "gc_tuner/rack_plugin"
+require_relative "gc_tuner/request_collector"
+require_relative "gc_tuner/version"
+
+module GCTuner
+  extend Configuration
+  extend Heuristics
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: autotuner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Zhu
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- peter@peterzhu.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/gc_tuner.rb
+- lib/gc_tuner/configuration.rb
+- lib/gc_tuner/data_structure/data_points.rb
+- lib/gc_tuner/gc_context.rb
+- lib/gc_tuner/heuristic/base.rb
+- lib/gc_tuner/heuristic/size_pool_warmup.rb
+- lib/gc_tuner/heuristics.rb
+- lib/gc_tuner/rack_plugin.rb
+- lib/gc_tuner/request_collector.rb
+- lib/gc_tuner/version.rb
+homepage: https://github.com/Shopify/gc_tuner
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Shopify/gc_tuner
+  source_code_uri: https://github.com/Shopify/gc_tuner
+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.4.10
+signing_key:
+specification_version: 4
+summary: Get suggestions to tune Ruby's garbage collector
+test_files: []