darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-02-02 09:26:08 -05:00
Code Issues Packages Projects Releases Wiki Activity

Enable request tracing on Celery success/fail logs

Browse Source 
Previously these logs wouldn't have a Request ID attached since the
Celery hooks run after the __call__ method where we enable request
tracing for normal application logs. For the failure log especially
it will be useful to have this feature.
This commit is contained in:
Ben Thorner
2021-11-10 17:40:41 +00:00
parent 369a9f7521
commit ac06529128
1 changed files with 37 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
app/celery/celery.py
View File

@@ -1,4 +1,5 @@
import time import time
from contextlib import contextmanager
from celery import Celery, Task from celery import Celery, Task
from celery.signals import worker_process_shutdown from celery.signals import worker_process_shutdown
@@ -35,49 +36,58 @@ def make_task(app):
# task context (aka "request"). # task context (aka "request").
return self.request.get('notify_request_id') return self.request.get('notify_request_id')
@contextmanager
def app_context(self):
with app.app_context():
# Add 'request_id' to 'g' so that it gets logged.
g.request_id = self.request_id
yield
def on_success(self, retval, task_id, args, kwargs): def on_success(self, retval, task_id, args, kwargs):
elapsed_time = time.monotonic() - self.start # enables request id tracing for these logs
with self.app_context():
elapsed_time = time.monotonic() - self.start
app.logger.info( app.logger.info(
"Celery task {task_name} (queue: {queue_name}) took {time}".format( "Celery task {task_name} (queue: {queue_name}) took {time}".format(
task_name=self.name, task_name=self.name,
queue_name=self.queue_name, queue_name=self.queue_name,
time="{0:.4f}".format(elapsed_time) time="{0:.4f}".format(elapsed_time)
)
) )
)
app.statsd_client.timing( app.statsd_client.timing(
"celery.{queue_name}.{task_name}.success".format( "celery.{queue_name}.{task_name}.success".format(
task_name=self.name, task_name=self.name,
queue_name=self.queue_name queue_name=self.queue_name
), elapsed_time ), elapsed_time
) )
def on_failure(self, exc, task_id, args, kwargs, einfo): def on_failure(self, exc, task_id, args, kwargs, einfo):
app.logger.exception( # enables request id tracing for these logs
"Celery task {task_name} (queue: {queue_name}) failed".format( with self.app_context():
task_name=self.name, app.logger.exception(
queue_name=self.queue_name, "Celery task {task_name} (queue: {queue_name}) failed".format(
task_name=self.name,
queue_name=self.queue_name,
)
) )
)
app.statsd_client.incr( app.statsd_client.incr(
"celery.{queue_name}.{task_name}.failure".format( "celery.{queue_name}.{task_name}.failure".format(
task_name=self.name, task_name=self.name,
queue_name=self.queue_name queue_name=self.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 self.app_context():
self.start = time.monotonic() self.start = time.monotonic()
# TEMPORARY: remove old piggyback values from kwargs # TEMPORARY: remove old piggyback values from kwargs
kwargs.pop('request_id', None) kwargs.pop('request_id', None)
# Add 'request_id' to 'g' so that it gets logged. Note
g.request_id = self.request_id
return super().__call__(*args, **kwargs) return super().__call__(*args, **kwargs)