Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,13 @@ The reporter runs in its own thread so your web requests and background jobs are
- Dyno name (example: web.1)
- PID
- Collection of queue time and utilization metrics for web
- Collection of queue time and/or queue depth metrics, and busy metrics (if enabled), for workers (see below)
- Collection of queue time and/or queue depth metrics, and busy metrics, for workers (see below)

Judoscale aggregates and stores this information to power the autoscaler algorithm and dashboard visualizations.

### What data is collected for each worker adapter?

| adapter | queue time | queue depth | busy (if enabled) |
| adapter | queue time | queue depth | busy |
| --------------------- | ---------- | ----------- | ----------------- |
| judoscale-sidekiq | ✅ | ✅ | ✅ |
| judoscale-solid_queue | ✅ | ❌ | ✅ |
Expand Down Expand Up @@ -156,12 +156,12 @@ Judoscale.configure do |config|
# Default: (queues that look like a UUID are rejected)
# config.sidekiq.queue_filter = ->(queue_name) { /custom/.match?(queue_name) }

# Enables reporting for active (busy) workers so that downscaling can be
# suppressed.
# Reports the number of active (busy) jobs, so that downscaling can be suppressed while jobs are running.
# See https://judoscale.com/docs/long-running-jobs/.
# Set to false to stop reporting busy jobs.
# Note: judoscale-shoryuken does not support reporting busy jobs.
# Default: false
# config.sidekiq.track_busy_jobs = true
# Default: true (false for judoscale-shoryuken)
# config.sidekiq.track_busy_jobs = false

# Disable reporting for this worker adapter.
# Default: true
Expand Down
6 changes: 3 additions & 3 deletions judoscale-delayed_job/test/adapter_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ module Judoscale
_(config.delayed_job.enabled).must_equal true
_(config.delayed_job.max_queues).must_equal 20
_(config.delayed_job.queues).must_equal []
_(config.delayed_job.track_busy_jobs).must_equal false
_(config.delayed_job.track_busy_jobs).must_equal true

Judoscale.configure do |config|
config.delayed_job.queues = %w[test drive]
config.delayed_job.track_busy_jobs = true
config.delayed_job.track_busy_jobs = false
end

_(config.delayed_job.queues).must_equal %w[test drive]
_(config.delayed_job.track_busy_jobs).must_equal true
_(config.delayed_job.track_busy_jobs).must_equal false

report = ::Judoscale::Report.new(Judoscale.adapters, Judoscale::Config.instance, [])
_(report.as_json[:config]).must_include(:delayed_job)
Expand Down
3 changes: 3 additions & 0 deletions judoscale-delayed_job/test/metrics_collector_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ module Judoscale
describe DelayedJob::MetricsCollector do
subject { DelayedJob::MetricsCollector.new }

# Busy jobs are tracked by default; tests that cover busy jobs turn it back on.
before { Judoscale::Config.instance.delayed_job.track_busy_jobs = false }

def clear_enqueued_jobs
ActiveRecord::Base.connection.execute("DELETE FROM delayed_jobs")
end
Expand Down
6 changes: 3 additions & 3 deletions judoscale-good_job/test/adapter_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ module Judoscale
_(config.good_job.enabled).must_equal true
_(config.good_job.max_queues).must_equal 20
_(config.good_job.queues).must_equal []
_(config.good_job.track_busy_jobs).must_equal false
_(config.good_job.track_busy_jobs).must_equal true

Judoscale.configure do |config|
config.good_job.queues = %w[test drive]
config.good_job.track_busy_jobs = true
config.good_job.track_busy_jobs = false
end

_(config.good_job.queues).must_equal %w[test drive]
_(config.good_job.track_busy_jobs).must_equal true
_(config.good_job.track_busy_jobs).must_equal false

report = ::Judoscale::Report.new(Judoscale.adapters, Judoscale::Config.instance, [])
_(report.as_json[:config]).must_include(:good_job)
Expand Down
3 changes: 3 additions & 0 deletions judoscale-good_job/test/metrics_collector_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ module Judoscale
describe GoodJob::MetricsCollector do
subject { GoodJob::MetricsCollector.new }

# Busy jobs are tracked by default; tests that cover busy jobs turn it back on.
before { Judoscale::Config.instance.good_job.track_busy_jobs = false }

def clear_enqueued_jobs
ActiveRecord::Base.connection.execute("DELETE FROM good_jobs")
end
Expand Down
6 changes: 3 additions & 3 deletions judoscale-que/test/adapter_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ module Judoscale
_(config.que.enabled).must_equal true
_(config.que.max_queues).must_equal 20
_(config.que.queues).must_equal []
_(config.que.track_busy_jobs).must_equal false
_(config.que.track_busy_jobs).must_equal true

Judoscale.configure do |config|
config.que.queues = %w[test drive]
config.que.track_busy_jobs = true
config.que.track_busy_jobs = false
end

_(config.que.queues).must_equal %w[test drive]
_(config.que.track_busy_jobs).must_equal true
_(config.que.track_busy_jobs).must_equal false

report = ::Judoscale::Report.new(Judoscale.adapters, Judoscale::Config.instance, [])
_(report.as_json[:config]).must_include(:que)
Expand Down
3 changes: 3 additions & 0 deletions judoscale-que/test/metrics_collector_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ def lock_enqueued_jobs(*enqueued_job_ids)

subject { Que::MetricsCollector.new }

# Busy jobs are tracked by default; tests that cover busy jobs turn it back on.
before { Judoscale::Config.instance.que.track_busy_jobs = false }

describe "#collect" do
after {
clear_enqueued_jobs
Expand Down
6 changes: 3 additions & 3 deletions judoscale-resque/test/adapter_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ module Judoscale
_(config.resque.enabled).must_equal true
_(config.resque.max_queues).must_equal 20
_(config.resque.queues).must_equal []
_(config.resque.track_busy_jobs).must_equal false
_(config.resque.track_busy_jobs).must_equal true

Judoscale.configure do |config|
config.resque.queues = %w[test drive]
config.resque.track_busy_jobs = true
config.resque.track_busy_jobs = false
end

_(config.resque.queues).must_equal %w[test drive]
_(config.resque.track_busy_jobs).must_equal true
_(config.resque.track_busy_jobs).must_equal false

report = ::Judoscale::Report.new(Judoscale.adapters, Judoscale::Config.instance, [])
_(report.as_json[:config]).must_include(:resque)
Expand Down
3 changes: 3 additions & 0 deletions judoscale-resque/test/metrics_collector_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ def job(reload = true)
describe Resque::MetricsCollector do
subject { Resque::MetricsCollector.new }

# Busy jobs are tracked by default; tests that cover busy jobs turn it back on.
before { Judoscale::Config.instance.resque.track_busy_jobs = false }

describe "#collect" do
after {
subject.clear_queues
Expand Down
4 changes: 3 additions & 1 deletion judoscale-ruby/lib/judoscale/config.rb
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ def reset

# Support for deprecated legacy env var configs.
@max_queues = (ENV["JUDOSCALE_MAX_QUEUES"] || ENV["RAILS_AUTOSCALE_MAX_QUEUES"] || 20).to_i
self.track_busy_jobs = (ENV["JUDOSCALE_LONG_JOBS"] || ENV["RAILS_AUTOSCALE_LONG_JOBS"]) == "true"
# Busy jobs are tracked by default when the adapter supports it. The env var can turn it off ("false").
long_jobs = ENV["JUDOSCALE_LONG_JOBS"] || ENV["RAILS_AUTOSCALE_LONG_JOBS"]
self.track_busy_jobs = long_jobs ? long_jobs == "true" : @support_busy_jobs
end

def track_busy_jobs=(value)
Expand Down
14 changes: 10 additions & 4 deletions judoscale-ruby/test/config_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ module Judoscale
adapter_config = config.public_send(adapter_name)
_(adapter_config.enabled).must_equal true
_(adapter_config.max_queues).must_equal 20
_(adapter_config.track_busy_jobs).must_equal false
_(adapter_config.track_busy_jobs).must_equal true
end
end
end
Expand Down Expand Up @@ -300,6 +300,12 @@ module Judoscale
end
end

it "turns off busy job tracking with the legacy ENV var" do
use_env "JUDOSCALE_LONG_JOBS" => "false" do
_(Config.instance.test_job_config.track_busy_jobs).must_equal false
end
end

it "allows configuring all options via a block" do
test_logger = ::Logger.new(StringIO.new)

Expand All @@ -312,7 +318,7 @@ module Judoscale
config.max_request_size_bytes = 50_000
config.report_interval_seconds = 20
config.test_job_config.max_queues = 100
config.test_job_config.track_busy_jobs = true
config.test_job_config.track_busy_jobs = false
config.test_job_config.enabled = false
end

Expand All @@ -325,7 +331,7 @@ module Judoscale
_(config.report_interval_seconds).must_equal 20
_(config.test_job_config.enabled).must_equal false
_(config.test_job_config.max_queues).must_equal 100
_(config.test_job_config.track_busy_jobs).must_equal true
_(config.test_job_config.track_busy_jobs).must_equal false

enabled_adapter_configs = Config.adapter_configs.select(&:enabled).map(&:identifier)
_(enabled_adapter_configs).must_be :empty?
Expand Down Expand Up @@ -363,7 +369,7 @@ module Judoscale
max_queues: 20,
queues: [],
queue_filter: false,
track_busy_jobs: false
track_busy_jobs: true
}
})
end
Expand Down
6 changes: 3 additions & 3 deletions judoscale-sidekiq/test/adapter_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ module Judoscale
_(config.sidekiq.enabled).must_equal true
_(config.sidekiq.max_queues).must_equal 20
_(config.sidekiq.queues).must_equal []
_(config.sidekiq.track_busy_jobs).must_equal false
_(config.sidekiq.track_busy_jobs).must_equal true

Judoscale.configure do |config|
config.sidekiq.queues = %w[test drive]
config.sidekiq.track_busy_jobs = true
config.sidekiq.track_busy_jobs = false
end

_(config.sidekiq.queues).must_equal %w[test drive]
_(config.sidekiq.track_busy_jobs).must_equal true
_(config.sidekiq.track_busy_jobs).must_equal false

report = ::Judoscale::Report.new(Judoscale.adapters, Judoscale::Config.instance, [])
_(report.as_json[:config]).must_include(:sidekiq)
Expand Down
3 changes: 3 additions & 0 deletions judoscale-sidekiq/test/metrics_collector_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ module Judoscale
describe Sidekiq::MetricsCollector do
subject { Sidekiq::MetricsCollector.new }

# Busy jobs are tracked by default; tests that cover busy jobs turn it back on.
before { Judoscale::Config.instance.sidekiq.track_busy_jobs = false }

describe "#collect" do
after {
subject.clear_queues
Expand Down
6 changes: 3 additions & 3 deletions judoscale-solid_queue/test/adapter_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ module Judoscale
_(config.solid_queue.enabled).must_equal true
_(config.solid_queue.max_queues).must_equal 20
_(config.solid_queue.queues).must_equal []
_(config.solid_queue.track_busy_jobs).must_equal false
_(config.solid_queue.track_busy_jobs).must_equal true

Judoscale.configure do |config|
config.solid_queue.queues = %w[test drive]
config.solid_queue.track_busy_jobs = true
config.solid_queue.track_busy_jobs = false
end

_(config.solid_queue.queues).must_equal %w[test drive]
_(config.solid_queue.track_busy_jobs).must_equal true
_(config.solid_queue.track_busy_jobs).must_equal false

report = ::Judoscale::Report.new(Judoscale.adapters, Judoscale::Config.instance, [])
_(report.as_json[:config]).must_include(:solid_queue)
Expand Down
3 changes: 3 additions & 0 deletions judoscale-solid_queue/test/metrics_collector_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ module Judoscale
describe SolidQueue::MetricsCollector do
subject { SolidQueue::MetricsCollector.new }

# Busy jobs are tracked by default; tests that cover busy jobs turn it back on.
before { Judoscale::Config.instance.solid_queue.track_busy_jobs = false }

def clear_enqueued_jobs
::SolidQueue::Job.delete_all
::SolidQueue::ReadyExecution.delete_all
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,4 @@
Judoscale.configure do |config|
# Open the request catcher URL in a browser to monitor requests
config.api_base_url = ENV["JUDOSCALE_URL"] || "https://judoscale-ruby.requestcatcher.com"

# Enable busy jobs tracking for testing with the sample app.
config.delayed_job.track_busy_jobs = true
end
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,4 @@
Judoscale.configure do |config|
# Open the request catcher URL in a browser to monitor requests
config.api_base_url = ENV["JUDOSCALE_URL"] || "https://judoscale-ruby.requestcatcher.com"

# Enable busy jobs tracking for testing with the sample app.
config.good_job.track_busy_jobs = true
end
3 changes: 0 additions & 3 deletions sample-apps/good_job-sample/config/initializers/judoscale.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,4 @@
Judoscale.configure do |config|
# Open the request catcher URL in a browser to monitor requests
config.api_base_url = ENV["JUDOSCALE_URL"] || "https://judoscale-ruby.requestcatcher.com"

# Enable busy jobs tracking for testing with the sample app.
config.good_job.track_busy_jobs = true
end
3 changes: 0 additions & 3 deletions sample-apps/que-2-sample/config/initializers/judoscale.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,4 @@
Judoscale.configure do |config|
# Open the request catcher URL in a browser to monitor requests
config.api_base_url = ENV["JUDOSCALE_URL"] || "https://judoscale-ruby.requestcatcher.com"

# Enable busy jobs tracking for testing with the sample app.
config.que.track_busy_jobs = true
end
3 changes: 0 additions & 3 deletions sample-apps/resque-sample/config/initializers/judoscale.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,4 @@
Judoscale.configure do |config|
# Open the request catcher URL in a browser to monitor requests
config.api_base_url = ENV["JUDOSCALE_URL"] || "https://judoscale-ruby.requestcatcher.com"

# Enable busy jobs tracking for testing with the sample app.
config.resque.track_busy_jobs = true
end
3 changes: 0 additions & 3 deletions sample-apps/sidekiq-sample/config/initializers/judoscale.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,4 @@
Judoscale.configure do |config|
# Open the request catcher URL in a browser to monitor requests
config.api_base_url = ENV["JUDOSCALE_URL"] || "https://judoscale-ruby.requestcatcher.com"

# Enable busy jobs tracking for testing with the sample app.
config.sidekiq.track_busy_jobs = true
end
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,4 @@
Judoscale.configure do |config|
# Open the request catcher URL in a browser to monitor requests
config.api_base_url = ENV["JUDOSCALE_URL"] || "https://judoscale-ruby.requestcatcher.com"

# Enable busy jobs tracking for testing with the sample app.
config.solid_queue.track_busy_jobs = true
end
Loading