1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
import time
from typing import TYPE_CHECKING, Any, Optional, Type, cast
import structlog
from celery import current_app
from celery.signals import (
after_task_publish,
before_task_publish,
task_failure,
task_prerun,
task_rejected,
task_retry,
task_revoked,
task_success,
task_unknown,
)
from . import signals
if TYPE_CHECKING: # pragma: no cover
from types import TracebackType
logger = structlog.getLogger(__name__)
class CeleryReceiver:
_priority: Optional[str]
def __init__(self) -> None:
self._priority = None
def receiver_before_task_publish(
self,
sender: Optional[Type[Any]] = None,
headers: Optional[dict[str, Any]] = None,
body: Optional[dict[str, str]] = None,
properties: Optional[dict[str, Any]] = None,
routing_key: Optional[str] = None,
**kwargs: dict[str, str],
) -> None:
if current_app.conf.task_protocol < 2:
return
context = structlog.contextvars.get_merged_contextvars(logger)
if "task_id" in context:
context["parent_task_id"] = context.pop("task_id")
signals.modify_context_before_task_publish.send(
sender=self.receiver_before_task_publish,
context=context,
task_routing_key=routing_key,
task_properties=properties,
)
if properties:
self._priority = properties.get("priority", None)
cast(dict[str, Any], headers)["__django_structlog__"] = context
def receiver_after_task_publish(
self,
sender: Optional[Type[Any]] = None,
headers: Optional[dict[str, Optional[str]]] = None,
body: Optional[dict[str, Optional[str]]] = None,
routing_key: Optional[str] = None,
**kwargs: Any,
) -> None:
properties = {}
if self._priority is not None:
properties["priority"] = self._priority
self._priority = None
logger.info(
"task_enqueued",
child_task_id=(
headers.get("id")
if headers
else cast(dict[str, Optional[str]], body).get("id")
),
child_task_name=(
headers.get("task")
if headers
else cast(dict[str, Optional[str]], body).get("task")
),
routing_key=routing_key,
**properties,
)
def receiver_task_prerun(
self, task_id: str, task: Any, *args: Any, **kwargs: Any
) -> None:
structlog.contextvars.clear_contextvars()
structlog.contextvars.bind_contextvars(task_id=task_id)
metadata = getattr(task.request, "__django_structlog__", {})
structlog.contextvars.bind_contextvars(**metadata)
signals.bind_extra_task_metadata.send(
sender=self.receiver_task_prerun, task=task, logger=logger
)
# Record the start time so we can log the task duration later.
task.request._django_structlog_started_at = time.monotonic_ns()
logger.info("task_started", task=task.name)
def receiver_task_retry(
self,
request: Optional[Any] = None,
reason: Optional[str] = None,
einfo: Optional[Any] = None,
**kwargs: Any,
) -> None:
logger.warning("task_retrying", reason=reason)
def receiver_task_success(
self, result: Optional[str] = None, sender: Optional[Any] = None, **kwargs: Any
) -> None:
signals.pre_task_succeeded.send(
sender=self.receiver_task_success, logger=logger, result=result
)
log_vars: dict[str, Any] = {}
self.add_duration_ms(sender, log_vars)
logger.info("task_succeeded", **log_vars)
def receiver_task_failure(
self,
task_id: Optional[str] = None,
exception: Optional[Exception] = None,
traceback: Optional["TracebackType"] = None,
einfo: Optional[Any] = None,
sender: Optional[Type[Any]] = None,
*args: Any,
**kwargs: Any,
) -> None:
log_vars: dict[str, Any] = {}
self.add_duration_ms(sender, log_vars)
throws = getattr(sender, "throws", ())
if isinstance(exception, throws):
logger.info(
"task_failed",
error=str(exception),
**log_vars,
)
else:
logger.exception(
"task_failed",
error=str(exception),
exception=exception,
**log_vars,
)
@classmethod
def add_duration_ms(
cls, task: Optional[Type[Any]], log_vars: dict[str, Any]
) -> None:
if task and hasattr(task.request, "_django_structlog_started_at"):
started_at: int = task.request._django_structlog_started_at
log_vars["duration_ms"] = round(
(time.monotonic_ns() - started_at) / 1_000_000
)
def receiver_task_revoked(
self,
request: Any,
terminated: Optional[bool] = None,
signum: Optional[Any] = None,
expired: Optional[Any] = None,
**kwargs: Any,
) -> None:
metadata = getattr(request, "__django_structlog__", {}).copy()
metadata["task_id"] = request.id
metadata["task"] = request.task
logger.warning(
"task_revoked",
terminated=terminated,
signum=signum.value if signum is not None else None,
signame=signum.name if signum is not None else None,
expired=expired,
**metadata,
)
def receiver_task_unknown(
self,
message: Optional[str] = None,
exc: Optional[Exception] = None,
name: Optional[str] = None,
id: Optional[str] = None,
**kwargs: Any,
) -> None:
logger.error(
"task_not_found",
task=name,
task_id=id,
)
def receiver_task_rejected(
self, message: Any, exc: Optional[Exception] = None, **kwargs: Any
) -> None:
logger.exception(
"task_rejected", task_id=message.properties.get("correlation_id")
)
def connect_signals(self) -> None:
before_task_publish.connect(self.receiver_before_task_publish)
after_task_publish.connect(self.receiver_after_task_publish)
def connect_worker_signals(self) -> None:
before_task_publish.connect(self.receiver_before_task_publish)
after_task_publish.connect(self.receiver_after_task_publish)
task_prerun.connect(self.receiver_task_prerun)
task_retry.connect(self.receiver_task_retry)
task_success.connect(self.receiver_task_success)
task_failure.connect(self.receiver_task_failure)
task_revoked.connect(self.receiver_task_revoked)
task_unknown.connect(self.receiver_task_unknown)
task_rejected.connect(self.receiver_task_rejected)
|
