judoscale-ruby 1.4.1 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5ca5d8a39c5ebac4175cf82ee527e731b3d2ca749b54ad39c1fb7901cabbc16
-  data.tar.gz: 3b33a3243e86bafbbe2f4c492a426ef12c45d46b14a34953e4fd4785a5884c9d
+  metadata.gz: 34e63423106d499e2a555bf9343d38224e1eeb1e4f2fa2177d532ff33df3de81
+  data.tar.gz: 7efed4c6de8f587dac09c10ede982a67f73aba88e6ffeb3275db19dc968f1df7
 SHA512:
-  metadata.gz: 4fcb9704f24d532eda30e5c464428ae52bcdc1d41627da9c1d3408d9a04e099206c74d90c45456c676f33661805fa469cfa250313fbde9fce9fae6a2897ae75e
-  data.tar.gz: f7a8c075e63febeb03473ddeb4f3c6601916ff4208bfd5d5cf69f90056291d9fea7d2d3b7cc6fbadb6ce0db43958a751f6ad1f7fefd4f596c5ae38b208199567
+  metadata.gz: 2858316d5ec92aaca9b448a30699fb64dae7a970a97bf3bd4e54437d5ed5877782efd2b2c698e7c45e5f1c122b652c6463d26e98349c248cf580869bea974aa6
+  data.tar.gz: 659d23cad27612aff9c3653890758a40a315eaea4e3d319cbb0d36ada38568a00168e13601220ef06dcec7ed49dec325accd1fb844924665e031d7e32bfd4fa4

data/Gemfile

@@ -4,5 +4,6 @@ gemspec name: "judoscale-ruby"
 
 gem "rake", ">= 12.3.3"
 gem "minitest"
+gem "minitest-stub-const"
 gem "webmock"
 gem "debug"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    judoscale-ruby (1.4.1)
+    judoscale-ruby (1.5.1)
 
 GEM
   remote: https://rubygems.org/
@@ -18,6 +18,7 @@ GEM
     irb (1.6.2)
       reline (>= 0.3.0)
     minitest (5.17.0)
+    minitest-stub-const (0.6)
     public_suffix (5.0.1)
     rake (13.0.6)
     reline (0.3.2)
@@ -31,6 +32,7 @@ GEM
 PLATFORMS
   arm64-darwin-20
   arm64-darwin-21
+  arm64-darwin-22
   x86_64-darwin-21
   x86_64-linux
 
@@ -38,6 +40,7 @@ DEPENDENCIES
   debug
   judoscale-ruby!
   minitest
+  minitest-stub-const
   rake (>= 12.3.3)
   webmock
 

data/lib/judoscale/config.rb

@@ -5,35 +5,14 @@ require "logger"
 
 module Judoscale
   class Config
-    class RuntimeContainer
-      # E.g.:
-      # (Heroku) => "worker_fast", "3"
-      # (Render) => "srv-cfa1es5a49987h4vcvfg", "5497f74465-m5wwr", "web" (or "worker", "pserv", "cron", "static")
-      def initialize(service_name = nil, instance = nil, service_type = nil)
-        @service_name = service_name
-        @instance = instance
-        @service_type = service_type
-      end
-
-      def to_s
-        # heroku: 'worker_fast.5'
-        # render: 'srv-cfa1es5a49987h4vcvfg.5497f74465-m5wwr'
-        "#{@service_name}.#{@instance}"
-      end
-
-      def web?
-        # NOTE: Heroku isolates 'web' as the required _name_ for its web process
-        # type, Render exposes the actual service type more explicitly
-        @service_name == "web" || @service_type == "web"
-      end
-
+    class RuntimeContainer < String
       # Since Heroku exposes ordinal dyno 'numbers', we can tell if the current
       # instance is redundant (and thus skip collecting some metrics sometimes)
       # We don't have a means of determining that on Render though — so every
       # instance must be considered non-redundant
       def redundant_instance?
-        instance_is_number = Integer(@instance, exception: false)
-        instance_is_number && instance_is_number != 1
+        instance_number = split(".")[1].to_i
+        instance_number > 1
       end
     end
 
@@ -86,7 +65,7 @@ module Judoscale
     end
 
     attr_accessor :api_base_url, :report_interval_seconds,
-      :max_request_size_bytes, :logger, :log_tag, :current_runtime_container
+      :max_request_size_bytes, :logger, :log_tag, :current_runtime_container, :allow_rake_tasks
     attr_reader :log_level
 
     def initialize
@@ -98,6 +77,7 @@ module Judoscale
       @log_tag = "Judoscale"
       @max_request_size_bytes = 100_000 # ignore request payloads over 100k since they skew the queue times
       @report_interval_seconds = 10
+      @allow_rake_tasks = []
 
       self.log_level = ENV["JUDOSCALE_LOG_LEVEL"] || ENV["RAILS_AUTOSCALE_LOG_LEVEL"]
       @logger = ::Logger.new($stdout)
@@ -106,14 +86,17 @@ module Judoscale
 
       if ENV["RENDER_INSTANCE_ID"]
         instance = ENV["RENDER_INSTANCE_ID"].delete_prefix(ENV["RENDER_SERVICE_ID"]).delete_prefix("-")
-        @current_runtime_container = RuntimeContainer.new ENV["RENDER_SERVICE_ID"], instance, ENV["RENDER_SERVICE_TYPE"]
-        @api_base_url ||= "https://adapter.judoscale.com/api/#{ENV["RENDER_SERVICE_ID"]}"
+        @current_runtime_container = RuntimeContainer.new instance
+        # Allow a custom API base URL to be set for Render (for testing)
+        @api_base_url ||= "https://adapter.judoscale.com/api"
+        @api_base_url += "/#{ENV["RENDER_SERVICE_ID"]}"
       elsif ENV["DYNO"]
-        service_name, instance = ENV["DYNO"].split "."
-        @current_runtime_container = RuntimeContainer.new service_name, instance
+        @current_runtime_container = RuntimeContainer.new ENV["DYNO"]
+      elsif (metadata_uri = ENV["ECS_CONTAINER_METADATA_URI"])
+        @current_runtime_container = RuntimeContainer.new(metadata_uri.split("/").last)
       else
         # unsupported platform? Don't want to leave @current_runtime_container nil though
-        @current_runtime_container = RuntimeContainer.new
+        @current_runtime_container = RuntimeContainer.new("")
       end
     end
 

data/lib/judoscale/job_metrics_collector/active_record_helper.rb

@@ -12,6 +12,12 @@ module Judoscale
         sql
       end
 
+      def self.table_exists?(table_name)
+        ::ActiveRecord::Base.connection.table_exists?(table_name)
+      rescue ActiveRecord::NoDatabaseError
+        false
+      end
+
       private
 
       def run_silently(&block)

data/lib/judoscale/job_metrics_collector.rb

@@ -9,7 +9,7 @@ module Judoscale
     include Judoscale::Logger
 
     def self.collect?(config)
-      !config.current_runtime_container.redundant_instance? && adapter_config.enabled
+      super && !config.current_runtime_container.redundant_instance? && adapter_config.enabled
     end
 
     def self.adapter_name

data/lib/judoscale/metrics_collector.rb

@@ -3,11 +3,22 @@
 module Judoscale
   class MetricsCollector
     def self.collect?(config)
-      true
+      in_rake_task = defined?(::Rake) && Rake.respond_to?(:application) && Rake.application.top_level_tasks.any?
+
+      !in_rake_task || in_whitelisted_rake_tasks?(config.allow_rake_tasks)
     end
 
     def collect
       []
     end
+
+    def self.in_whitelisted_rake_tasks?(allowed_rake_tasks)
+      # Get the tasks that were invoked from the command line.
+      tasks = Rake.application.top_level_tasks
+
+      allowed_rake_tasks.any? do |task_regex|
+        tasks.any? { |task| task =~ task_regex }
+      end
+    end
   end
 end

data/lib/judoscale/reporter.rb

@@ -20,23 +20,25 @@ module Judoscale
       @pid = Process.pid
 
       if !config.api_base_url
-        logger.debug "Reporter not started: JUDOSCALE_URL is not set"
+        logger.debug "Set api_base_url to enable metrics reporting"
         return
       end
 
-      enabled_adapters = adapters.select { |adapter|
+      enabled_adapters, skipped_adapters = adapters.partition { |adapter|
+        # judoscale-ruby adapter does not have a metrics collector
         adapter.metrics_collector.nil? || adapter.metrics_collector.collect?(config)
       }
       metrics_collectors_classes = enabled_adapters.map(&:metrics_collector)
       metrics_collectors_classes.compact!
 
       if metrics_collectors_classes.empty?
-        logger.debug "Reporter not started: no metrics need to be collected in this process"
+        adapters_msg = skipped_adapters.map(&:identifier).join(", ")
+        logger.debug "No metrics need to be collected (adapters: #{adapters_msg})"
         return
       end
 
       adapters_msg = enabled_adapters.map(&:identifier).join(", ")
-      logger.info "Reporter starting, will report every #{config.report_interval_seconds} seconds or so. Adapters: [#{adapters_msg}]"
+      logger.info "Reporter starting, will report every ~#{config.report_interval_seconds} seconds (adapters: #{adapters_msg})"
 
       metrics_collectors = metrics_collectors_classes.map(&:new)
 

data/lib/judoscale/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Judoscale
-  VERSION = "1.4.1"
+  VERSION = "1.5.1"
 end

data/lib/judoscale/web_metrics_collector.rb

@@ -5,12 +5,6 @@ require "judoscale/metrics_store"
 
 module Judoscale
   class WebMetricsCollector < MetricsCollector
-    # NOTE: We collect metrics on all running web processes since they
-    # all receive and handle requests independently
-    def self.collect?(config)
-      config.current_runtime_container.web?
-    end
-
     def collect
       MetricsStore.instance.flush
     end

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: judoscale-ruby
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.1
 platform: ruby
 authors:
 - Adam McCrea
 - Carlos Antonio da Silva
 - Jon Sullivan
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-04 00:00:00.000000000 Z
+date: 2023-08-09 00:00:00.000000000 Z
 dependencies: []
-description:
+description: 
 email:
 - hello@judoscale.com
 executables: []
@@ -49,7 +49,7 @@ metadata:
   documentation_uri: https://judoscale.com/docs
   changelog_uri: https://github.com/judoscale/judoscale-ruby/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/judoscale/judoscale-ruby
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -64,8 +64,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.4.10
+signing_key: 
 specification_version: 4
 summary: This gem works with the Judoscale Heroku add-on to automatically scale your
   web and worker dynos.