Plugins

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.

Chancy comes with several built-in plugins:

• 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.

• chancy.plugins.cron.Cron: This plugin is responsible for scheduling

  jobs to run at recurring schedules.

• chancy.plugins.api.Api: This plugin provides an API and dashboard

  for viewing the state of the Chancy cluster.

• chancy.plugins.workflow.WorkflowPlugin: This plugin provides a

  workflow system for managing complex job dependencies.

• 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_scope()
    • ImmediateLeadership.run()
  • Leadership
    • Leadership.get_scope()
    • Leadership.run()
• Pruner
  • Pruner
    • Pruner.Rules
    • Pruner.get_scope()
    • Pruner.prune()
    • Pruner.run()
• Recovery
  • Recovery
    • Recovery.get_scope()
    • Recovery.recover()
    • Recovery.run()
• Cron
  • Cron
    • Cron.api_plugin()
    • Cron.get_scope()
    • 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_scope()
    • Api.run()
  • ApiPlugin
    • ApiPlugin.name()
    • ApiPlugin.routes()
  • RouteT
    • RouteT.endpoint
    • RouteT.methods
    • RouteT.name
    • RouteT.path
  • CoreApiPlugin
    • CoreApiPlugin.get_configuration()
    • CoreApiPlugin.get_job()
    • CoreApiPlugin.get_jobs()
    • CoreApiPlugin.get_queues()
    • CoreApiPlugin.get_workers()
    • CoreApiPlugin.name()
    • CoreApiPlugin.routes()
• Workflows
  • WorkflowPlugin
    • WorkflowPlugin.Rules
      • WorkflowPlugin.Rules.Age
    • WorkflowPlugin.api_plugin()
    • WorkflowPlugin.cleanup()
    • WorkflowPlugin.fetch_workflow()
    • WorkflowPlugin.fetch_workflows()
    • WorkflowPlugin.generate_dot()
    • WorkflowPlugin.get_scope()
    • WorkflowPlugin.migrate_key()
    • WorkflowPlugin.migrate_package()
    • WorkflowPlugin.process_workflow()
    • WorkflowPlugin.push()
    • 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_scope()
    • RetryPlugin.on_job_completed()
• Reprioritization
  • Reprioritize
    • Reprioritize.Rules
    • Reprioritize.get_scope()
    • Reprioritize.reprioritize_jobs()
    • Reprioritize.run()
• Sentry
  • SentryPlugin
    • SentryPlugin.on_job_completed()