-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmanager.py
More file actions
544 lines (460 loc) · 20.6 KB
/
manager.py
File metadata and controls
544 lines (460 loc) · 20.6 KB
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
import asyncio
import json
import logging
from datetime import datetime, timezone
from typing import Any, Awaitable, Callable
from aiokafka import AIOKafkaConsumer, AIOKafkaProducer
from aiokafka.errors import KafkaError
from opentelemetry.trace import SpanKind
from app.core.lifecycle import LifecycleEnabled
from app.core.metrics.context import get_dlq_metrics
from app.core.tracing import EventAttributes
from app.core.tracing.utils import extract_trace_context, get_tracer, inject_trace_context
from app.db.docs import DLQMessageDocument
from app.dlq.models import (
DLQBatchRetryResult,
DLQMessage,
DLQMessageStatus,
DLQMessageUpdate,
DLQRetryResult,
RetryPolicy,
RetryStrategy,
)
from app.domain.enums.kafka import GroupId, KafkaTopic
from app.events.schema.schema_registry import SchemaRegistryManager
from app.settings import Settings
class DLQManager(LifecycleEnabled):
def __init__(
self,
settings: Settings,
consumer: AIOKafkaConsumer,
producer: AIOKafkaProducer,
schema_registry: SchemaRegistryManager,
logger: logging.Logger,
dlq_topic: KafkaTopic = KafkaTopic.DEAD_LETTER_QUEUE,
retry_topic_suffix: str = "-retry",
default_retry_policy: RetryPolicy | None = None,
):
super().__init__()
self.settings = settings
self.metrics = get_dlq_metrics()
self.schema_registry = schema_registry
self.logger = logger
self.dlq_topic = dlq_topic
self.retry_topic_suffix = retry_topic_suffix
self.default_retry_policy = default_retry_policy or RetryPolicy(
topic="default", strategy=RetryStrategy.EXPONENTIAL_BACKOFF
)
self.consumer: AIOKafkaConsumer = consumer
self.producer: AIOKafkaProducer = producer
self._process_task: asyncio.Task[None] | None = None
self._monitor_task: asyncio.Task[None] | None = None
# Topic-specific retry policies
self._retry_policies: dict[str, RetryPolicy] = {}
# Message filters
self._filters: list[Callable[[DLQMessage], bool]] = []
# Retry callbacks - all must be async
self._callbacks: dict[str, list[Callable[..., Awaitable[None]]]] = {
"before_retry": [],
"after_retry": [],
"on_discard": [],
}
def _doc_to_message(self, doc: DLQMessageDocument) -> DLQMessage:
"""Convert DLQMessageDocument to DLQMessage domain model."""
event = self.schema_registry.deserialize_json(doc.event)
return DLQMessage(
event_id=doc.event_id,
event=event,
event_type=doc.event_type,
original_topic=doc.original_topic,
error=doc.error,
retry_count=doc.retry_count,
failed_at=doc.failed_at,
status=doc.status,
producer_id=doc.producer_id,
created_at=doc.created_at,
last_updated=doc.last_updated,
next_retry_at=doc.next_retry_at,
retried_at=doc.retried_at,
discarded_at=doc.discarded_at,
discard_reason=doc.discard_reason,
dlq_offset=doc.dlq_offset,
dlq_partition=doc.dlq_partition,
last_error=doc.last_error,
headers=doc.headers,
)
def _message_to_doc(self, message: DLQMessage) -> DLQMessageDocument:
"""Convert DLQMessage domain model to DLQMessageDocument."""
return DLQMessageDocument(
event=message.event.model_dump(),
event_id=message.event_id,
event_type=message.event_type,
original_topic=message.original_topic,
error=message.error,
retry_count=message.retry_count,
failed_at=message.failed_at,
status=message.status,
producer_id=message.producer_id,
created_at=message.created_at or datetime.now(timezone.utc),
last_updated=message.last_updated,
next_retry_at=message.next_retry_at,
retried_at=message.retried_at,
discarded_at=message.discarded_at,
discard_reason=message.discard_reason,
dlq_offset=message.dlq_offset,
dlq_partition=message.dlq_partition,
last_error=message.last_error,
headers=message.headers,
)
def _kafka_msg_to_message(self, msg: Any) -> DLQMessage:
"""Parse Kafka ConsumerRecord into DLQMessage."""
raw_bytes = msg.value
raw: str = raw_bytes.decode("utf-8") if isinstance(raw_bytes, (bytes, bytearray)) else str(raw_bytes or "")
data: dict[str, Any] = json.loads(raw) if raw else {}
headers_list = msg.headers or []
headers: dict[str, str] = {}
for k, v in headers_list:
headers[str(k)] = v.decode("utf-8") if isinstance(v, (bytes, bytearray)) else (v or "")
event = self.schema_registry.deserialize_json(data.get("event", data))
return DLQMessage(
event_id=data.get("event_id", event.event_id),
event=event,
event_type=event.event_type,
original_topic=data.get("original_topic", headers.get("original_topic", "")),
error=data.get("error", headers.get("error", "Unknown error")),
retry_count=data.get("retry_count", int(headers.get("retry_count", 0))),
failed_at=datetime.fromisoformat(data["failed_at"])
if data.get("failed_at")
else datetime.now(timezone.utc),
status=DLQMessageStatus(data.get("status", DLQMessageStatus.PENDING)),
producer_id=data.get("producer_id", headers.get("producer_id", "unknown")),
dlq_offset=msg.offset,
dlq_partition=msg.partition,
headers=headers,
)
async def _on_start(self) -> None:
"""Start DLQ manager."""
# Start producer and consumer
await self.producer.start()
await self.consumer.start()
# Start processing tasks
self._process_task = asyncio.create_task(self._process_messages())
self._monitor_task = asyncio.create_task(self._monitor_dlq())
self.logger.info("DLQ Manager started")
async def _on_stop(self) -> None:
"""Stop DLQ manager."""
# Cancel tasks
for task in [self._process_task, self._monitor_task]:
if task:
task.cancel()
try:
await task
except asyncio.CancelledError:
pass
# Stop Kafka clients
await self.consumer.stop()
await self.producer.stop()
self.logger.info("DLQ Manager stopped")
async def _process_messages(self) -> None:
while self.is_running:
try:
msg = await self._poll_message()
if msg is None:
continue
start_time = asyncio.get_running_loop().time()
dlq_message = self._kafka_msg_to_message(msg)
await self._record_message_metrics(dlq_message)
await self._process_message_with_tracing(msg, dlq_message)
await self._commit_and_record_duration(start_time)
except Exception as e:
self.logger.error(f"Error in DLQ processing loop: {e}")
await asyncio.sleep(5)
async def _poll_message(self) -> Any | None:
"""Poll for a message from Kafka using async getone()."""
try:
return await asyncio.wait_for(self.consumer.getone(), timeout=1.0)
except asyncio.TimeoutError:
return None
except KafkaError as e:
self.logger.error(f"Consumer error: {e}")
return None
def _extract_headers(self, msg: Any) -> dict[str, str]:
"""Extract headers from Kafka ConsumerRecord."""
headers_list = msg.headers or []
headers: dict[str, str] = {}
for k, v in headers_list:
headers[str(k)] = v.decode("utf-8") if isinstance(v, (bytes, bytearray)) else (v or "")
return headers
async def _record_message_metrics(self, dlq_message: DLQMessage) -> None:
"""Record metrics for received DLQ message."""
self.metrics.record_dlq_message_received(dlq_message.original_topic, dlq_message.event_type)
self.metrics.record_dlq_message_age(dlq_message.age_seconds)
async def _process_message_with_tracing(self, msg: Any, dlq_message: DLQMessage) -> None:
"""Process message with distributed tracing."""
headers = self._extract_headers(msg)
ctx = extract_trace_context(headers)
tracer = get_tracer()
with tracer.start_as_current_span(
name="dlq.consume",
context=ctx,
kind=SpanKind.CONSUMER,
attributes={
EventAttributes.KAFKA_TOPIC: self.dlq_topic,
EventAttributes.EVENT_TYPE: dlq_message.event_type,
EventAttributes.EVENT_ID: dlq_message.event_id or "",
},
):
await self._process_dlq_message(dlq_message)
async def _commit_and_record_duration(self, start_time: float) -> None:
"""Commit offset and record processing duration."""
await self.consumer.commit()
duration = asyncio.get_running_loop().time() - start_time
self.metrics.record_dlq_processing_duration(duration, "process")
async def _process_dlq_message(self, message: DLQMessage) -> None:
# Apply filters
for filter_func in self._filters:
if not filter_func(message):
self.logger.info("Message filtered out", extra={"event_id": message.event_id})
return
# Store in MongoDB via Beanie
await self._store_message(message)
# Get retry policy for topic
retry_policy = self._retry_policies.get(message.original_topic, self.default_retry_policy)
# Check if should retry
if not retry_policy.should_retry(message):
await self._discard_message(message, "max_retries_exceeded")
return
# Calculate next retry time
next_retry = retry_policy.get_next_retry_time(message)
# Update message status
await self._update_message_status(
message.event_id,
DLQMessageUpdate(status=DLQMessageStatus.SCHEDULED, next_retry_at=next_retry),
)
# If immediate retry, process now
if retry_policy.strategy == RetryStrategy.IMMEDIATE:
await self._retry_message(message)
async def _store_message(self, message: DLQMessage) -> None:
# Ensure message has proper status and timestamps
message.status = DLQMessageStatus.PENDING
message.last_updated = datetime.now(timezone.utc)
doc = self._message_to_doc(message)
# Upsert using Beanie
existing = await DLQMessageDocument.find_one({"event_id": message.event_id})
if existing:
doc.id = existing.id
await doc.save()
async def _update_message_status(self, event_id: str, update: DLQMessageUpdate) -> None:
doc = await DLQMessageDocument.find_one({"event_id": event_id})
if not doc:
return
update_dict: dict[str, Any] = {"status": update.status, "last_updated": datetime.now(timezone.utc)}
if update.next_retry_at is not None:
update_dict["next_retry_at"] = update.next_retry_at
if update.retried_at is not None:
update_dict["retried_at"] = update.retried_at
if update.discarded_at is not None:
update_dict["discarded_at"] = update.discarded_at
if update.retry_count is not None:
update_dict["retry_count"] = update.retry_count
if update.discard_reason is not None:
update_dict["discard_reason"] = update.discard_reason
if update.last_error is not None:
update_dict["last_error"] = update.last_error
await doc.set(update_dict)
async def _retry_message(self, message: DLQMessage) -> None:
# Trigger before_retry callbacks
await self._trigger_callbacks("before_retry", message)
# Send to retry topic first (for monitoring)
retry_topic = f"{message.original_topic}{self.retry_topic_suffix}"
hdrs: dict[str, str] = {
"dlq_retry_count": str(message.retry_count + 1),
"dlq_original_error": message.error,
"dlq_retry_timestamp": datetime.now(timezone.utc).isoformat(),
}
hdrs = inject_trace_context(hdrs)
kafka_headers: list[tuple[str, bytes]] = [(k, v.encode()) for k, v in hdrs.items()]
# Get the original event
event = message.event
# Send to retry topic
await self.producer.send_and_wait(
topic=retry_topic,
value=json.dumps(event.to_dict()).encode(),
key=message.event_id.encode(),
headers=kafka_headers,
)
# Send to original topic
await self.producer.send_and_wait(
topic=message.original_topic,
value=json.dumps(event.to_dict()).encode(),
key=message.event_id.encode(),
headers=kafka_headers,
)
# Update metrics
self.metrics.record_dlq_message_retried(message.original_topic, message.event_type, "success")
# Update status
await self._update_message_status(
message.event_id,
DLQMessageUpdate(
status=DLQMessageStatus.RETRIED,
retried_at=datetime.now(timezone.utc),
retry_count=message.retry_count + 1,
),
)
# Trigger after_retry callbacks
await self._trigger_callbacks("after_retry", message, success=True)
self.logger.info("Successfully retried message", extra={"event_id": message.event_id})
async def _discard_message(self, message: DLQMessage, reason: str) -> None:
# Update metrics
self.metrics.record_dlq_message_discarded(message.original_topic, message.event_type, reason)
# Update status
await self._update_message_status(
message.event_id,
DLQMessageUpdate(
status=DLQMessageStatus.DISCARDED,
discarded_at=datetime.now(timezone.utc),
discard_reason=reason,
),
)
# Trigger callbacks
await self._trigger_callbacks("on_discard", message, reason)
self.logger.warning("Discarded message", extra={"event_id": message.event_id, "reason": reason})
async def _monitor_dlq(self) -> None:
while self.is_running:
try:
# Find messages ready for retry using Beanie
now = datetime.now(timezone.utc)
docs = (
await DLQMessageDocument.find(
{
"status": DLQMessageStatus.SCHEDULED,
"next_retry_at": {"$lte": now},
}
)
.limit(100)
.to_list()
)
for doc in docs:
message = self._doc_to_message(doc)
await self._retry_message(message)
# Update queue size metrics
await self._update_queue_metrics()
# Sleep before next check
await asyncio.sleep(10)
except Exception as e:
self.logger.error(f"Error in DLQ monitor: {e}")
await asyncio.sleep(60)
async def _update_queue_metrics(self) -> None:
# Get counts by topic using Beanie aggregation
pipeline: list[dict[str, Any]] = [
{"$match": {"status": {"$in": [DLQMessageStatus.PENDING, DLQMessageStatus.SCHEDULED]}}},
{"$group": {"_id": "$original_topic", "count": {"$sum": 1}}},
]
async for result in DLQMessageDocument.aggregate(pipeline):
self.metrics.update_dlq_queue_size(result["_id"], result["count"])
def set_retry_policy(self, topic: str, policy: RetryPolicy) -> None:
self._retry_policies[topic] = policy
def add_filter(self, filter_func: Callable[[DLQMessage], bool]) -> None:
self._filters.append(filter_func)
def add_callback(self, event_type: str, callback: Callable[..., Awaitable[None]]) -> None:
if event_type in self._callbacks:
self._callbacks[event_type].append(callback)
async def _trigger_callbacks(self, event_type: str, *args: Any, **kwargs: Any) -> None:
for callback in self._callbacks.get(event_type, []):
try:
await callback(*args, **kwargs)
except Exception as e:
self.logger.error(f"Error in DLQ callback {callback.__name__}: {e}")
async def retry_message_manually(self, event_id: str) -> bool:
doc = await DLQMessageDocument.find_one({"event_id": event_id})
if not doc:
self.logger.error("Message not found in DLQ", extra={"event_id": event_id})
return False
# Guard against invalid states
if doc.status in {DLQMessageStatus.DISCARDED, DLQMessageStatus.RETRIED}:
self.logger.info("Skipping manual retry", extra={"event_id": event_id, "status": doc.status})
return False
message = self._doc_to_message(doc)
await self._retry_message(message)
return True
async def retry_messages_batch(self, event_ids: list[str]) -> DLQBatchRetryResult:
"""Retry multiple DLQ messages in batch.
Args:
event_ids: List of event IDs to retry
Returns:
Batch result with success/failure counts and details
"""
details: list[DLQRetryResult] = []
successful = 0
failed = 0
for event_id in event_ids:
try:
success = await self.retry_message_manually(event_id)
if success:
successful += 1
details.append(DLQRetryResult(event_id=event_id, status="success"))
else:
failed += 1
details.append(DLQRetryResult(event_id=event_id, status="failed", error="Retry failed"))
except Exception as e:
self.logger.error(f"Error retrying message {event_id}: {e}")
failed += 1
details.append(DLQRetryResult(event_id=event_id, status="failed", error=str(e)))
return DLQBatchRetryResult(total=len(event_ids), successful=successful, failed=failed, details=details)
async def discard_message_manually(self, event_id: str, reason: str) -> bool:
"""Manually discard a DLQ message with state validation.
Args:
event_id: The event ID to discard
reason: Reason for discarding
Returns:
True if discarded, False if not found or in terminal state
"""
doc = await DLQMessageDocument.find_one({"event_id": event_id})
if not doc:
self.logger.error("Message not found in DLQ", extra={"event_id": event_id})
return False
# Guard against invalid states (terminal states)
if doc.status in {DLQMessageStatus.DISCARDED, DLQMessageStatus.RETRIED}:
self.logger.info("Skipping manual discard", extra={"event_id": event_id, "status": doc.status})
return False
message = self._doc_to_message(doc)
await self._discard_message(message, reason)
return True
def create_dlq_manager(
settings: Settings,
schema_registry: SchemaRegistryManager,
logger: logging.Logger,
dlq_topic: KafkaTopic = KafkaTopic.DEAD_LETTER_QUEUE,
retry_topic_suffix: str = "-retry",
default_retry_policy: RetryPolicy | None = None,
) -> DLQManager:
topic_name = f"{settings.KAFKA_TOPIC_PREFIX}{dlq_topic}"
consumer = AIOKafkaConsumer(
topic_name,
bootstrap_servers=settings.KAFKA_BOOTSTRAP_SERVERS,
group_id=f"{GroupId.DLQ_MANAGER}.{settings.KAFKA_GROUP_SUFFIX}",
enable_auto_commit=False,
auto_offset_reset="earliest",
client_id="dlq-manager-consumer",
)
producer = AIOKafkaProducer(
bootstrap_servers=settings.KAFKA_BOOTSTRAP_SERVERS,
client_id="dlq-manager-producer",
acks="all",
compression_type="gzip",
max_batch_size=16384,
linger_ms=10,
enable_idempotence=True,
)
if default_retry_policy is None:
default_retry_policy = RetryPolicy(topic="default", strategy=RetryStrategy.EXPONENTIAL_BACKOFF)
return DLQManager(
settings=settings,
consumer=consumer,
producer=producer,
schema_registry=schema_registry,
logger=logger,
dlq_topic=dlq_topic,
retry_topic_suffix=retry_topic_suffix,
default_retry_policy=default_retry_policy,
)