judoscale-ruby 1.13.3 → 1.13.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6caa0ab33b7a1b3619b550e988eac92727046cf876aabcd3cb9a6c936c13a44c
-  data.tar.gz: bb5928ffa44bd5c2becf32672f310ec128eb90d20fed6dee870cae5d37113d4e
+  metadata.gz: a9bf6350ab170b86f70461084c4e22bc462826e58c83811ba00068050f6677d8
+  data.tar.gz: 0ddbfb24c27cce98a0ce7cc4e24af1a0df7733e92a06010023643dad2b25bed9
 SHA512:
-  metadata.gz: 836a7c518ea2c42148c2698a847fe1b3a5c7cb48131f06c0686fa764ce590010a517ae1dc4934cd2017a9d9c4097416487965e068320c15426ffe6dc58d0e9da
-  data.tar.gz: 7152b6fbf6a409307363516da0635c540d16e2f52b489c8e259ec3a3b60994c70340ae6aa75e6cfa68c678a95ee0a961517506aad768a037f0cefcc4950fa933
+  metadata.gz: 14f1dee46bbf8f676500f6c9674aabb876e69e3dd18305eb420813a8ee0b72d86f8e084ac788d9b38879c46a972ccc16a8207057052d7068e748ab0899213d4f
+  data.tar.gz: 770ccd3b9725fea1dcff4dfe7d2bbacdda6ec843252dbc42f3e8c30863889550bcc0040781310223ef58d85f757bff84b7d2d14baa9ca7ef70d8c58bb85b0262

data/lib/judoscale/config.rb

@@ -2,21 +2,10 @@
 
 require "singleton"
 require "logger"
+require "judoscale/platform"
 
 module Judoscale
   class Config
-    class RuntimeContainer < String
-      # Job metrics are collected from a single container per process type when we
-      # can identify the ordinal instance (Heroku "web.2", Scalingo "web-2").
-      # Opaque IDs (Render, ECS, Railway, etc.) are always non-redundant.
-      ORDINAL_CONTAINER = /\A[a-z_]+[.-](\d{1,3})\z/
-
-      def redundant_instance?
-        match = match(ORDINAL_CONTAINER)
-        match ? match[1].to_i > 1 : false
-      end
-    end
-
     class JobAdapterConfig
       UUID_REGEXP = /[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}/
       DEFAULT_QUEUE_FILTER = ->(queue_name) { !UUID_REGEXP.match?(queue_name) }
@@ -90,7 +79,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_platform
     attr_reader :log_level
 
     def initialize
@@ -108,31 +97,9 @@ module Judoscale
 
       self.class.adapter_configs.each(&:reset)
 
-      @current_runtime_container =
-        if ENV.include?("JUDOSCALE_CONTAINER")
-          RuntimeContainer.new ENV["JUDOSCALE_CONTAINER"]
-        elsif ENV.include?("DYNO")
-          RuntimeContainer.new ENV["DYNO"]
-        elsif ENV.include?("RENDER_INSTANCE_ID")
-          # Deprecated API url using the service ID for legacy render services not using `JUDOSCALE_URL`.
-          @api_base_url ||= "https://adapter.judoscale.com/api/#{ENV["RENDER_SERVICE_ID"]}"
-
-          instance = ENV["RENDER_INSTANCE_ID"].delete_prefix("#{ENV["RENDER_SERVICE_ID"]}-")
-          RuntimeContainer.new instance
-        elsif ENV.include?("ECS_CONTAINER_METADATA_URI")
-          instance = ENV["ECS_CONTAINER_METADATA_URI"].split("/").last
-          RuntimeContainer.new instance
-        elsif ENV.include?("FLY_MACHINE_ID")
-          RuntimeContainer.new ENV["FLY_MACHINE_ID"]
-        elsif ENV.include?("RAILWAY_REPLICA_ID")
-          RuntimeContainer.new ENV["RAILWAY_REPLICA_ID"]
-        elsif ENV.include?("CONTAINER")
-          # Scalingo exposes the container type and index (e.g. "web-1") via CONTAINER.
-          RuntimeContainer.new ENV["CONTAINER"]
-        else
-          # Unsupported platform...
-          RuntimeContainer.new("")
-        end
+      @current_platform = Platform.detect(ENV)
+      # Legacy Render services not using JUDOSCALE_URL derive the API url from the platform.
+      @api_base_url ||= @current_platform.default_api_base_url
     end
 
     def log_level=(new_level)

data/lib/judoscale/job_metrics_collector.rb

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

data/lib/judoscale/platform.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Judoscale
+  # The hosting platform we detected from the environment. The container/instance
+  # id is just one property of the platform — behavior that only applies to
+  # certain platforms (whether an instance is a redundant member of a formation,
+  # or an ephemeral process) lives on the platform subclasses that actually have
+  # those concepts, instead of being re-derived from the shape of the container
+  # string.
+  class Platform
+    attr_reader :container
+
+    def initialize(container)
+      @container = container.to_s
+    end
+
+    # Most platforms expose opaque, non-ordinal instance ids (Render, ECS, Fly,
+    # Railway, custom), so by default no instance is redundant or ephemeral.
+    # Platforms that have those concepts override these.
+    def redundant_instance?
+      false
+    end
+
+    def ephemeral_instance?
+      false
+    end
+
+    # Platforms may contribute a default API base url when one isn't configured.
+    def default_api_base_url
+      nil
+    end
+
+    # Detect the current platform from the environment. Order matters: an explicit
+    # JUDOSCALE_CONTAINER always wins, and Unknown is the fallback.
+    def self.detect(env = ENV)
+      if env.include?("JUDOSCALE_CONTAINER")
+        Custom.new env["JUDOSCALE_CONTAINER"]
+      elsif env.include?("DYNO")
+        Heroku.new env["DYNO"]
+      elsif env.include?("RENDER_INSTANCE_ID")
+        Render.new env["RENDER_INSTANCE_ID"], service_id: env["RENDER_SERVICE_ID"]
+      elsif env.include?("ECS_CONTAINER_METADATA_URI")
+        Ecs.new env["ECS_CONTAINER_METADATA_URI"].split("/").last
+      elsif env.include?("FLY_MACHINE_ID")
+        Fly.new env["FLY_MACHINE_ID"]
+      elsif env.include?("RAILWAY_REPLICA_ID")
+        Railway.new env["RAILWAY_REPLICA_ID"]
+      elsif env.include?("CONTAINER")
+        # Scalingo exposes the container type and index (e.g. "web-1") via CONTAINER.
+        Scalingo.new env["CONTAINER"]
+      else
+        Unknown.new ""
+      end
+    end
+
+    # Heroku dynos are named "web.2". We collect job metrics from a single
+    # container per process type, so any instance beyond the first is redundant —
+    # it would only duplicate the queue metrics the first instance already reports.
+    class Heroku < Platform
+      def redundant_instance?
+        match = container.match(/\A[a-z_]+\.(\d+)\z/)
+        match ? match[1].to_i > 1 : false
+      end
+
+      # Heroku release phase and one-off dynos are named "release.1234" and "run.1234".
+      def ephemeral_instance?
+        normalized_container = container.downcase
+        normalized_container.start_with?("release.", "run.")
+      end
+    end
+
+    # Scalingo containers are named "web-2", same redundancy rule as Heroku.
+    class Scalingo < Platform
+      def redundant_instance?
+        match = container.match(/\A[a-z_]+-(\d+)\z/)
+        match ? match[1].to_i > 1 : false
+      end
+
+      # Scalingo one-off containers are named "one-off-1234".
+      def ephemeral_instance?
+        container.start_with?("one-off-")
+      end
+    end
+
+    class Render < Platform
+      def initialize(instance_id, service_id:)
+        @service_id = service_id
+        # Render prefixes the instance id with the service id, which isn't part of the instance.
+        super(instance_id.delete_prefix("#{service_id}-"))
+      end
+
+      # Legacy Render services not using JUDOSCALE_URL derive the adapter URL
+      # from the service id.
+      def default_api_base_url
+        "https://adapter.judoscale.com/api/#{@service_id}"
+      end
+    end
+
+    class Ecs < Platform
+    end
+
+    class Fly < Platform
+    end
+
+    class Railway < Platform
+    end
+
+    # User-provided container id via JUDOSCALE_CONTAINER.
+    class Custom < Platform
+    end
+
+    # Unsupported or undetected platform.
+    class Unknown < Platform
+    end
+  end
+end

data/lib/judoscale/report.rb

@@ -12,7 +12,7 @@ module Judoscale
 
     def as_json
       {
-        container: config.current_runtime_container,
+        container: config.current_platform.container,
         pid: Process.pid,
         config: config.as_json,
         adapters: adapters.reduce({}) { |hash, adapter| hash.merge!(adapter.as_json) },

data/lib/judoscale/reporter.rb

@@ -19,6 +19,11 @@ module Judoscale
     def start!(config, adapters)
       @pid = Process.pid
 
+      if config.current_platform.ephemeral_instance?
+        logger.debug "Reporter not started: in an ephemeral container"
+        return
+      end
+
       if config.api_base_url.nil? || config.api_base_url.strip.empty?
         logger.debug "Set api_base_url to enable metrics reporting"
         return

data/lib/judoscale/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: judoscale-ruby
 version: !ruby/object:Gem::Version
-  version: 1.13.3
+  version: 1.13.4
 platform: ruby
 authors:
 - Adam McCrea
@@ -40,6 +40,7 @@ files:
 - lib/judoscale/metric.rb
 - lib/judoscale/metrics_collector.rb
 - lib/judoscale/metrics_store.rb
+- lib/judoscale/platform.rb
 - lib/judoscale/report.rb
 - lib/judoscale/reporter.rb
 - lib/judoscale/request_metrics.rb