Änderungen von Dokument NATS - Technisches Setup

Zuletzt geändert von Daniel Herrmann am 2026/10/13 10:36

Von Version Icon 21.2 Icon
bearbeitet von Daniel Herrmann
am 2026/07/26 16:08
Änderungskommentar: Während der Zusammenarbeit in Echtzeit automatisch gespeichert
Auf Version Icon 25.1
bearbeitet von Daniel Herrmann
am 2026/10/13 10:36
Änderungskommentar: [AI] Taskiq Task Queue von NATS Core auf JetStream umgestellt (Stream MKSP_TASKS), Verbindungsübersicht aktualisiert

Zusammenfassung

Details

Icon Seiteneigenschaften
Inhalt
... ... @@ -83,9 +83,9 @@
83 83  
84 84  Da ein User nur einem Account zugeordnet werden kann, gibt es einen admin User für administrative Tätigkeiten sowie einen JetStream Admin User für die Account-Verwaltung.
85 85  
86 -== NATS Core mit Accounts ==
86 +== Berechtigungen des Backend Users ==
87 87  
88 -Damit die NATS Core Messages auch weiterhin funktionieren müssen publish und subscribe Berechtigungen vergeben werden. NATS wird neben dem Eventmanagement auch noch für die Task Queue mit Taskiq eingesetzt, hier werden zur Zeit noch Core Funktionalitäten verwendet. Daher muss die Berechtigung für den backend User erweitert werden:
88 +NATS wird neben dem Eventmanagement auch für die Task Queue mit Taskiq eingesetzt. Beides läuft über JetStream, NATS Core Subjects (früher ##taskiq_tasks## mit einer Queue Group) werden nicht mehr verwendet. Das Backend legt den Stream für die Task Queue selbst an und aktualisiert ihn (siehe [[Task Queue (Taskiq)>>||anchor="HTaskQueue28Taskiq29"]]), benötigt also Zugriff auf die JetStream API. Der backend User hat daher aktuell weiterhin weitreichende Berechtigungen:
89 89  
90 90  {{code}}
91 91  accounts: {
... ... @@ -101,7 +101,7 @@
101 101  ...
102 102  {{/code}}
103 103  
104 -Wichtig sind hier die zusätzlichen Permissions, die den Zugriff auf Core Events regeln.
104 +Backend, Worker und Scheduler verwenden alle dasselbe Zertifikat und damit denselben User. Eine Einschränkung auf die tatsächlich benötigten Subjects (##mksp.>##, ##tasks.mksp.backend##, JetStream API für ##MKSP_TASKS##, ##_INBOX.>##) ist noch offen.
105 105  
106 106  == JetStream Konfiguration ==
107 107  
... ... @@ -136,6 +136,20 @@
136 136  nats stream add backend_events --subjects "mksp.>" --retention work --max-age 7d --storage file --defaults
137 137  {{/code}}
138 138  
139 +=== Task Queue (Taskiq) ===
140 +
141 +Die asynchronen Tasks zwischen Backend und Worker laufen über einen eigenen Stream. Dieser wird **nicht** manuell angelegt: Backend, Worker und Scheduler legen ihn beim Start an und passen ihn an, falls die Konfiguration im Code (##src/worker/broker.py##) abweicht. Änderungen daher bitte im Code und nicht über die NATS CLI vornehmen.
142 +
143 +|=Eigenschaft|=Wert|=Beschreibung
144 +|Stream|##MKSP_TASKS##|Work-Queue Stream, Nachrichten werden nach der Bestätigung gelöscht
145 +|Subject|##tasks.mksp.backend##|Muss außerhalb von ##mksp.>## liegen, da dieser Bereich bereits vom Stream **backend_events** belegt ist
146 +|Consumer|##mksp_backend_worker##|Dauerhafter Pull Consumer, wird nur vom Worker angelegt. Mehrere Worker-Prozesse teilen sich den Consumer
147 +|Max Age|7 Tage|Tasks, die bis dahin kein Worker abgeholt hat, verfallen
148 +|Ack|beim Empfang|Der Worker bestätigt einen Task sofort beim Abholen (##~-~-ack-type when_received##). Ein Task läuft so nie doppelt, bei einem Absturz des Workers während der Ausführung geht er aber verloren. Ack Wait (5 Minuten) ist nur eine Absicherung
149 +|Message TTL|bis zum nächsten Lauf|Vom Scheduler eingeplante Tasks bekommen einen ##Nats-TTL## Header bis zum nächsten Cron-Zeitpunkt. Ist der Worker länger nicht erreichbar, staut sich so pro Cron-Task höchstens ein Lauf auf
150 +
151 +Tasks, die erstellt werden während der Worker nicht läuft, bleiben damit im Stream liegen und werden abgearbeitet, sobald der Worker wieder verfügbar ist. Per-Message TTL setzt NATS Server 2.11 oder neuer voraus.
152 +
139 139  === JetStream Consumer ===
140 140  
141 141  Consumer sind eine Auswahl / Ansicht von Teilen eines Streams. Details finden sich wieder in der NATS Dokumentation: [[https:~~/~~/docs.nats.io/nats-concepts/jetstream/consumers>>url:https://docs.nats.io/nats-concepts/jetstream/consumers||shape="rect"]]
... ... @@ -251,15 +251,26 @@
251 251  )))|docuseal_signature_completed|(((
252 252  SignatureEvent
253 253  )))
254 -|mksp.backend.key.activate| |(((
255 -KeyEvent
256 -)))
257 -|mksp.backend.key.deactivate| |(((
258 -KeyEvent
259 -)))
260 -|mksp.backend.user.membership_changed| |
261 -|mksp.backend.user.deleted| |
262 -|mksp.backend.department.head_membership_changed| |
268 +|mksp.backend.key.activate|backend_key_activate|KeyEvent
269 +|mksp.backend.key.deactivate|backend_key_deactivate|KeyEvent
270 +|mksp.backend.user.membership_changed|backend_user_membership_changed|MembershipChangedEvent
271 +|mksp.backend.user.deleted|backend_user_deleted|UserDeletedEvent
272 +|mksp.backend.department.head_membership_changed|backend_department_head_membership_changed|DepartmentHeadMembershipEvent
273 +|(((
274 +mksp.backend.device.event.locked
275 +)))|backend_device_event_locked|
276 +|(((
277 +mksp.backend.device.event.unlocked
278 +)))|backend_device_event_unlocked|
279 +|(((
280 +mksp.backend.device.event.access_granted
281 +)))|backend_device_event_access_granted|
282 +|(((
283 +mksp.backend.device.event.offline
284 +)))|backend_device_event_offline|
285 +|(((
286 +mksp.backend.device.event.access_denied
287 +)))|backend_device_event_access_denied|
263 263  
264 264  Die Consumer können dann wie folgt angelegt werden:
265 265  
... ... @@ -279,7 +279,7 @@
279 279  
280 280  === Streams ===
281 281  
282 -Man kann sich die vorhandenen Streams und die Anzahl der Nachrichten anschauen. Die Anzahl sollte üblicherweise 0 sein, wenn die Zahl höher ist, werden Events nicht richtig abgearbeitet.
307 +Man kann sich die vorhandenen Streams und die Anzahl der Nachrichten anschauen. Die Anzahl sollte üblicherweise 0 sein, wenn die Zahl höher ist, werden Events nicht richtig abgearbeitet. Neben **backend_events** gibt es den Stream **MKSP_TASKS** der Task Queue; liegen dort dauerhaft Nachrichten, läuft der Worker nicht oder holt keine Tasks ab (prüfen mit ##nats consumer info MKSP_TASKS mksp_backend_worker##).
283 283  
284 284  {{code language="shell"}}
285 285  $ nats context select mksp-jsadmin
... ... @@ -390,8 +390,10 @@
390 390  ╰──────────────┴─────────┴─────────────╯
391 391  {{/code}}
392 392  
393 -Der Name ist hierbei frei vergeben, in unserem Fall im Backend Code. Wir erwarten die folgenden Clients:
418 +Die Ausgabe oben stammt aus der Zeit vor der Umstellung der Task Queue auf JetStream, die Verbindung **backend_fastapi** gibt es inzwischen nicht mehr.
394 394  
420 +Der Name ist hierbei frei vergeben, in unserem Fall im Backend Code (abhängig von der Rolle des Prozesses). Jeder Prozess hält genau eine Verbindung, über die sowohl Tasks als auch Events laufen. Wir erwarten die folgenden Clients:
421 +
395 395  |=(((
396 396  Client
397 397  )))|=(((
... ... @@ -408,11 +408,11 @@
408 408  )))|(((
409 409  1
410 410  )))|(((
411 -Taskiq
438 +FastAPI / Taskiq
412 412  )))|(((
413 -Core
440 +JetStream
414 414  )))|(((
415 -Gibt dem Backend die Möglichkeit, asynchrone Tasks an das Taskiq backend zu delegieren
442 +Delegiert asynchrone Tasks an den Worker und gibt Events aus, die dann von N8n abgearbeitet werden
416 416  )))
417 417  |(((
418 418  backend_scheduler
... ... @@ -421,31 +421,20 @@
421 421  )))|(((
422 422  Taskiq
423 423  )))|(((
424 -Core
451 +JetStream
425 425  )))|(((
426 426  Komponente welches die regelmäßigen Jobs überwacht und triggert
427 427  )))
428 428  |(((
429 -backend_fastapi
430 -)))|(((
431 -1
432 -)))|(((
433 -FastAPI
434 -)))|(((
435 -JetStream
436 -)))|(((
437 -Das Backend kann hiermit Events ausgeben, die dann von N8n abgearbeitet werden.
438 -)))
439 -|(((
440 440  backend_worker
441 441  )))|(((
442 -2
458 +2 (ein Client pro Worker-Prozess, ##NUM_WORKERS##)
443 443  )))|(((
444 444  Taskiq
445 445  )))|(((
446 -Core
462 +JetStream
447 447  )))|(((
448 -Worker für asynchrone Tasks
464 +Worker für asynchrone Tasks, gibt ebenfalls Events aus
449 449  )))
450 450  
451 451  Man kann sich ebenfalls die Subscriptions der jeweiligen Connections anschauen. Hierfür muss die Ausgabe auf JSON umgestellt werden:
... ... @@ -508,4 +508,6 @@
508 508   ]
509 509  {{/code}}
510 510  
527 +Auch diese Ausgabe stammt aus der Zeit vor der JetStream-Umstellung: Die Subscription auf ##taskiq_tasks## gibt es nicht mehr, der Worker holt Tasks über den Pull Consumer ##mksp_backend_worker## ab.
528 +
511 511