rails_autoscale_agent 0.10.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed5e9567b63e205a9477e80cb3b1cb5d0d198f60288957c8560eb988f0ab5322
-  data.tar.gz: 0ff58213c0347a71218c668fbcea5f3bae8e6e24701b7c9ce3317d84dfce8ef7
+  metadata.gz: 36f5471f01400a8db00951513b7387150c370c92ed968b1e2aea3c752e4e5006
+  data.tar.gz: a113b0ca9936451db2a05aa3c0792f100938baf4c036f1f87100ef991155d880
 SHA512:
-  metadata.gz: 3da81efface83a93ac9c3676b7edbcaf431911cfe428c054a39203663048bc7a320ebd6881606d7b18e563c145d8fcfc1cd6d3acf945bff82525195796f1be96
-  data.tar.gz: a4012e4ab5876cddb28bfea34a2b71d6239c34dc5b167cb54616e5635a67d36915245c2b96bc536256ee7109640db6a035d0b5b99bfa20fab76a88900aba6f3f
+  metadata.gz: aa7ef93dbcb9ab8341b2d7f313428c6bf75908f0e5db40987463f811f33c9577c99e404dad94e423cd752bd31edb1196bfa41b7ec5ec3c5841c917deaf53b09c
+  data.tar.gz: 59893c8b34924505d1d954a60422b7e3c81feec1933616ccee1a6f717f696e8263397f2b95b178c9c340831e5e4fb469310efe92739751489c32c5759514d5f4

data/CHANGELOG.md

@@ -1,9 +1,21 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/adamlogic/rails_autoscale_agent/compare/v0.10.1...master)
+## [Unreleased](https://github.com/adamlogic/rails_autoscale_agent/compare/v0.11.0...master)
 
-_There are no currently unreleased changes._
+No currently unreleased changes.
+
+## [0.11.0](https://github.com/adamlogic/rails_autoscale_agent/compare/v0.10.2...v0.11.0)
+
+### Added
+
+- Add `RAILS_AUTOSCALE_MAX_QUEUES` config option. ([28738a5](https://github.com/adamlogic/rails_autoscale_agent/commit/28738a5dc4cd6b0a46e77459d6f98e6b33072da9))
+
+## [0.10.2](https://github.com/adamlogic/rails_autoscale_agent/compare/v0.10.1...v0.10.2) - 2021-01-12
+
+### Changed
+
+- Loosen Ruby constraint to allow Ruby 3. ([#36](https://github.com/adamlogic/rails_autoscale_agent/pull/36))
 
 ## [0.10.1](https://github.com/adamlogic/rails_autoscale_agent/compare/v0.9.1...v0.10.1) - 2021-01-03
 

data/README.md

@@ -6,7 +6,8 @@ This gem works together with the [Rails Autoscale](https://railsautoscale.com) H
 
 ## Requirements
 
-Tested with Rails versions 3.2 and higher and Ruby versions 1.9.3 and higher.
+- Rack-based app
+- Ruby 2.5 or newer
 
 ## Getting Started
 
@@ -42,8 +43,9 @@ Rails Autoscale aggregates and stores this information to power the autoscaling
 Most Rails Autoscale configurations are handled via the settings page on your Rails Autoscale dashboard, but there a few ways you can directly change the behavior of the agent via environment variables:
 
 - `RAILS_AUTOSCALE_DEBUG` - Enables debug logging. See more in the [logging](#logging) section below.
-- `RAILS_AUTOSCALE_WORKER_ADAPTER` - Overrides the available worker adapters. See more in the [worker adapters](#worker_adapters) section below.
+- `RAILS_AUTOSCALE_WORKER_ADAPTER` - Overrides the available worker adapters. See more in the [worker adapters](#worker-adapters) section below.
 - `RAILS_AUTOSCALE_LONG_JOBS` - Enables reporting for active workers. See [Handling Long-Running Background Jobs](https://railsautoscale.com/docs/long-running-jobs/) in the Rails Autoscale docs for more.
+- `RAILS_AUTOSCALE_MAX_QUEUES` - Worker metrics will only report up to 50 queues by default. If you have more than 50 queues, you'll need to configure this settings or reduce your number of queues.
 
 ## Worker adapters
 

data/lib/rails_autoscale_agent/config.rb

@@ -10,7 +10,7 @@ module RailsAutoscaleAgent
 
     attr_accessor :report_interval, :logger, :api_base_url, :max_request_size,
                   :dyno, :addon_name, :worker_adapters, :dev_mode, :debug, :quiet,
-                  :track_long_running_jobs,
+                  :track_long_running_jobs, :max_queues,
 
                   # legacy configs, no longer used
                   :sidekiq_latency_for_active_jobs, :latency_for_active_jobs
@@ -24,6 +24,7 @@ module RailsAutoscaleAgent
       @dev_mode = ENV['RAILS_AUTOSCALE_DEV'] == 'true'
       @debug = dev_mode? || ENV['RAILS_AUTOSCALE_DEBUG'] == 'true'
       @track_long_running_jobs = ENV['RAILS_AUTOSCALE_LONG_JOBS'] == 'true'
+      @max_queues = ENV.fetch('RAILS_AUTOSCALE_MAX_QUEUES', 50).to_i
       @max_request_size = 100_000 # ignore request payloads over 100k since they skew the queue times
       @report_interval = 10 # this default will be overwritten during Reporter#register!
       @logger ||= defined?(Rails) ? Rails.logger : ::Logger.new(STDOUT)

data/lib/rails_autoscale_agent/reporter.rb

@@ -6,8 +6,6 @@ require 'rails_autoscale_agent/autoscale_api'
 require 'rails_autoscale_agent/time_rounder'
 require 'rails_autoscale_agent/registration'
 
-# Reporter wakes up every minute to send metrics to the RailsAutoscale API
-
 module RailsAutoscaleAgent
   class Reporter
     include Singleton
@@ -56,20 +54,16 @@ module RailsAutoscaleAgent
     def report!(config, store)
       report = store.pop_report
 
-      if report.measurements.any?
-        logger.info "Reporting #{report.measurements.size} measurements"
+      logger.info "Reporting #{report.measurements.size} measurements"
 
-        params = report.to_params(config)
-        result = AutoscaleApi.new(config).report_metrics!(params, report.to_csv)
+      params = report.to_params(config)
+      result = AutoscaleApi.new(config).report_metrics!(params, report.to_csv)
 
-        case result
-        when AutoscaleApi::SuccessResponse
-          logger.debug "Reported successfully"
-        when AutoscaleApi::FailureResponse
-          logger.error "Reporter failed: #{result.failure_message}"
-        end
-      else
-        logger.debug "Reporter has nothing to report"
+      case result
+      when AutoscaleApi::SuccessResponse
+        logger.debug "Reported successfully"
+      when AutoscaleApi::FailureResponse
+        logger.error "Reporter failed: #{result.failure_message}"
       end
     end
 
@@ -84,6 +78,7 @@ module RailsAutoscaleAgent
         config.max_request_size = result.data['max_request_size'] if result.data['max_request_size']
         worker_adapters_msg = worker_adapters.map { |a| a.class.name }.join(', ')
         logger.info "Reporter starting, will report every #{config.report_interval} seconds or so. Worker adapters: [#{worker_adapters_msg}]"
+        logger.warn "[DEPRECATION WARNING] rails_autoscale_agent is no longer maintained. Please switch to rails-autoscale-web as soon as possible."
       when AutoscaleApi::FailureResponse
         logger.error "Reporter failed to register: #{result.failure_message}"
       end

data/lib/rails_autoscale_agent/store.rb

@@ -13,6 +13,7 @@ module RailsAutoscaleAgent
 
     def initialize
       @measurements = []
+      @last_pop = Time.now
     end
 
     def push(value, time = Time.now, queue_name = nil, metric = nil)

data/lib/rails_autoscale_agent/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsAutoscaleAgent
-  VERSION = "0.10.1"
+  VERSION = "0.12.0"
 end

data/lib/rails_autoscale_agent/worker_adapters/delayed_job.rb

@@ -12,7 +12,7 @@ module RailsAutoscaleAgent
 
       def enabled?
         if defined?(::Delayed::Job) && defined?(::Delayed::Backend::ActiveRecord)
-          log_msg = String.new("DelayedJob enabled (#{::ActiveRecord::Base.default_timezone})")
+          log_msg = String.new("DelayedJob enabled (#{default_timezone})")
           log_msg << " with long-running job support" if track_long_running_jobs?
           logger.info log_msg
           true
@@ -30,11 +30,11 @@ module RailsAutoscaleAgent
           GROUP BY queue
         SQL
 
-        run_at_by_queue = Hash[select_rows(sql)]
+        run_at_by_queue = Hash[select_rows_silently(sql)]
 
         # Don't collect worker metrics if there are unreasonable number of queues
-        if run_at_by_queue.size > 50
-          logger.debug "Skipping DelayedJob metrics - #{run_at_by_queue.size} queues"
+        if run_at_by_queue.size > Config.instance.max_queues
+          logger.warn "Skipping DelayedJob metrics - #{run_at_by_queue.size} queues exceeds the #{Config.instance.max_queues} queue limit"
           return
         end
 
@@ -50,7 +50,7 @@ module RailsAutoscaleAgent
             GROUP BY 1
           SQL
 
-          busy_count_by_queue = Hash[select_rows(sql)]
+          busy_count_by_queue = Hash[select_rows_silently(sql)]
           self.queues = queues | busy_count_by_queue.keys
         end
 
@@ -88,6 +88,24 @@ module RailsAutoscaleAgent
         Config.instance.track_long_running_jobs
       end
 
+      def default_timezone
+        if ::ActiveRecord.respond_to?(:default_timezone)
+          # Rails >= 7
+          ::ActiveRecord.default_timezone
+        else
+          # Rails < 7
+          ::ActiveRecord::Base.default_timezone
+        end
+      end
+
+      def select_rows_silently(sql)
+        if ::ActiveRecord::Base.logger.respond_to?(:silence)
+          ::ActiveRecord::Base.logger.silence { select_rows(sql) }
+        else
+          select_rows(sql)
+        end
+      end
+
       def select_rows(sql)
         # This ensures the agent doesn't hold onto a DB connection any longer than necessary
         ActiveRecord::Base.connection_pool.with_connection { |c| c.select_rows(sql) }

data/lib/rails_autoscale_agent/worker_adapters/que.rb

@@ -20,7 +20,7 @@ module RailsAutoscaleAgent
 
       def enabled?
         if defined?(::Que)
-          logger.info "Que enabled (#{::ActiveRecord::Base.default_timezone})"
+          logger.info "Que enabled (#{default_timezone})"
           true
         end
       end
@@ -37,11 +37,11 @@ module RailsAutoscaleAgent
           GROUP BY 1
         SQL
 
-        run_at_by_queue = Hash[select_rows(sql)]
+        run_at_by_queue = Hash[select_rows_silently(sql)]
 
         # Don't collect worker metrics if there are unreasonable number of queues
-        if run_at_by_queue.size > 50
-          logger.debug "Skipping Que metrics - #{run_at_by_queue.size} queues"
+        if run_at_by_queue.size > Config.instance.max_queues
+          logger.warn "Skipping Que metrics - #{run_at_by_queue.size} queues exceeds the #{Config.instance.max_queues} queue limit"
           return
         end
 
@@ -62,6 +62,24 @@ module RailsAutoscaleAgent
 
       private
 
+      def default_timezone
+        if ::ActiveRecord.respond_to?(:default_timezone)
+          # Rails >= 7
+          ::ActiveRecord.default_timezone
+        else
+          # Rails < 7
+          ::ActiveRecord::Base.default_timezone
+        end
+      end
+
+      def select_rows_silently(sql)
+        if ::ActiveRecord::Base.logger.respond_to?(:silence)
+          ::ActiveRecord::Base.logger.silence { select_rows(sql) }
+        else
+          select_rows(sql)
+        end
+      end
+
       def select_rows(sql)
         # This ensures the agent doesn't hold onto a DB connection any longer than necessary
         ActiveRecord::Base.connection_pool.with_connection { |c| c.select_rows(sql) }

data/lib/rails_autoscale_agent/worker_adapters/resque.rb

@@ -27,8 +27,8 @@ module RailsAutoscaleAgent
         current_queues = ::Resque.queues
 
         # Don't collect worker metrics if there are unreasonable number of queues
-        if current_queues.size > 50
-          logger.debug "Skipping Resque metrics - #{current_queues.size} queues"
+        if current_queues.size > Config.instance.max_queues
+          logger.warn "Skipping Resque metrics - #{current_queues.size} queues exceeds the #{Config.instance.max_queues} queue limit"
           return
         end
 

data/lib/rails_autoscale_agent/worker_adapters/sidekiq.rb

@@ -29,8 +29,8 @@ module RailsAutoscaleAgent
         end
 
         # Don't collect worker metrics if there are unreasonable number of queues
-        if queues_by_name.size > 50
-          logger.debug "Skipping Sidekiq metrics - #{queues_by_name.size} queues"
+        if queues_by_name.size > Config.instance.max_queues
+          logger.warn "Skipping Sidekiq metrics - #{queues_by_name.size} queues exceeds the #{Config.instance.max_queues} queue limit"
           return
         end
 

data/rails_autoscale_agent.gemspec

@@ -9,12 +9,25 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Adam McCrea"]
   spec.email         = ["adam@adamlogic.com"]
 
-  spec.summary       = "This gem works with the Rails Autoscale Heroku add-on to automatically scale your web dynos."
-  spec.homepage      = "https://github.com/adamlogic/rails_autoscale_agent"
+  spec.summary       = "[DEPRECATED] Please use the rails-autoscale-web gem"
+  spec.homepage      = "https://railsautoscale.com"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '~> 2.5'
+  spec.required_ruby_version = '>= 2.5.0'
+  spec.post_install_message  = <<~MSG
+    DEPRECATION WARNING: rails_autoscale_agent is no longer maintained.
+    Please install rails-autoscale-web instead.
+    See https://github.com/rails-autoscale/rails-autoscale-gems for more.
+  MSG
+
+  spec.metadata = {
+    "homepage_uri" => "https://railsautoscale.com",
+    "bug_tracker_uri" => "https://github.com/rails-autoscale/rails-autoscale-gems/issues",
+    "documentation_uri" => "https://railsautoscale.com/docs",
+    "changelog_uri" => "https://github.com/rails-autoscale/rails-autoscale-gems/blob/master/CHANGELOG.md",
+    "source_code_uri" => "https://github.com/rails-autoscale/rails-autoscale-gems",
+  }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_autoscale_agent
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Adam McCrea
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-03 00:00:00.000000000 Z
+date: 2022-09-07 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -19,7 +19,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".ruby-version"
 - ".travis.yml"
 - ".vscode/tasks.json"
 - CHANGELOG.md
@@ -49,28 +48,35 @@ files:
 - lib/rails_autoscale_agent/worker_adapters/sidekiq.rb
 - log/.gitkeep
 - rails_autoscale_agent.gemspec
-homepage: https://github.com/adamlogic/rails_autoscale_agent
+homepage: https://railsautoscale.com
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  homepage_uri: https://railsautoscale.com
+  bug_tracker_uri: https://github.com/rails-autoscale/rails-autoscale-gems/issues
+  documentation_uri: https://railsautoscale.com/docs
+  changelog_uri: https://github.com/rails-autoscale/rails-autoscale-gems/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/rails-autoscale/rails-autoscale-gems
+post_install_message: |
+  DEPRECATION WARNING: rails_autoscale_agent is no longer maintained.
+  Please install rails-autoscale-web instead.
+  See https://github.com/rails-autoscale/rails-autoscale-gems for more.
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
-summary: This gem works with the Rails Autoscale Heroku add-on to automatically scale
-  your web dynos.
+summary: "[DEPRECATED] Please use the rails-autoscale-web gem"
 test_files: []

data/.ruby-version

@@ -1 +0,0 @@
-2.6.5