mirror of
https://github.com/GSA/notifications-api.git
synced 2026-02-04 02:11:11 -05:00
Enable request tracing on Celery success/fail logs
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:
@@ -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,7 +36,16 @@ 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):
|
||||||
|
# enables request id tracing for these logs
|
||||||
|
with self.app_context():
|
||||||
elapsed_time = time.monotonic() - self.start
|
elapsed_time = time.monotonic() - self.start
|
||||||
|
|
||||||
app.logger.info(
|
app.logger.info(
|
||||||
@@ -54,6 +64,8 @@ def make_task(app):
|
|||||||
)
|
)
|
||||||
|
|
||||||
def on_failure(self, exc, task_id, args, kwargs, einfo):
|
def on_failure(self, exc, task_id, args, kwargs, einfo):
|
||||||
|
# enables request id tracing for these logs
|
||||||
|
with self.app_context():
|
||||||
app.logger.exception(
|
app.logger.exception(
|
||||||
"Celery task {task_name} (queue: {queue_name}) failed".format(
|
"Celery task {task_name} (queue: {queue_name}) failed".format(
|
||||||
task_name=self.name,
|
task_name=self.name,
|
||||||
@@ -72,12 +84,10 @@ def make_task(app):
|
|||||||
|
|
||||||
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)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user