Oban.check_queue

You're seeing just the function check_queue, go back to Oban module for more information.
Link to this function

check_queue(name \\ __MODULE__, opts)

View Source (since 2.2.0)

Specs

check_queue(name(), opts :: [{:queue, queue_name()}]) :: queue_state()

Check the current state of a queue producer.

This allows you to introspect on a queue's health by retrieving key attributes of the producer's state; values such as the current limit, the running job ids, and when the producer was started.

Options

  • :queue - a string or atom specifying the queue to check, required

Example

Oban.check_queue(queue: :default)
%{
  limit: 10,
  node: "me@local",
  paused: false,
  queue: "default",
  running: [100, 102],
  started_at: ~D[2020-10-07 15:31:00],
  updated_at: ~D[2020-10-07 15:31:00]
}