ObanChore (ObanChore v0.3.0)

Copy Markdown View Source

ObanChore transforms standard Oban workers into secure, UI-driven operational tools.

Configuration

To use ObanChore, you must add ObanChore.Plugin to your Oban configuration and provide a :pubsub_server:

config :my_app, Oban,
  repo: MyApp.Repo,
  plugins: [
    {ObanChore.Plugin, otp_app: :my_app, pubsub_server: MyApp.PubSub},
    # ...
  ],
  queues: [default: 10]

Summary

Functions

Counts the number of running (available, scheduled, executing) jobs for a given worker module.

Lists the active (available, scheduled, executing) jobs for a given worker module.

Logs a message to the ObanChore dashboard for the given job.

Checks if a job for the given worker and arguments is already running (available, scheduled, executing).

Functions

count_running(worker_module, oban_name \\ Oban)

Counts the number of running (available, scheduled, executing) jobs for a given worker module.

list_active_jobs(worker_module, oban_name \\ Oban)

Lists the active (available, scheduled, executing) jobs for a given worker module.

log(job, message)

Logs a message to the ObanChore dashboard for the given job.

running_with_args?(worker_module, args, oban_name \\ Oban)

Checks if a job for the given worker and arguments is already running (available, scheduled, executing).