ObanChore.Plugin (ObanChore v0.3.2)

Copy Markdown View Source

An Oban Plugin that automatically discovers and manages chores.

The plugin is responsible for:

  • Scanning specified OTP applications for modules using ObanChore.Worker.
  • Attaching telemetry handlers to track chore status and counts.
  • Broadcasting real-time updates via Phoenix PubSub.

Options

  • :otp_app - An atom or list of atoms representing the OTP application(s) to search for chores. If not provided, all loaded applications will be searched.
  • :pubsub_server - (Required) The name of your application's Phoenix PubSub server.

Examples

# In your Oban configuration:
config :my_app, Oban,
  repo: MyApp.Repo,
  plugins: [
    {ObanChore.Plugin, otp_app: :my_app, pubsub_server: MyApp.PubSub}
  ]

Summary

Functions

Returns a specification to start this module under a supervisor.

Retrieves the list of discovered chores from the plugin's state.

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

get_chores()

Retrieves the list of discovered chores from the plugin's state.

Returns a list of maps containing chore metadata.