celery.utils.debug
This module can be used to diagnose and sample the memory usage used by parts of your application.
For example, to sample the memory usage of calling tasks you can do this:
from celery.utils.debug import sample_mem, memdump
from tasks import add
try:
for i in range(100):
for j in range(100):
add.delay(i, j)
sample_mem()
finally:
memdump()
Utilities for debugging memory usage, blocking calls, etc.
- celery.utils.debug.sample_mem()
-
Sample RSS memory usage.
Statistics can then be output by calling
memdump().
- celery.utils.debug.memdump(samples=10, file=None)
-
Dump memory statistics.
Will print a sample of all RSS memory samples added by calling
sample_mem(), and in addition print used RSS memory aftergc.collect().
- celery.utils.debug.sample(x, n, k=0)
-
Given a list x a sample of length
nof that list is returned.For example, if n is 10, and x has 100 items, a list of every tenth. item is returned.
kcan be used as offset.
- celery.utils.debug.mem_rss()
-
Return RSS memory usage as a humanized string.
- celery.utils.debug.ps()
-
Return the global
psutil.Processinstance.Note
Returns
Noneif https://pypi.org/project/psutil/ is not installed.
Copyright © 2017-2026 Asif Saif Uddin, core team & contributors. All rights reserved.
Celery is licensed under The BSD License (3 Clause, also known as the new BSD license). The license is an OSI approved Open Source license and is GPL-compatible.
https://docs.celeryq.dev/en/stable/reference/celery.utils.debug.html