neetodeploy-autoscale 1.0.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50af0e2a9a2c425e9f496a34540b996ba5bad120e6f0f12a4d4f97d778c5141b
-  data.tar.gz: b2dec0286ccc386f4908a7f409c14cd6c2bb6d9f81025b2164f10eb849c1c620
+  metadata.gz: 37bcdd5f87684bd29d215c8ed744b8ff6963a6a57d1af07c5ddadc407f4462d5
+  data.tar.gz: 05fac864a8cca54ac8773e6ec96773d4918961c32fdf1b27ff61049d34241c7f
 SHA512:
-  metadata.gz: 425ba48cac96eef297bb510cf960f904ec760008dca4df78c3bbaad09253f028be24ad17a50fb5729694a3a99504627defdd42a53952dfeaf39b123503a9fab3
-  data.tar.gz: 0bb779eb933fbd7eaf4edfe854b103d717c880cadecfdf4b00e8e7d3267e2995045a62c69d740c73abfa9db78ac200c9b8bd95dd82f1f5595229dae73fdba26f
+  metadata.gz: cf13f8872227a9e0685460a13cbddeab3d10f5da67c55f96bd533faddb85cb153ded05cebd523d29d83690d09317999dda2fc094aa06b9bcc9e77306bb322603
+  data.tar.gz: a8809427527fe868c571ee014b79e242379f1ee9ff432e323dfaed5b8ede759f0fd75ca67dccd610bd8c7eadfe358e3415a3f1c4c66ed2d074e1e3073f8de353

data/lib/neetodeploy/autoscale/config.rb

@@ -0,0 +1,19 @@
+module Neetodeploy
+  class Config
+    include Singleton
+
+    attr_accessor :disable_auto_scale_gem, :app_name, :metrics_server_url, :metrics_server_auth_token, :report_interval_seconds
+
+    def initialize
+      @disable_auto_scale_gem = ENV["DISABLE_NEETO_DEPLOY_AUTOSCALE"]
+      @app_name = ENV["NEETODEPLOY_APP_NAME"]
+      @metrics_server_url = "http://nd-queue-time-exporter-web-deployment:3000/metrics"
+      @metrics_server_auth_token = "K0An3O3MSyEEMTCnRd1IHgGjdGQkzy"
+      @report_interval_seconds = 10
+    end
+
+    def gem_disabled?
+      disable_auto_scale_gem == "true"
+    end
+  end
+end

data/lib/neetodeploy/autoscale/logger.rb

@@ -0,0 +1,15 @@
+require "logger"
+
+module NeetoDeploy
+  module Logger
+    def self.logger
+      @logger ||= ::Logger.new(STDOUT).tap do |log|
+        log.formatter = proc { |severity, _datetime, _progname, msg| "[neetodeploy-autoscale] #{severity}: #{msg}\n" }
+      end
+    end
+
+    def logger
+      NeetoDeploy::Logger.logger
+    end
+  end
+end

data/lib/neetodeploy/autoscale/metrics.rb

@@ -0,0 +1,26 @@
+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

@@ -0,0 +1,53 @@
+# 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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "singleton"
+require "judoscale/metric"
+require "judoscale/report"
+
+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

@@ -2,44 +2,27 @@
 
 require "net/http"
 require "time"
-require "neetodeploy/autoscale/exporter"
+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)
-      payload = URI.encode_www_form(
-        app_name: ENV.to_h["NEETODEPLOY_APP_NAME"],
-        process_type: "web",
-        queue_time: queue_time(env)
-      )
-      Neetodeploy::Exporter.export(payload)
-      @app.call(env)
-    end
+      metrics = Metrics.new(env)
+      queue_time = metrics.queue_time unless metrics.ignore?
+      MetricsCollector.start
 
-    private
-
-    def started_at(env)
-      return nil unless env["HTTP_X_REQUEST_START"].present?
-
-      env["HTTP_X_REQUEST_START"].to_i
-    end
+      if queue_time
+        store = MetricsStore.instance
+        store.push queue_time
+      end
 
-    def network_time(env)
-      env["puma.request_body_wait"].to_i
-    end
-
-    def queue_time(now = Time.now.to_f * 1000, env)
-      return if started_at(env).nil?
-
-      queue_time = (now - started_at(env)).round
-      queue_time -= network_time(env)
-
-      queue_time.positive? ? queue_time : 0
+      @app.call(env)
     end
   end
 end

data/lib/neetodeploy/autoscale/railtie.rb

@@ -1,17 +1,19 @@
 # frozen_string_literal: true
 
+require "neetodeploy/autoscale/middleware"
 module Neetodeploy
   class Railtie < Rails::Railtie
-    initializer "neetodeploy.configure_rails_initialization" do
-      insert_middleware
+    initializer "neetodeploy.Neetodeploy.middleware" do |app|
+      app.middleware.insert_before Rack::Runtime, Neetodeploy::Middleware
     end
 
-    def insert_middleware
-      Rails.application.middleware.use Neetodeploy::Middleware
+    config.after_initialize do
+      MetricsCollector.start unless in_rails_console_or_runner?
     end
 
-    def use_better_errors?
-      !Rails.env.production? and app.config.consider_all_requests_local
+    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

data/lib/neetodeploy/autoscale/reporter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "time"
+require "neetodeploy/autoscale/config"
+
+module Neetodeploy
+  class Reporter
+
+    def initialize(queue_time, config = Config.instance )
+      @queue_time = queue_time.to_i
+      @config = config
+    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)
+
+      post = Net::HTTP::Post.new(url)
+      post["AuthToken"] = @config.metrics_server_auth_token
+
+      Net::HTTP.start(url.host, url.port, use_ssl: false) do |http|
+        http.request(post)
+      end
+    end
+  end
+end

data/lib/neetodeploy/autoscale/version.rb

@@ -2,6 +2,6 @@
 
 module Neetodeploy
   module Autoscale
-    VERSION = "1.0.6"
+    VERSION = "2.0.0"
   end
 end

data/lib/neetodeploy-autoscale.rb

@@ -1,33 +1,37 @@
 # frozen_string_literal: true
 
 require_relative "neetodeploy/autoscale/version"
+require "neetodeploy/autoscale/logger"
 
 module Neetodeploy
   module Autoscale
     class Error < StandardError; end
 
     class << self
+      include NeetoDeploy::Logger
+      
       def setup_middleware
-        require "neetodeploy/autoscale/middleware"
         Neetodeploy::Autoscale.setup_rails if defined? Rails
-        Neetodeploy::Autoscale.setup_sidekiq if defined?(Sidekiq)
       end
 
       def setup_rails
         require "neetodeploy/autoscale/railtie"
       end
 
-      def setup_sidekiq
-        require "neetodeploy/autoscale/sidekiq_middleware"
+      def enable_middleware?
+        ENV["NEETODEPLOY_APP_NAME"].present? && ENV["DISABLE_NEETO_DEPLOY_AUTOSCALE"] != "true"
+      end
 
-        Sidekiq.configure_server do |config|
-          config.server_middleware do |chain|
-            chain.add Neetodeploy::SidekiqMiddleware
-          end
+      def initialize_if_enabled
+        if enable_middleware?
+          logger.info("Setting up Neetodeploy autoscale middleware")
+          setup_middleware
+        else
+          logger.info("Conditions not met skipping NeetoDeploy autoscale middleware setup")
         end
       end
     end
   end
 end
 
-ENV.to_h["NEETODEPLOY_APP_NAME"].present? && Neetodeploy::Autoscale.setup_middleware
+Neetodeploy::Autoscale.initialize_if_enabled

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neetodeploy-autoscale
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 2.0.0
 platform: ruby
 authors:
 - Sreeram Venkitesh
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-17 00:00:00.000000000 Z
+date: 2025-03-19 00:00:00.000000000 Z
 dependencies: []
 description: For automatically scaling your Rails application based on network metrics
 email:
@@ -23,10 +23,14 @@ files:
 - README.md
 - Rakefile
 - lib/neetodeploy-autoscale.rb
-- lib/neetodeploy/autoscale/exporter.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/sidekiq_middleware.rb
+- lib/neetodeploy/autoscale/reporter.rb
 - lib/neetodeploy/autoscale/version.rb
 homepage: https://neetodeploy.com
 licenses: []

data/lib/neetodeploy/autoscale/exporter.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require "net/http"
-require "time"
-
-module Neetodeploy
-  class Exporter
-    def self.export(payload)
-      Thread.new do
-        url = URI.parse("http://nd-queue-time-exporter-web-deployment:3000/metrics")
-        url.query = payload
-        post = Net::HTTP::Post.new(url)
-        post["AuthToken"] = "K0An3O3MSyEEMTCnRd1IHgGjdGQkzy"
-
-        Net::HTTP.start(url.host, url.port, use_ssl: false) do |http|
-          http.request(post)
-        end
-      end
-    end
-  end
-end

data/lib/neetodeploy/autoscale/sidekiq_middleware.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require "net/http"
-require "time"
-
-module Neetodeploy
-  class SidekiqMiddleware
-    def call(worker, job, queue)
-      url = URI.parse("http://nd-queue-time-exporter-web-deployment:3000/metrics")
-
-      queues_by_name = ::Sidekiq::Queue.all.each_with_object({}) do |queue_name, obj|
-        obj[queue_name.name] = queue_name
-      end
-
-      queues = queues_by_name.keys
-
-      queues.each do |queue_obj|
-        queue = queues_by_name.fetch(queue_obj) { |name| ::Sidekiq::Queue.new(name) }
-
-        query_params = URI.encode_www_form(app_name: ENV.to_h["NEETODEPLOY_APP_NAME"], process_type: "worker", queue_name: queue_obj, queue_time: queue_time(queue))
-        url.query = query_params
-        post = Net::HTTP::Post.new(url)
-        post["AuthToken"] = "K0An3O3MSyEEMTCnRd1IHgGjdGQkzy"
-
-        begin
-          Net::HTTP.start(url.host, url.port, use_ssl: false) do |http|
-            http.request(post)
-          end
-        rescue => e
-          puts "Exception in sending post request to exporter from Sidekiq process: #{e.message}"
-        end
-      end
-
-      yield
-    end
-
-    private
-
-    def queues
-      ::Sidekiq::Queue.all
-    end
-
-    def queue_time(queue_obj)
-      queue = ::Sidekiq::Queue.new(queue_obj.name)
-
-      (queue.latency * 1000).ceil
-    end
-  end
-end