Skip to main content

Celery tracker for Django.

Project description

Build status coverage

This django extension is intended for existing celery projects that want better monitoring of what’s going on in their queue.

Usage

To use this with your project, you need to:

  1. Install django-celery-tracker:

$ pip install django-celery-tracker
  1. Add django_celery_tracker to INSTALLED_APPS in your Django settings file:

INSTALLED_APPS = (
    ...
    'django_celery_tracker',
)
  1. Create the database tables by applying migrations:

$ python manage.py migrate django_celery_tracker
  1. You will now have a record of all future celery tasks and their progress which can queried like so:

$ python manage.py console
...
>>> from django_celery_tracker.models import CeleryTask
>>> CeleryTask.objects.all()
<QuerySet [<CeleryTask: id=3d889396-daa2-4209-9348-9ec71bfb1262, name=api.taskapp.celery.debug_task>]

Disclaimer

The datastore for a celery message queue is usually in-memory and highly-optimized (eg redis or rabbitmq). This django extension creates a database entry for every celery task that is created. You may want to periodically delete older entries if storage is an obstacle.

Release

switch to master branch:

  • Change package version in django_celery_tracker/__init__.py according to release changes (major|minor|patch).

  • Update CHANGELOG.md: - Rename [Unreleased] section to reflect new release version and release date, same format as for all previous releases - Create new [Unreleased] section on top of file, as it was previously - On the bottom of CHANGELOG.md file, create comparison reference for current release changes:

  # was
  [Unreleased]: https://github.com/chris-allen/django-celery-tracker/compare/v0.3.0...HEAD
  [0.3.0]: https://github.com/chris-allen/django-celery-tracker/compare/v0.2.0...v0.3.0

  # became
  # - "Unreleased" renamed to commit version
  # - new "Unreleased" created, comparing last "0.4.0" commit with "HEAD"
  [Unreleased]: https://github.com/chris-allen/django-celery-tracker/compare/v0.4.0...HEAD
  [0.4.0]: https://github.com/chris-allen/django-celery-tracker/compare/v0.3.0...v0.4.0
  [0.3.0]: https://github.com/chris-allen/django-celery-tracker/compare/v0.2.0...v0.3.0

- Commit ``CHANGELOG.md`` and ``django_celery_tracker/__init__.py`` with message ``:rocket: {version}`` (where version is your release version)

Project details


Download files

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

Source Distribution

django_celery_tracker-1.0.1.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

django_celery_tracker-1.0.1-py2.py3-none-any.whl (7.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django_celery_tracker-1.0.1.tar.gz.

File metadata

  • Download URL: django_celery_tracker-1.0.1.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for django_celery_tracker-1.0.1.tar.gz
Algorithm Hash digest
SHA256 0c28a2a81bebde1b85380bb06cdf4a09673e6591535264f1a423595b35700e19
MD5 bc23065b11556050deb69078f41fd009
BLAKE2b-256 68f6ee7cc7fc1eb5b2b8e148ac9ab4f54c63a313be61802659639e9762e8daca

See more details on using hashes here.

Provenance

File details

Details for the file django_celery_tracker-1.0.1-py2.py3-none-any.whl.

File metadata

  • Download URL: django_celery_tracker-1.0.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for django_celery_tracker-1.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b6e4da88d0ecd5f836af68ca591595f1c376b7197172193fed96790e2d1f5821
MD5 7805733de8ebb8d1649abffeeadf0b7f
BLAKE2b-256 9d63ad931717267d33694bb1191bacd45275e6838f9ce9bcb71e43f78337fa8e

See more details on using hashes here.

Provenance

Supported by

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