From 27ae27cdea7bd70c5111b7b39a7a8030ab2a20a6 Mon Sep 17 00:00:00 2001 From: Joseph Spiker Date: Tue, 6 Oct 2026 04:45:03 -0400 Subject: [PATCH] docs: correct Event Handlers in the beta README spikersoft-backend@master SpikerSoft.EventHandlers.GpuHeartbeat/Program.cs:9 Co-authored-by: Cursor --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9f3658d..927a1d7 100644 --- a/README.md +++ b/README.md @@ -2402,7 +2402,7 @@ Event handlers (quiz generation, embeddings, uploads, etc.) publish notification ## Event Handlers -SpikerSoft uses a distributed event handler architecture where specialized microservices consume messages from RabbitMQ queues. Each handler is a standalone .NET worker service built on the shared `EventHandlerHostBuilder` infrastructure. +SpikerSoft uses a distributed event handler architecture. The .NET workers are standalone services built on the shared `EventHandlerHostBuilder`, and most of them consume RabbitMQ queues. `ImageDescription.Python` is a Python vision worker, not a .NET host. `GpuHeartbeat` only publishes VRAM readings. `Mail` answers Postfix policy checks and does not consume a queue. ### Handler Inventory @@ -2416,25 +2416,27 @@ SpikerSoft uses a distributed event handler architecture where specialized micro | **CalendarReminders** | Calendar reminder notification dispatch | | **CodeExecution** | Sandboxed user code execution worker (request/response queues, 4 concurrent consumers; also the lesson-regrade RPC lane) | | **Decompile** | RabbitMQ direct-reply-to RPC into ICSharpCode.Decompiler (the decompiler dev tool) | -| **DockerMonitor** | Docker host monitoring and event publishing to Redis | +| **DockerMonitor** | Docker host monitoring; publishes cluster events on RabbitMQ (`cluster.events`) and keeps a Redis topology cache | | **Embeddings** | Vector embedding generation for book text chunks (LLamaSharp, GPU-scheduled) | | **FileMovement** | File transfer between staging and final storage locations | | **GameEvents** | Game state persistence and Redis hot-path dual-writes for the game server | | **GpuCoordinator** | Cluster-wide GPU VRAM lease broker, queue scheduling, and `/gpu/status` HTTP API (see [Art Studio](#art-studio)) | -| **ImageDescription.Python** | Vision-model image description for book images (Qwen-VL, GPU-scheduled) | -| **InfluxDashboard** | InfluxDB metrics ingestion and `DashboardHub` SignalR streaming | +| **GpuHeartbeat** | One replica per GPU node; publishes that card's real total and free VRAM on `gpu.node.heartbeat` so the coordinator can schedule on measured capacity | +| **ImageDescription.Python** | Vision-model image description for book images (Qwen3-VL, GPU-scheduled) | +| **InfluxDashboard** | Polls InfluxDB for host metrics and publishes them for the API to stream on `DashboardHub` | | **KeycloakEvents** | Keycloak identity event synchronization into the platform | | **LessonVideoProcessor** | Lesson video processing + moderation pipeline | +| **Mail** | Postfix policy service for the mail platform: records each SMTP transaction in `mail-events`, and enforces sanctions and rate limits only when `Mail:Policy:Mode` is `Enforce` (the shipped mode is `Observe`) | | **MetadataExtractor** | PDF/EPUB metadata extraction (Aspose, VersOne.Epub) | | **NodeAgent** | One replica per swarm node: tails the systemd journal + samples host health/disk into `system.events` (see [Ops, Fleet & Status](#ops-fleet--status)) | -| **Notifications** | SMS / voice / phone-lookup / verify lanes (`notifications.{sms,voice,verify,phone}.*`) | +| **Notifications** | SMS / voice / email / phone-lookup / verify lanes (`notifications.{sms,voice,email,verify,phone}.*`) | | **Ocr** | Passport-OCR RPC lane (`ocr.passport.*`) | | **PhotographProcessor** | Photo pipeline: receive → scan → metadata extract → move (see [Photography & Gallery](#photography--gallery)) | | **QuizGeneration** | LLM-powered quiz generation from book content (GPU-scheduled) | | **Scheduler** | Scheduled task execution (GeoIP updates, HTTP callbacks) | | **SecurityMonitor** | Redis-backed stateful detectors over `system.events` producing security alerts | | **SecurityScanner** | Uploaded content security scanning | -| **SystemRemediation** | Rule engine over system events: dedupes incidents, dispatches curated SAFE remediations or alerts operators | +| **SystemRemediation** | Rule engine over system events: dedupes incidents and alerts operators. Shipped posture is recommend-only; a SAFE command is dispatched only when `Remediation:Mode` is `auto` and `DispatchCommands` is true | | **UploadCoordinator** | Orchestrates the full book/upload lifecycle across processing stages | Plus three non-handler **worker libraries** consumed by the handlers: `SpikerSoft.Workers.{Decompile,Notifications,Ocr}`. @@ -2448,7 +2450,7 @@ The queue set is code-derived and grows with the handler fleet — treat the han | `code.execution.*` + `lesson.regrade.*` | Sandboxed grading (live submit + offline re-grade RPC) | | `book.create.requests`, `image.extraction`, `metadata.extraction.requests`, `quiz.generation`, `upload.lifecycle`, `file.operations`, `security.scan.requests` | Book/upload processing pipeline | | `game.events` (+ `game.events.dlx`), `game.persistence.events` (+ dlq) | Game server persistence | -| `art.asset.*`, `art.model.*`, `artpipe.*` | Art Studio stage dispatch + per-model queues + lifecycle events | +| `art.asset.*`, `art.model.*` | Art Studio stage dispatch + per-model queues + lifecycle events | | `gpu.lease.*` | GPU coordinator lease protocol | | `photograph.*` | Photo pipeline | | `decompile.*`, `ocr.passport.*` | Direct-reply-to RPC lanes |