Dev (#68)

* chore(api): Add startup animation, logger config, and API dev script (#63) (#64)

* chore(api): Add startup animation, logger config, and API dev script (#63)

* docs: sync from Outline

* 66 logger x docker client the current workers do not forward their logs (#67)

* refactor(logging): Standardize cross-process log handling and improve UI

Introduces a centralized logging mechanism to forward log entries generated by workers to the main process. This ensures all application logs are consistently processed and displayed.

- **Logger:** Made `Logger.emitLogEntry` public and enhanced it to accept metadata for accurate log re-emission from various sources. Added a visual indicator for log hooks in formatted messages.
- **Docker Client:**
  - Implemented `WorkerLogger` in `docker-client` workers to proxy log entries via a new `__log__` event.
  - The `docker-client` manager now listens for and re-emits `__log__` events through the main logger.
  - Refactored worker-related types (`InboundMessage`, `InitMessage`, `MetricsMessage`) and utility functions (`tryBuildFromProxy`) into dedicated shared files for better organization.
- **Typings:** Defined `LogLevel`, `LogEntry` types, and added the `__log__` event to the `EVENTS` interface to support structured log forwarding.
- **UI:** Updated the `Sidebar` to display the unified log stream with improved formatting, including colored log levels, badges for logger names/request IDs, and a new `log` timestamp format.
- **Utils:** Added a new `log` format to `formatDate` and standardized the default locale for date formatting to `de-DE`.
- **Dependencies:** Upgraded `@dockstat/docker-client` to `2.0.0` and numerous other dependencies (e.g., `framer-motion`, `react-router`, `@types/node`) to their latest patch/minor versions.
- **Cleanup:** Removed a debug `console.log` statement from `plugin-handler`.

* refactor(logging, client): improve logging detail and worker robustness

Update .env.example with refined default logger configurations to reduce noise and focus on `PluginHandler` messages. Forward `requestId` within `__log__` events to enhance log correlation. Strengthen worker initialization checks by explicitly verifying `message.success`. Streamline event typings by removing `workerLoggerResponse`. Includes minor import reordering and variable name correction for consistency.

* [ImgBot] Optimize images (#65)

* chore(api): Add startup animation, logger config, and API dev script (#63)

* docs: sync from Outline

* [ImgBot] Optimize images

*Total -- 389.34kb -> 261.94kb (32.72%)

/.github/assets/logos/square.png -- 81.10kb -> 20.42kb (74.82%)
/.github/assets/gifs/DockStatAPI-startup.gif -- 306.82kb -> 240.10kb (21.74%)
/packages/ui/public/vite.svg -- 1.42kb -> 1.42kb (0.07%)

Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>

* chore(assets): Add and organize GitHub assets, update README logo

---------

Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>
Co-authored-by: ItsNik <info@itsnik.de>
Co-authored-by: Its4Nik <106100177+Its4Nik@users.noreply.github.com>
Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>

* chore(gifs): Add .gitignore to ignore YML files

---------

Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>
Co-authored-by: imgbot[bot] <31301654+imgbot[bot]@users.noreply.github.com>
Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>

Author: 3 people

.github/assets/gifs/.gitignore

@@ -0,0 +1 @@
+*.yml

.github/assets/gifs/DockStatAPI-startup.gif

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="./.github/DockStat2-04.png" alt="DockStat Logo" />
+  <img src="./.github/assets/logos/withText-white.png" alt="DockStat Logo" />
 </p>
 
 <p align="center">

.github/assets/logos/square.png

@@ -1,6 +1,6 @@
 DOCKSTAT_LOGGER_DISABLED_LOGGERS=""
-DOCKSTAT_LOGGER_ONLY_SHOW=""
-DOCKSTAT_LOGGER_IGNORE_MESSAGES="Logger Status: active"
+DOCKSTAT_LOGGER_ONLY_SHOW="PluginHandler"
+DOCKSTAT_LOGGER_IGNORE_MESSAGES="Logger Status: active,Proxying Event (__log__) to DCM,QueryBuilder initialized for table"
 DOCKSTAT_LOGGER_FULL_FILE_PATH=false
 DOCKSTAT_API_PORT="3030"
 DOCKSTAT_LOGGER_LEVEL="INFO"

.github/DockStat2-04.png .github/assets/logos/withText-white.png.github/DockStat2-04.png renamed to .github/assets/logos/withText-white.png

@@ -1,25 +1,15 @@
 import Logger from "@dockstat/logger"
 import DB from "@dockstat/sqlite-wrapper"
-import type { DOCKER } from "@dockstat/typings"
 import DockerClient, { type DockerClientInstance } from "./client"
 import { proxyEvent } from "./events/workerEventProxy"
 import type { WorkerRequest, WorkerResponse } from "./shared/types"
+import type { InboundMessage } from "./shared/worker"
 
-declare const self: Worker
-
-type InitMessage = {
-  type: "__init__"
-  dbPath: string
-  clientId: number
-  clientName: string
-  options: DOCKER.DockerAdapterOptions
-}
+const WorkerLogger = new Logger("DCW", [], (entry) => {
+  proxyEvent("__log__", entry)
+})
 
-type MetricsMessage = {
-  type: "__get_metrics__"
-}
-
-type InboundMessage = WorkerRequest | InitMessage | MetricsMessage
+declare const self: Worker
 
 let client: DockerClientInstance | null = null
 let clientId = -1
@@ -40,7 +30,7 @@ self.onmessage = async (event: MessageEvent<InboundMessage>) => {
       clientId = Number(msg.clientId)
       clientName = msg.clientName
 
-      const logger = new Logger(`DockerClient-${clientId}`)
+      const logger = WorkerLogger.spawn(`DC-${clientId}`)
       client = new DockerClient(clientId, clientName, db, msg.options, logger)
 
       // Initialize with whatever is already in the host table; explicit init with hosts can come later.

README.md

@@ -1,13 +1,12 @@
 import { heapStats } from "bun:jsc"
 import type Logger from "@dockstat/logger"
+import type { LogEntry } from "@dockstat/logger"
 import type PluginHandler from "@dockstat/plugin-handler"
 import { column, type QueryBuilder } from "@dockstat/sqlite-wrapper"
 import type { DOCKER, EVENTS } from "@dockstat/typings"
 import type { buildMessageFromProxyRes } from "@dockstat/typings/types"
-import { truncate, worker as workerUtils } from "@dockstat/utils"
-
+import { truncate } from "@dockstat/utils"
 import type { PoolMetrics, WorkerMetrics, WorkerRequest } from "../shared/types"
-
 import type {
   DBType,
   DockerClientTable,
@@ -16,6 +15,7 @@ import type {
   WorkerWrapper,
 } from "./types"
 import { isInitCompleteMessage, looksLikeEventMessage } from "./types"
+import { tryBuildFromProxy } from "./utils/buildFromProxy"
 import { sendWorkerMessage } from "./utils/sendWorkerMessage"
 
 export class DockerClientManagerCore {
@@ -238,7 +238,7 @@ export class DockerClientManagerCore {
 
       this.workers.set(clientId, wrapper)
 
-      // Persistent plugin event listener
+      // Persistent event listener
       this.attachEventListener(wrapper)
 
       // Initialize worker
@@ -268,6 +268,10 @@ export class DockerClientManagerCore {
       const initHandler = (event: MessageEvent) => {
         const message = event.data
 
+        if (message?.type === "__event__") {
+          return
+        }
+
         this.logger.debug(`Init handler received: ${JSON.stringify(message)}`)
 
         if (!isInitCompleteMessage(message)) {
@@ -282,7 +286,7 @@ export class DockerClientManagerCore {
           this.logger.info(`Worker ${clientId} initialized successfully`)
           resolve()
         } else {
-          wrapper.lastError = message.error ?? "Unknown init error"
+          wrapper.lastError = (message as { error: string }).error ?? "Unknown init error"
           wrapper.errorCount += 1
 
           try {
@@ -292,7 +296,9 @@ export class DockerClientManagerCore {
           }
           this.workers.delete(clientId)
 
-          reject(new Error(`Worker init failed: ${message.error ?? "unknown"}`))
+          reject(
+            new Error(`Worker init failed: ${(message as { error: string }).error ?? "unknown"}`)
+          )
         }
       }
 
@@ -492,21 +498,17 @@ export class DockerClientManagerCore {
 
     const { worker } = wrapper
 
-    const tryBuildFromProxy = (payload: unknown): EventMessage<keyof EVENTS> | null => {
-      const message = workerUtils.buildMessage.tryBuildMessageFromProxy(payload)
-      if (!message) return null
-
-      return message
-    }
-
     const listener = (event: MessageEvent) => {
       const payload = event.data
 
       const message: EventMessage<keyof EVENTS> | null = looksLikeEventMessage(payload)
         ? payload
         : tryBuildFromProxy(payload)
 
-      if (!message) return
+      if (!message) {
+        this.logger.debug(`No message! ${JSON.stringify(payload)}`)
+        return null
+      }
 
       this.internalListeners(wrapper, message)
       this.triggerHooks(message)
@@ -535,6 +537,13 @@ export class DockerClientManagerCore {
         wrapper.hostIds.delete(hostId)
         break
       }
+
+      case "__log__": {
+        const { level, message, caller, name, parents, timestamp, requestId }: LogEntry =
+          msg.ctx as Parameters<EVENTS[typeof msg.type]>[0]
+
+        this.logger.emitLogEntry(level, message, { caller, name, parents, timestamp, requestId })
+      }
     }
   }
 
@@ -560,6 +569,10 @@ export class DockerClientManagerCore {
       return
     }
 
+    if (message.type === "__log__") {
+      return
+    }
+
     this.logger.debug(
       `Triggering hooks for event "${String(message.type)} - ctx: ${truncate(JSON.stringify(message.ctx), 100)}"`
     )

apps/api/.env.example

@@ -1,4 +1,5 @@
 import type { DATABASE } from "@dockstat/typings"
+import { truncate } from "@dockstat/utils"
 import { DockerClientManagerCore } from "./core"
 
 export class Hosts extends DockerClientManagerCore {
@@ -95,7 +96,7 @@ export class Hosts extends DockerClientManagerCore {
   public override async getAllHosts() {
     this.logger.debug("Getting all hosts")
     const clients = this.getAllClients()
-    this.logger.debug(`Clients: ${JSON.stringify(clients)}`)
+    this.logger.debug(`Clients: ${truncate(JSON.stringify(clients), 100)}`)
 
     try {
       const allClientHosts = await Promise.all(