Plugins

This package contains the various built-in plugins available for Chancy. Plugins are used to extend the functionality of Chancy, while allowing for significant customization.

Some Chancy plugins are enabled by default. You can pass your own into the list of plugins to customize them or set no_default_plugins to True to disable them completely:

async with Chancy(..., no_default_plugins=True, plugins=[]):
    ...

Default Plugins

• chancy.plugins.workflow.WorkflowPlugin: This plugin provides a workflow system for managing complex job dependencies.

• chancy.plugins.metrics.Metrics: This plugin collects metrics about the performance of the Chancy cluster and makes them available to the API, dashboard, and database.

• chancy.plugins.leadership.Leadership: This plugin is responsible for managing leadership elections between multiple workers. Most other plugins require this plugin to be enabled.

• chancy.plugins.pruner.Pruner: This plugin is responsible for pruning old jobs from the database when they are no longer needed.

• chancy.plugins.recovery.Recovery: This plugin is responsible for recovering jobs that were interrupted during execution, such as when a worker crashes or is restarted.

Optional Plugins

Chancy also comes with some additional plugins that can be enabled as needed, and typically require additional dependencies:

• chancy.plugins.api.Api: This plugin provides an API and dashboard for viewing the state of the Chancy cluster.

• chancy.plugins.cron.Cron: This plugin is responsible for running jobs to at recurring schedules, such as “once an hour” or “every Monday”.

• chancy.plugins.retry.RetryPlugin: This plugin provides a slightly more advanced job retry system with jitter, backoff, and other features.

• chancy.plugins.reprioritize.Reprioritize: This plugin increases the priority of jobs based on how long they’ve been in the queue.

• chancy.plugins.sentry.SentryPlugin: This plugin sends job exceptions to Sentry, along with metadata about the job and worker.

Submodules

• Leadership
  • ImmediateLeadership
    • ImmediateLeadership.get_identifier()
    • ImmediateLeadership.get_scope()
    • ImmediateLeadership.run()
  • Leadership
    • Leadership.get_identifier()
    • Leadership.get_scope()
    • Leadership.get_tables()
    • Leadership.run()
• Pruner
  • Pruner
    • Pruner.Rules
    • Pruner.get_dependencies()
    • Pruner.get_identifier()
    • Pruner.get_scope()
    • Pruner.prune()
    • Pruner.run()
• Recovery
  • Recovery
    • Recovery.get_dependencies()
    • Recovery.get_identifier()
    • Recovery.recover()
    • Recovery.run()
• Cron
  • Cron
    • Cron.api_plugin()
    • Cron.get_identifier()
    • Cron.get_schedules()
    • Cron.get_scope()
    • Cron.get_tables()
    • Cron.migrate_key()
    • Cron.migrate_package()
    • Cron.run()
    • Cron.schedule()
    • Cron.unschedule()
  • CronApiPlugin
    • CronApiPlugin.get_cron()
    • CronApiPlugin.name()
    • CronApiPlugin.routes()
• API/Dashboard
  • Api
    • Api.get_identifier()
    • Api.run()
  • AuthBackend
    • AuthBackend.login()
    • AuthBackend.logout()
  • SimpleAuthBackend
    • SimpleAuthBackend.authenticate()
    • SimpleAuthBackend.login()
    • SimpleAuthBackend.logout()
  • ApiPlugin
    • ApiPlugin.name()
    • ApiPlugin.routes()
  • RouteT
    • RouteT.endpoint
    • RouteT.is_websocket
    • RouteT.methods
    • RouteT.name
    • RouteT.path
  • CoreApiPlugin
    • CoreApiPlugin.get_configuration()
    • CoreApiPlugin.get_job()
    • CoreApiPlugin.get_jobs()
    • CoreApiPlugin.get_queues()
    • CoreApiPlugin.get_workers()
    • CoreApiPlugin.login()
    • CoreApiPlugin.name()
    • CoreApiPlugin.routes()
• Workflows
  • WorkflowPlugin
    • WorkflowPlugin.Rules
      • WorkflowPlugin.Rules.Age
    • WorkflowPlugin.api_plugin()
    • WorkflowPlugin.cleanup()
    • WorkflowPlugin.fetch_workflow()
    • WorkflowPlugin.fetch_workflow_ex()
    • WorkflowPlugin.fetch_workflows()
    • WorkflowPlugin.fetch_workflows_ex()
    • WorkflowPlugin.generate_dot()
    • WorkflowPlugin.get_dependencies()
    • WorkflowPlugin.get_identifier()
    • WorkflowPlugin.get_tables()
    • WorkflowPlugin.migrate_key()
    • WorkflowPlugin.migrate_package()
    • WorkflowPlugin.on_job_updated()
    • WorkflowPlugin.process_workflow()
    • WorkflowPlugin.push()
    • WorkflowPlugin.push_ex()
    • WorkflowPlugin.run()
    • WorkflowPlugin.wait_for_workflow()
  • Workflow
    • Workflow.State
      • Workflow.State.COMPLETED
      • Workflow.State.FAILED
      • Workflow.State.PENDING
      • Workflow.State.RUNNING
    • Workflow.add()
    • Workflow.add_group()
    • Workflow.created_at
    • Workflow.id
    • Workflow.is_complete
    • Workflow.is_running
    • Workflow.name
    • Workflow.state
    • Workflow.steps
    • Workflow.steps_by_state
    • Workflow.updated_at
  • WorkflowStep
    • WorkflowStep.dependencies
    • WorkflowStep.job
    • WorkflowStep.job_id
    • WorkflowStep.state
    • WorkflowStep.step_id
  • Sequence
    • Sequence.add()
    • Sequence.push()
  • WorkflowApiPlugin
    • WorkflowApiPlugin.get_workflow()
    • WorkflowApiPlugin.get_workflows()
    • WorkflowApiPlugin.name()
    • WorkflowApiPlugin.routes()
• Retry
  • RetryPlugin
    • RetryPlugin.calculate_next_run()
    • RetryPlugin.get_identifier()
    • RetryPlugin.on_job_completed()
• Reprioritization
  • Reprioritize
    • Reprioritize.Rules
    • Reprioritize.get_dependencies()
    • Reprioritize.get_identifier()
    • Reprioritize.reprioritize_jobs()
    • Reprioritize.run()
• Sentry
  • SentryPlugin
    • SentryPlugin.get_identifier()
    • SentryPlugin.on_job_completed()
• Metrics
  • Metrics
    • Metrics.api_plugin()
    • Metrics.cleanup()
    • Metrics.get_identifier()
    • Metrics.get_metrics()
    • Metrics.get_tables()
    • Metrics.increment_counter()
    • Metrics.matches_prefix()
    • Metrics.migrate_key()
    • Metrics.migrate_package()
    • Metrics.on_job_updated()
    • Metrics.record_gauge()
    • Metrics.record_histogram_value()
    • Metrics.run()