neetodeploy-autoscale 2.0.1 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e1c015830cddd642f39eaed2ce6c3ddd109c011658ffd3984f7372918b6e2b1
-  data.tar.gz: 25dd45ae42aa37ca74de6f8c632c90ddbce8e888c7eddcf707f43d36253ea1eb
+  metadata.gz: 27447ab3dd1a86114502dba20ac472fdbbc5de7c56e6d65bb9f4b5790c24a6cd
+  data.tar.gz: 8124289ad97a7ea6742af785d5c6183e2f2238faa65c7fb38a1275fe58fdeafc
 SHA512:
-  metadata.gz: 1f24c4113d719449a197b1efd48746f7a7a6fd41d5c729749d5b305558361d5ebc489641a49dd5911d29c96d1992a4faf1eaf654c24f8163c8497ad45cf0be39
-  data.tar.gz: f85fdb3f24dd9b613a31d22b49ea5058de3edb405761db01c84b84286f43274d422fb80a28984d4633e65c4cbe73d69c94bfc5b3b7ccb6a875598c41b3ab8096
+  metadata.gz: 77e3bb73219f39f717511e3b9f860daf6cbc610b26f656061312a54095c2d6d62e894c8a44027c35fff37948edcada469bf4bfc5a33ede5deec5917320a9a1e2
+  data.tar.gz: f40763ca2219295b1a64c0f76addeeb8539493be1757bdec45ef7830f6379e1b741903ae5acc3894510a37d5dfd600103b25cabfabee2e960bf441332b7fd334

data/lib/neetodeploy/autoscale/config.rb

@@ -2,10 +2,12 @@ module Neetodeploy
   class Config
     include Singleton
 
-    attr_accessor :disable_auto_scale_gem, :app_name, :metrics_server_url, :metrics_server_auth_token, :report_interval_seconds
+    attr_accessor :disable_auto_scale_gem, :disable_sidekiq_metrics, :app_name, :metrics_server_url,
+                  :metrics_server_auth_token, :report_interval_seconds
 
     def initialize
       @disable_auto_scale_gem = ENV["DISABLE_NEETO_DEPLOY_AUTOSCALE"]
+      @disable_sidekiq_metrics = ENV["DISABLE_NEETO_DEPLOY_SIDEKIQ_METRICS"]
       @app_name = ENV["NEETODEPLOY_APP_NAME"]
       @metrics_server_url = "http://nd-queue-time-exporter-web-deployment:3000/metrics"
       @metrics_server_auth_token = "K0An3O3MSyEEMTCnRd1IHgGjdGQkzy"
@@ -15,5 +17,9 @@ module Neetodeploy
     def gem_disabled?
       disable_auto_scale_gem == "true"
     end
+
+    def sidekiq_metrics_disabled?
+      disable_sidekiq_metrics == "true"
+    end
   end
 end

data/lib/neetodeploy/autoscale/rails/metrics.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "neetodeploy/autoscale/config"
+
+module Neetodeploy
+  module Rails
+    class Metrics
+      def initialize(env, config = Config.instance)
+        @config = config
+        @request_start_header = env["HTTP_X_REQUEST_START"].to_i
+        @network_time = env["puma.request_body_wait"].to_i
+      end
+
+      def ignore?
+        @config.gem_disabled?
+      end
+
+      def queue_time
+        return if @request_start_header.zero?
+
+        time_now = Time.now.to_f * 1000
+
+        queue_time = (time_now - @request_start_header).round
+        queue_time -= @network_time
+
+        queue_time.positive? ? queue_time : nil
+      end
+    end
+  end
+end

data/lib/neetodeploy/autoscale/rails/metrics_collector.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "singleton"
+require "neetodeploy/autoscale/rails/metrics_store"
+require "neetodeploy/autoscale/reporter"
+require "neetodeploy/autoscale/logger"
+
+module Neetodeploy
+  module Rails
+    class MetricsCollector
+      include Singleton
+      include NeetoDeploy::Logger
+
+      def self.start
+        instance.start! unless instance.running?
+      end
+
+      def start!
+        logger.info("Starting background worker to collect metrics")
+        @pid = Process.pid
+        start_thread_with_collector_loop
+      end
+
+      def stop!
+        @thread&.terminate
+        @thread = nil
+        @pid = nil
+      end
+
+      def running?
+        @pid == Process.pid and @thread.alive?
+      end
+
+      def start_thread_with_collector_loop(config = Config.instance)
+        @thread = Thread.new do
+          metrics_store = MetricsStore.instance
+          loop do
+            run_metrics_collection(metrics_store)
+            multiplier = 1 - (rand / 4)
+            sleep config.report_interval_seconds * multiplier
+          end
+        end
+      end
+
+      def run_metrics_collection(metrics_store)
+        data = metrics_store.flush
+        return if data.empty?
+
+        average_queue_time = data.sum / data.size
+        Reporter.new(average_queue_time, "queue_time", "web").report
+      end
+    end
+  end
+end

data/lib/neetodeploy/autoscale/rails/metrics_store.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+module Neetodeploy
+  module Rails
+    class MetricsStore
+      include Singleton
+
+      attr_reader :metrics
+
+      def initialize
+        @metrics = []
+      end
+
+      def push(queue_time)
+        @metrics << queue_time
+      end
+
+      def flush
+        result = @metrics
+        @metrics = []
+        result
+      end
+    end
+  end
+end

data/lib/neetodeploy/autoscale/rails/middleware.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "time"
+require "neetodeploy/autoscale/rails/metrics"
+require "neetodeploy/autoscale/rails/metrics_store"
+require "neetodeploy/autoscale/rails/metrics_collector"
+
+module Neetodeploy
+  module Rails
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        metrics = Metrics.new(env)
+        queue_time = metrics.queue_time unless metrics.ignore?
+        MetricsCollector.start
+
+        if queue_time
+          store = MetricsStore.instance
+          store.push queue_time
+        end
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/neetodeploy/autoscale/rails/railtie.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "neetodeploy/autoscale/rails/middleware"
+module Neetodeploy
+  module Rails
+    class Railtie < ::Rails::Railtie
+      initializer "neetodeploy.Neetodeploy.middleware" do |app|
+        app.middleware.insert_before Rack::Runtime, Neetodeploy::Rails::Middleware
+      end
+
+      config.after_initialize do
+        Neetodeploy::Rails::MetricsCollector.start
+      end
+
+    end
+  end
+end

data/lib/neetodeploy/autoscale/rails.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "neetodeploy/autoscale/rails/metrics"
+require "neetodeploy/autoscale/rails/metrics_store"
+require "neetodeploy/autoscale/rails/metrics_collector"
+require "neetodeploy/autoscale/rails/middleware"
+require "neetodeploy/autoscale/rails/railtie"

data/lib/neetodeploy/autoscale/reporter.rb

@@ -3,19 +3,41 @@
 require "net/http"
 require "time"
 require "neetodeploy/autoscale/config"
+require "neetodeploy/autoscale/logger"
 
 module Neetodeploy
   class Reporter
+    include NeetoDeploy::Logger
 
-    def initialize(queue_time, config = Config.instance )
+    def initialize(queue_time, metric_name, process_type, queue_name = nil, config = Config.instance)
       @queue_time = queue_time.to_i
       @config = config
+      @metric_name = metric_name
+      @queue_name = queue_name
+      @process_type = process_type
     end
 
     def report
-      url = URI.parse(@config.metrics_server_url)
-      url.query = URI.encode_www_form(app_name: @config.app_name, process_type: "web", queue_time: @queue_time)
+      params = common_params
+      params[:queue_name] = @queue_name if @queue_name
+      url = build_url(params)
+      logger.info("Reporting average queue time for #{@process_type} dyno: #{@queue_time}")
 
+      post_request(url)
+    end
+
+    private
+
+    def common_params
+      {
+        app_name: @config.app_name,
+        queue_time: @queue_time,
+        metric_name: @metric_name,
+        process_type: @process_type
+      }
+    end
+
+    def post_request(url)
       post = Net::HTTP::Post.new(url)
       post["AuthToken"] = @config.metrics_server_auth_token
 
@@ -23,5 +45,12 @@ module Neetodeploy
         http.request(post)
       end
     end
+
+    def build_url(params = {})
+      exporter_url = URI.parse(@config.metrics_server_url)
+      exporter_url.query = URI.encode_www_form(params)
+
+      exporter_url
+    end
   end
 end

data/lib/neetodeploy/autoscale/sidekiq/metrics_collector.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "singleton"
+require "neetodeploy/autoscale/reporter"
+require "neetodeploy/autoscale/logger"
+require "neetodeploy/autoscale/config"
+require "sidekiq/api"
+
+module Neetodeploy
+  module Sidekiq
+    class MetricsCollector
+      include Singleton
+      include NeetoDeploy::Logger
+
+      def self.start
+        instance.start! unless instance.running?
+      end
+
+      def start!
+        logger.info("Starting Sidekiq metrics collector")
+        @pid = Process.pid
+        start_thread_with_collector_loop
+      end
+
+      def stop!
+        @pid = nil # Set pid to nil first to prevent restart
+        @thread&.terminate
+        @thread = nil
+      end
+
+      def running?
+        @pid == Process.pid and @thread&.alive?
+      end
+
+      def start_thread_with_collector_loop(config = Config.instance)
+        @thread = Thread.new do
+          loop do
+            run_sidekiq_metrics_collection
+            multiplier = 1 - (rand / 4)
+            sleep config.report_interval_seconds * multiplier
+          end
+        rescue StandardError => e
+          logger.error("Sidekiq metrics collector thread terminated with error: #{e.message}")
+          logger.error(e.backtrace.join("\n")) if e.backtrace
+        ensure
+          if @pid == Process.pid && !@thread.nil?
+            logger.info("Restarting Sidekiq metrics collector thread")
+            sleep(5)
+            start_thread_with_collector_loop
+          end
+        end
+      end
+
+      def run_sidekiq_metrics_collection
+        return unless sidekiq_available?
+        return if Config.instance.sidekiq_metrics_disabled?
+
+        begin
+          queues = ::Sidekiq::Queue.all
+          return if queues.empty?
+
+          queues.each do |queue|
+            collect_queue_metrics(queue)
+          end
+        rescue StandardError => e
+          logger.error("Error collecting Sidekiq metrics: #{e.message}")
+        end
+      end
+
+      private
+
+      def sidekiq_available?
+        defined?(::Sidekiq) && ::Sidekiq.respond_to?(:redis)
+      end
+
+      def collect_queue_metrics(queue)
+        queue_name = queue.name
+        latency_ms = (queue.latency * 1000).ceil
+
+        report_sidekiq_metric(queue_name, latency_ms)
+      end
+
+      def report_sidekiq_metric(queue_name, queue_time)
+        Reporter.new(queue_time, "sidekiq_queue_time", "worker", queue_name).report
+      end
+    end
+  end
+end

data/lib/neetodeploy/autoscale/sidekiq.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "neetodeploy/autoscale/sidekiq/metrics_collector"

data/lib/neetodeploy/autoscale/version.rb

@@ -2,6 +2,6 @@
 
 module Neetodeploy
   module Autoscale
-    VERSION = "2.0.1"
+    VERSION = "2.0.3"
   end
 end

data/lib/neetodeploy-autoscale.rb

@@ -9,29 +9,66 @@ module Neetodeploy
 
     class << self
       include NeetoDeploy::Logger
-      
-      def setup_middleware
+
+      def setup_rails_middleware
         Neetodeploy::Autoscale.setup_rails if defined? Rails
       end
 
       def setup_rails
-        require "neetodeploy/autoscale/railtie"
+        require "neetodeploy/autoscale/rails"
+      end
+
+      def setup_sidekiq_metrics
+        require "neetodeploy/autoscale/sidekiq"
+
+        ::Sidekiq.configure_server do
+          Neetodeploy::Sidekiq::MetricsCollector.start
+        end
       end
 
       def enable_middleware?
-        ENV["NEETODEPLOY_APP_NAME"].present? && ENV["DISABLE_NEETO_DEPLOY_AUTOSCALE"] != "true"
+        ENV["DISABLE_NEETO_DEPLOY_AUTOSCALE"] != "true" && in_rails_server?
       end
 
-      def initialize_if_enabled
+      def enable_sidekiq_metrics?
+        ENV["DISABLE_NEETO_DEPLOY_SIDEKIQ_METRICS"] != "true" && defined?(::Sidekiq) && Sidekiq.server?
+      end
+
+      def initialize_rails_middleware
         if enable_middleware?
-          logger.info("Setting up Neetodeploy autoscale middleware")
-          setup_middleware
+          logger.info("Setting up Neetodeploy rails autoscale middleware")
+          setup_rails_middleware
         else
-          logger.info("Conditions not met skipping NeetoDeploy autoscale middleware setup")
+          logger.info("Skipping NeetoDeploy rails autoscale middleware")
         end
       end
+
+      def initialize_sidekiq_metrics
+        if enable_sidekiq_metrics?
+          logger.info("Setting up Neetodeploy Sidekiq metrics middleware")
+          setup_sidekiq_metrics
+        else
+          logger.info("Skipping NeetoDeploy Sidekiq metrics middleware")
+        end
+      end
+
+      def initialize_middlewares
+        return unless ENV["NEETODEPLOY_APP_NAME"].present?
+
+        initialize_rails_middleware
+        initialize_sidekiq_metrics
+      end
+
+      def in_rails_server?
+        # FIX ME: This is a gross way to detect if we're in a Rails server.
+        caller_keywords = %w[rails puma unicorn]
+        in_console = caller.any? { |call| call.include?("console_command.rb") || call.include?("runner_command.rb") }
+        is_rails = caller_keywords.any? { |key| File.basename($0).include?(key) }
+        !in_console && is_rails
+      end
+
     end
   end
 end
 
-Neetodeploy::Autoscale.initialize_if_enabled
+Neetodeploy::Autoscale.initialize_middlewares

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neetodeploy-autoscale
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.3
 platform: ruby
 authors:
 - Sreeram Venkitesh
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-19 00:00:00.000000000 Z
+date: 2025-09-23 00:00:00.000000000 Z
 dependencies: []
 description: For automatically scaling your Rails application based on network metrics
 email:
@@ -25,12 +25,15 @@ files:
 - lib/neetodeploy-autoscale.rb
 - lib/neetodeploy/autoscale/config.rb
 - lib/neetodeploy/autoscale/logger.rb
-- lib/neetodeploy/autoscale/metrics.rb
-- lib/neetodeploy/autoscale/metrics_collector.rb
-- lib/neetodeploy/autoscale/metrics_store.rb
-- lib/neetodeploy/autoscale/middleware.rb
-- lib/neetodeploy/autoscale/railtie.rb
+- lib/neetodeploy/autoscale/rails.rb
+- lib/neetodeploy/autoscale/rails/metrics.rb
+- lib/neetodeploy/autoscale/rails/metrics_collector.rb
+- lib/neetodeploy/autoscale/rails/metrics_store.rb
+- lib/neetodeploy/autoscale/rails/middleware.rb
+- lib/neetodeploy/autoscale/rails/railtie.rb
 - lib/neetodeploy/autoscale/reporter.rb
+- lib/neetodeploy/autoscale/sidekiq.rb
+- lib/neetodeploy/autoscale/sidekiq/metrics_collector.rb
 - lib/neetodeploy/autoscale/version.rb
 homepage: https://neetodeploy.com
 licenses: []
@@ -53,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: neetoDeploy autoscaler gem

data/lib/neetodeploy/autoscale/metrics.rb

@@ -1,26 +0,0 @@
-require "neetodeploy/autoscale/config"
-
-module Neetodeploy
-  class Metrics
-    def initialize(env, config = Config.instance)
-      @config = config
-      @request_start_header = env["HTTP_X_REQUEST_START"].to_i
-      @network_time = env["puma.request_body_wait"].to_i
-    end
-
-    def ignore?
-      @config.gem_disabled?
-    end
-
-    def queue_time
-      return if @request_start_header.zero?
-
-      time_now = Time.now.to_f * 1000
-
-      queue_time = (time_now - @request_start_header).round
-      queue_time -= @network_time
-
-      queue_time.positive? ? queue_time : nil
-    end
-  end
-end

data/lib/neetodeploy/autoscale/metrics_collector.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require "singleton"
-require "neetodeploy/autoscale/metrics_store"
-require "neetodeploy/autoscale/reporter"
-require "neetodeploy/autoscale/logger"
-
-module Neetodeploy
-  class MetricsCollector
-    include Singleton
-    include NeetoDeploy::Logger
-
-    def self.start
-      instance.start! unless instance.running?
-    end
-
-    def start!
-      logger.info("Starting background worker to collect metrics")
-      @pid = Process.pid
-      start_thread_with_collector_loop
-    end
-
-    def stop!
-      @thread&.terminate
-      @thread = nil
-      @pid = nil
-    end
-
-    def running?
-      @pid == Process.pid and @thread.alive?
-    end
-
-    def start_thread_with_collector_loop(config = Config.instance)
-      @thread = Thread.new do
-        metrics_store = MetricsStore.instance
-        loop do
-          run_metrics_collection(metrics_store)
-          multiplier = 1 - (rand / 4)
-          sleep config.report_interval_seconds * multiplier
-        end
-      end
-    end
-
-    def run_metrics_collection(metrics_store)
-      data = metrics_store.flush
-      return if data.empty?
-
-      average_queue_time = data.sum / data.size
-      logger.info("Reporting average queue time of #{data.size} metrics: #{average_queue_time}")
-      Reporter.new(average_queue_time).report
-    end
-  end
-end

data/lib/neetodeploy/autoscale/metrics_store.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require "singleton"
-
-module Neetodeploy
-  class MetricsStore
-    include Singleton
-
-    attr_reader :metrics
-
-    def initialize
-      @metrics = []
-    end
-
-    def push(queue_time)
-      @metrics << queue_time
-    end
-
-    def flush
-      result = @metrics
-      @metrics = []
-      result
-    end
-  end
-end

data/lib/neetodeploy/autoscale/middleware.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require "net/http"
-require "time"
-require "neetodeploy/autoscale/metrics"
-require "neetodeploy/autoscale/metrics_store"
-require "neetodeploy/autoscale/metrics_collector"
-
-module Neetodeploy
-  class Middleware
-    def initialize(app)
-      @app = app
-    end
-
-    def call(env)
-      metrics = Metrics.new(env)
-      queue_time = metrics.queue_time unless metrics.ignore?
-      MetricsCollector.start
-
-      if queue_time
-        store = MetricsStore.instance
-        store.push queue_time
-      end
-
-      @app.call(env)
-    end
-  end
-end

data/lib/neetodeploy/autoscale/railtie.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require "neetodeploy/autoscale/middleware"
-module Neetodeploy
-  class Railtie < Rails::Railtie
-    initializer "neetodeploy.Neetodeploy.middleware" do |app|
-      app.middleware.insert_before Rack::Runtime, Neetodeploy::Middleware
-    end
-
-    config.after_initialize do
-      MetricsCollector.start unless in_rails_console_or_runner?
-    end
-
-    def in_rails_console_or_runner?
-      # This is gross, but we can't find a more reliable way to detect if we're in a Rails console/runner.
-      caller.any? { |call| call.include?("console_command.rb") || call.include?("runner_command.rb") }
-    end
-  end
-end