Skip to main content

Run jobs without a dedicated JobRunner

Project description

Odoo Community Association

Queue Job Cron Jobrunner

Alpha License: AGPL-3 OCA/queue Translate me on Weblate Try me on Runboat

This module implements a simple queue.job runner using ir.cron triggers.

It’s meant to be used on environments where the regular job runner can’t be run, like on Odoo.sh.

Unlike the regular job runner, where jobs are dispatched to the HttpWorkers, jobs are processed on the CronWorker threads by the job runner crons. This is a design decision because:

  • Odoo.sh puts HttpWorkers to sleep when there’s no network activity

  • HttpWorkers are meant for traffic. Users shouldn’t pay the price of background tasks.

For now, it only implements the most basic features of the queue_job runner, notably no channel capacity nor priorities. Please check the ROADMAP for further details.

Table of contents

Configuration

Warning

Don’t use this module if you’re already running the regular queue_job runner.

For the easiest case, no configuration is required besides installing the module.

To avoid CronWorker CPU timeout from abruptly stopping the job processing cron, it’s recommended to launch Odoo with --limit-time-real-cron=0, to disable the CronWorker timeout altogether.

Note

In Odoo.sh, this is done by default.

Parallel execution of jobs can be achieved by leveraging multiple ir.cron records:

  • Make sure you have enough CronWorkers available (Odoo CLI --max-cron-threads)

  • Duplicate the queue_job_cron cron record as many times as needed, until you have as much records as cron workers.

Known issues / Roadmap

  • Support channel capacity and priority. (See _acquire_one_job)

  • Gracefully handle CronWorker CPU timeouts. (See _job_runner)

  • Commit transaction after job state updated to started. (See _process)

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • Camptocamp SA

Contributors

Maintainers

This module is maintained by the OCA.

Odoo Community Association

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

Current maintainer:

ivantodorovich

This module is part of the OCA/queue project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file odoo_addon_queue_job_cron_jobrunner-18.0.1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for odoo_addon_queue_job_cron_jobrunner-18.0.1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ce1b866a77dd72adc7fd0fedc02bb68da5954b81f5bb443b23eaa70b227e26e6
MD5 6fd5d5195ee26cac7fd98899a2589acc
BLAKE2b-256 b9a1b8d85e53d9ea0a6e5b2486609fa03af397c65befbc2fe4f83e52220c7f0d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page