darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2025-12-23 00:41:35 -05:00
Code Issues Packages Projects Releases Wiki Activity

Include queue name in Celery task logs

Browse Source 
This is mainly so we can use it in the new metrics we send to StatsD
in the following commits, but it should also be useful in the logs.
I've taken the opportunity to make the log format consistent between
success / failure, and with our Template Preview app [1].

[1]: f456433a5a/app/celery/celery.py (L19)
This commit is contained in:
Ben Thorner
2021-04-07 14:10:39 +01:00
parent 19be4faf45
commit 248f5a0708
1 changed files with 21 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
app/celery/celery.py
View File

@@ -25,29 +25,44 @@ def make_task(app):
def on_success(self, retval, task_id, args, kwargs): def on_success(self, retval, task_id, args, kwargs):
elapsed_time = time.monotonic() - self.start elapsed_time = time.monotonic() - self.start
delivery_info = self.request.delivery_info or {}
queue_name = delivery_info.get('routing_key', 'none')
app.logger.info( app.logger.info(
"{task_name} took {time}".format( "Celery task {task_name} (queue: {queue_name}) took {time}".format(
task_name=self.name, time="{0:.4f}".format(elapsed_time) task_name=self.name,
queue_name=queue_name,
time="{0:.4f}".format(elapsed_time)
) )
) )
def on_failure(self, exc, task_id, args, kwargs, einfo): def on_failure(self, exc, task_id, args, kwargs, einfo):
# ensure task will log exceptions to correct handlers delivery_info = self.request.delivery_info or {}
app.logger.exception('Celery task: {} failed'.format(self.name)) queue_name = delivery_info.get('routing_key', 'none')
app.logger.exception(
"Celery task {task_name} (queue: {queue_name}) failed".format(
task_name=self.name,
queue_name=queue_name,
)
)
super().on_failure(exc, task_id, args, kwargs, einfo) super().on_failure(exc, task_id, args, kwargs, einfo)
def __call__(self, *args, **kwargs): def __call__(self, *args, **kwargs):
# ensure task has flask context to access config, logger, etc # ensure task has flask context to access config, logger, etc
with app.app_context(): with app.app_context():
self.start = time.monotonic() self.start = time.monotonic()
# Remove 'request_id' from the kwargs (so the task doesn't get an unexpected kwarg), then add it to g # Remove piggyback values from kwargs
# so that it gets logged # Add 'request_id' to 'g' so that it gets logged
g.request_id = kwargs.pop('request_id', None) g.request_id = kwargs.pop('request_id', None)
return super().__call__(*args, **kwargs) return super().__call__(*args, **kwargs)
def apply_async(self, args=None, kwargs=None, task_id=None, producer=None, def apply_async(self, args=None, kwargs=None, task_id=None, producer=None,
link=None, link_error=None, **options): link=None, link_error=None, **options):
kwargs = kwargs or {} kwargs = kwargs or {}
if has_request_context() and hasattr(request, 'request_id'): if has_request_context() and hasattr(request, 'request_id'):
kwargs['request_id'] = request.request_id kwargs['request_id'] = request.request_id
elif has_app_context() and 'request_id' in g: elif has_app_context() and 'request_id' in g: