exq

v0.13.2

exq v0.13.2 Exq.Api

Interface for retrieving Exq stats. Pid is currently Exq.Api process

Link to this section Summary

Functions

busy(pid)

Number of busy workers

clear_failed(pid)
clear_processes(pid)
clear_retries(pid)
clear_scheduled(pid)
failed(pid)
failed_size(pid)
find_failed(pid, jid)
find_job(pid, queue, jid)
find_retry(pid, jid)
find_scheduled(pid, jid)
jobs(pid)

List jobs enqueued

jobs(pid, queue)

List jobs enqueued

processes(pid)

Number of processes

queue_size(pid)
queue_size(pid, queue)
queues(pid)

List of queues with jobs (empty queues are deleted)

realtime_stats(pid)
remove_failed(pid, jid)
remove_job(pid, queue, jid)
remove_queue(pid, queue)

Clear / Remove queue

remove_retry(pid, jid)
remove_scheduled(pid, jid)
retries(pid)
retry_job(pid, jid)
retry_size(pid)
scheduled(pid)
scheduled_size(pid)
scheduled_with_scores(pid)
start_link(opts \\ [])
stats(pid, key)

Return stat for given key Examples of keys are processed, failed

stats(pid, key, date)

Link to this section Functions

Link to this function

busy(pid)

Number of busy workers

Expected args:

  • pid - Exq.Api process

Returns:

  • {:ok, num_busy} - number of busy workers
Link to this function

clear_failed(pid)

Link to this function

clear_processes(pid)

Link to this function

clear_retries(pid)

Link to this function

clear_scheduled(pid)

Link to this function

failed(pid)

Link to this function

failed_size(pid)

Link to this function

find_failed(pid, jid)

Link to this function

find_job(pid, queue, jid)

Link to this function

find_retry(pid, jid)

Link to this function

find_scheduled(pid, jid)

Link to this function

jobs(pid)

List jobs enqueued

Expected args:

  • pid - Exq.Api process

Returns:

  • {:ok, [{queue, [jobs]}, {queue, [jobs]}]}
Link to this function

jobs(pid, queue)

List jobs enqueued

Expected args:

  • pid - Exq.Api process
  • queue - Queue name

Returns:

  • {:ok, [jobs]}
Link to this function

processes(pid)

Number of processes

Expected args:

  • pid - Exq.Api process
  • key - Key for stat
  • queue - Queue name

Returns:

  • {:ok, stat} stat for key
Link to this function

queue_size(pid)

Link to this function

queue_size(pid, queue)

Link to this function

queues(pid)

List of queues with jobs (empty queues are deleted)

Expected args:

  • pid - Exq.Api process

Returns:

  • {:ok, queues} - list of queue
Link to this function

realtime_stats(pid)

Link to this function

remove_failed(pid, jid)

Link to this function

remove_job(pid, queue, jid)

Link to this function

remove_queue(pid, queue)

Clear / Remove queue

Expected args:

  • pid - Exq.Api process
  • queue - Queue name

Returns:

  • {:ok, queues} - list of queue
Link to this function

remove_retry(pid, jid)

Link to this function

remove_scheduled(pid, jid)

Link to this function

retries(pid)

Link to this function

retry_job(pid, jid)

Link to this function

retry_size(pid)

Link to this function

scheduled(pid)

Link to this function

scheduled_size(pid)

Link to this function

scheduled_with_scores(pid)

Link to this function

start_link(opts \\ [])

Link to this function

stats(pid, key)

Return stat for given key Examples of keys are processed, failed

Expected args:

  • pid - Exq.Api process
  • key - Key for stat
  • queue - Queue name

Returns:

  • {:ok, stat} stat for key
Link to this function

stats(pid, key, date)