Are there console commands to look at whats in the queue and to clear the queue in Sidekiq?

Question

I'm used to using delayed_jobs method of going into the console to see whats in the queue, and the ease of clearing the queue when needed. Are there similar commands in Sidekiq for this? Thanks!

Answer 1

There is an ergonomic API for viewing and managing queues.

It is not required by default.

require 'sidekiq/api'

Here's the excerpt:

# get a handle to the default queue
default_queue = Sidekiq::Queue.new 

# get a handle to the mailer queue
mailer_queue = Sidekiq::Queue.new("mailer") 

# How many jobs are in the default queue?
default_queue.size # => 1001

# How many jobs are in the mailer queue?
mailer_queue.size # => 50

#Deletes all Jobs in a Queue, by removing the queue.    
default_queue.clear

You can also get some summary statistics.

stats = Sidekiq::Stats.new

# Get the number of jobs that have been processed.
stats.processed # => 100

# Get the number of jobs that have failed.    
stats.failed # => 3

# Get the queues with name and number enqueued.
stats.queues # => { "default" => 1001, "email" => 50 }

#Gets the number of jobs enqueued in all queues (does NOT include retries and scheduled jobs).
stats.enqueued # => 1051 

Answer 2

I haven't ever used Sidekiq, so it's possible that there are methods just for viewing the queued jobs, but they would really just be wrappers around Redis commands, since that's basically all Sidekiq (and Resque) is:

# See workers
Sidekiq::Client.registered_workers

# See queues
Sidekiq::Client.registered_queues

# See all jobs for one queue
Sidekiq.redis { |r| r.lrange "queue:app_queue", 0, -1 }

# See all jobs in all queues
Sidekiq::Client.registered_queues.each do |q|
  Sidekiq.redis { |r| r.lrange "queue:#{q}", 0, -1 }
end

# Remove a queue and all of its jobs
Sidekiq.redis do |r| 
  r.srem "queues", "app_queue"
  r.del  "queue:app_queue"
end

Unfortunately, removing a specific job is a little more difficult as you'd have to copy its exact value:

# Remove a specific job from a queue
Sidekiq.redis { |r| r.lrem "queue:app_queue", -1, "the payload string stored in Redis" }

You could do all of this even more easily via redis-cli :

$ redis-cli
> select 0 # (or whichever namespace Sidekiq is using)
> keys * # (just to get an idea of what you're working with)
> smembers queues
> lrange queues:app_queue 0 -1
> lrem queues:app_queue -1 "payload"

Answer 3

if there is any scheduled job. You may delete all the jobs using the following command:

Sidekiq::ScheduledSet.new.clear

if there any queues you wanted to delete all jobs you may use the following command:

  Sidekiq::Queue.new.clear

Retries Jobs can be removed by the following command also:

Sidekiq::RetrySet.new.clear

There are more information here at the following link, you may checkout: https://github.com/mperham/sidekiq/wiki/API

Answer 4

There is a API for accessing real-time information about workers, queues and jobs.
Visit here https://github.com/mperham/sidekiq/wiki/API

Answer 5

A workaround is to use the testing module (require 'sidekiq/testing') and to drain the worker (MyWorker.drain).

Answer 6

There were hanged 'workers' in default queue and I was able to see them though web interface. But they weren't available from console if I used Sidekiq::Queue.new.size

irb(main):002:0> Sidekiq::Queue.new.size
2014-03-04T14:37:43Z 17256 TID-oujb9c974 INFO: Sidekiq client with redis options {:namespace=>"sidekiq_staging"}
=> 0

Using redis-cli I was able to find them

redis 127.0.0.1:6379> keys *
    1) "sidekiq_staging:worker:ip-xxx-xxx-xxx-xxx:7635c39a29d7b255b564970bea51c026-69853672483440:default"
    2) "sidekiq_staging:worker:ip-xxx-xxx-xxx-xxx:0cf585f5e93e1850eee1ae4613a08e45-70328697677500:default:started"
    3) "sidekiq_staging:worker:ip-xxx-xxx-xxx-xxx:7635c39a29d7b255b564970bea51c026-69853672320140:default:started"
    ...

The solution was:

irb(main):003:0>  Sidekiq.redis { |r| r.del "workers", 0, -1 }
=> 1

Also in the Sidekiq v3 there is a command

Sidekiq::Workers.new.prune

But for some reason it didn't work for me that day

Answer 7

And if you want to clear the sidekiq retry queue, it's this: Sidekiq::RetrySet.new.clear

Answer 8

$ redis-cli
> select 0 # (or whichever namespace Sidekiq is using)
> keys * # (just to get an idea of what you're working with)
> smembers queues
> lrange queue:queue_name 0 -1 # (queue_name must be your relevant queue)
> lrem queue:queue_name -1 "payload"

Answer 9

Rake task for clear all sidekiq queues:

namespace :sidekiq do
  desc 'Clear sidekiq queue'
  task clear: :environment do
    require 'sidekiq/api'
    Sidekiq::Queue.all.each(&:clear)
  end
end

Usage:

rake sidekiq:clear

Answer 10

This is not a direct solution for the Rails console, but for a quick monitoring of the Sidekiq task count and queue size, you can use sidekiqmon binary that ships with Sidekiq 6+:

$ sidekiqmon
Sidekiq 6.4.2
2022-07-25 11:05:56 UTC

---- Overview ----
  Processed: 20,313,347
     Failed: 57,120
       Busy: 9
   Enqueued: 17
    Retries: 0
  Scheduled: 37
       Dead: 2,382

---- Processes (1) ----
36f993209f93:15:a498f85c6a12 [server]
  Started: 2022-07-25 10:49:43 +0000 (16 minutes ago)
  Threads: 10 (9 busy)
   Queues: default, elasticsearch, statistics

---- Queues (3) ----
NAME             SIZE  LATENCY
default             0     0.00
elasticsearch      17     0.74
statistics          0     0.00