feat: add structured backend logging
Collector failures, service-API errors, WS connection lifecycle, and config reload/discovery events were previously invisible outside the browser (or, for a few config/discovery cases, logged with an inconsistent ad-hoc console.error). Add a small scoped logger (lib/logger.ts, level via LOG_LEVEL) and wire it through server.ts, the scheduler, service collector, config loader/effective store, and the WS server so operators can see failures via `docker logs`. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
@@ -7,6 +7,9 @@ import { collectSystem } from "./system";
|
||||
import { collectHttp } from "./http";
|
||||
import { collectService } from "./service";
|
||||
import type { WidgetResult } from "@/lib/types/widget-result";
|
||||
import { createLogger } from "@/lib/logger";
|
||||
|
||||
const log = createLogger("scheduler");
|
||||
|
||||
const httpLimit = pLimit(8);
|
||||
|
||||
@@ -122,6 +125,12 @@ class CollectorScheduler {
|
||||
|
||||
if (existing) clearInterval(existing.timer);
|
||||
|
||||
log.debug(existing ? "job replaced" : "job added", {
|
||||
widgetId: instance.id,
|
||||
type: instance.widget.type,
|
||||
intervalMs,
|
||||
});
|
||||
|
||||
const run = () => this.runJob(instance.id);
|
||||
const timer = setInterval(run, intervalMs);
|
||||
this.jobs.set(instance.id, { widget: instance.widget, intervalMs, timer, consecutiveFailures: 0 });
|
||||
@@ -130,16 +139,20 @@ class CollectorScheduler {
|
||||
|
||||
for (const [id, job] of this.jobs) {
|
||||
if (!seen.has(id)) {
|
||||
log.debug("job removed", { widgetId: id, type: job.widget.type });
|
||||
clearInterval(job.timer);
|
||||
this.jobs.delete(id);
|
||||
this.lastResults.delete(id);
|
||||
}
|
||||
}
|
||||
|
||||
log.info("reconciled", { jobs: this.jobs.size });
|
||||
}
|
||||
|
||||
stop(): void {
|
||||
for (const job of this.jobs.values()) clearInterval(job.timer);
|
||||
this.jobs.clear();
|
||||
log.info("scheduler stopped");
|
||||
}
|
||||
|
||||
private async runJob(id: string): Promise<void> {
|
||||
@@ -150,10 +163,37 @@ class CollectorScheduler {
|
||||
try {
|
||||
result = await collect(job.widget);
|
||||
if (result.type === "http") {
|
||||
const wasFailing = job.consecutiveFailures > 0;
|
||||
job.consecutiveFailures = result.data.up ? 0 : job.consecutiveFailures + 1;
|
||||
result = { type: "http", data: { ...result.data, consecutiveFailures: job.consecutiveFailures } };
|
||||
if (!result.data.up) {
|
||||
log.warn("http check failed", {
|
||||
widgetId: id,
|
||||
url: (job.widget as { url?: string }).url,
|
||||
statusCode: result.data.statusCode,
|
||||
attempt: job.consecutiveFailures,
|
||||
});
|
||||
} else if (wasFailing) {
|
||||
log.info("http check recovered", { widgetId: id, url: (job.widget as { url?: string }).url });
|
||||
}
|
||||
} else {
|
||||
if (job.consecutiveFailures > 0) {
|
||||
log.info("collector recovered", {
|
||||
widgetId: id,
|
||||
type: job.widget.type,
|
||||
afterFailures: job.consecutiveFailures,
|
||||
});
|
||||
}
|
||||
job.consecutiveFailures = 0;
|
||||
}
|
||||
} catch (err) {
|
||||
job.consecutiveFailures += 1;
|
||||
log.error("collector failed", {
|
||||
widgetId: id,
|
||||
type: job.widget.type,
|
||||
attempt: job.consecutiveFailures,
|
||||
error: (err as Error).message,
|
||||
});
|
||||
result = { type: "error", message: (err as Error).message };
|
||||
}
|
||||
|
||||
|
||||
@@ -8,6 +8,9 @@ import { collectN8n } from "./services/n8n";
|
||||
import { collectUmami } from "./services/umami";
|
||||
import { collectHeadscale } from "./services/headscale";
|
||||
import { collectTraefikStat } from "./services/traefik";
|
||||
import { createLogger } from "@/lib/logger";
|
||||
|
||||
const log = createLogger("service");
|
||||
|
||||
function collectServiceStat(widget: ServiceWidget): Promise<{ stats: ServiceStat[] }> {
|
||||
switch (widget.service) {
|
||||
@@ -34,10 +37,11 @@ export async function collectService(widget: ServiceWidget): Promise<ServiceWidg
|
||||
// A failed service-API call (bad token, service down) must not take out the
|
||||
// docker health readout too - the two are independent failure modes and
|
||||
// merging them into one card should not let one mask the other.
|
||||
const statPromise = collectServiceStat(widget).catch((err) => ({
|
||||
stats: [] as ServiceStat[],
|
||||
statError: (err as Error).message,
|
||||
}));
|
||||
const statPromise = collectServiceStat(widget).catch((err) => {
|
||||
const message = (err as Error).message;
|
||||
log.warn("service API call failed", { service: widget.service, containerName: widget.containerName, error: message });
|
||||
return { stats: [] as ServiceStat[], statError: message };
|
||||
});
|
||||
|
||||
const [docker, statResult] = await Promise.all([dockerPromise, statPromise]);
|
||||
return { docker, ...statResult };
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
import { configStore } from "./loader";
|
||||
import { discoverDockerWidgets } from "@/lib/discovery/traefik-labels";
|
||||
import type { Config, Widget } from "./schema";
|
||||
import { createLogger } from "@/lib/logger";
|
||||
|
||||
const log = createLogger("discovery");
|
||||
|
||||
const DISCOVERY_INTERVAL_MS = 60_000;
|
||||
|
||||
@@ -53,11 +56,15 @@ class EffectiveConfigStore {
|
||||
try {
|
||||
const next = await discoverDockerWidgets(configStore.get());
|
||||
if (!sameDiscoveredSet(this.discovered, next)) {
|
||||
log.info("discovered widget set changed", {
|
||||
previous: this.discovered.length,
|
||||
current: next.length,
|
||||
});
|
||||
this.discovered = next;
|
||||
this.emit();
|
||||
}
|
||||
} catch (err) {
|
||||
console.error(`[discovery] ${(err as Error).message}`);
|
||||
log.error("discovery scan failed", { error: (err as Error).message });
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
+15
-2
@@ -5,11 +5,18 @@ import chokidar, { type FSWatcher } from "chokidar";
|
||||
import { parse as parseYaml } from "yaml";
|
||||
import { configSchema, type Config } from "./schema";
|
||||
import { interpolateEnv } from "./interpolate";
|
||||
import { createLogger } from "@/lib/logger";
|
||||
|
||||
const log = createLogger("config");
|
||||
|
||||
const CONFIG_DIR = path.join(process.cwd(), "config");
|
||||
const CONFIG_PATH = path.join(CONFIG_DIR, "config.yml");
|
||||
const ENV_PATH = path.join(CONFIG_DIR, ".env");
|
||||
|
||||
function widgetCount(config: Config): number {
|
||||
return config.groups.reduce((sum, group) => sum + group.widgets.length, 0);
|
||||
}
|
||||
|
||||
export class ConfigError extends Error {}
|
||||
|
||||
function loadEnv(): Record<string, string | undefined> {
|
||||
@@ -62,6 +69,7 @@ class ConfigStore {
|
||||
|
||||
load(): Config {
|
||||
this.current = readConfig();
|
||||
log.info("config loaded", { groups: this.current.groups.length, widgets: widgetCount(this.current) });
|
||||
return this.current;
|
||||
}
|
||||
|
||||
@@ -85,7 +93,11 @@ class ConfigStore {
|
||||
awaitWriteFinish: { stabilityThreshold: 200, pollInterval: 50 },
|
||||
ignoreInitial: true,
|
||||
});
|
||||
this.watcher.on("all", () => this.reload());
|
||||
this.watcher.on("all", (event) => {
|
||||
log.debug("watched file changed", { event });
|
||||
this.reload();
|
||||
});
|
||||
log.info("watching config files", { paths: [CONFIG_PATH, ENV_PATH] });
|
||||
}
|
||||
|
||||
stop(): void {
|
||||
@@ -97,10 +109,11 @@ class ConfigStore {
|
||||
try {
|
||||
const next = readConfig();
|
||||
this.current = next;
|
||||
log.info("config reloaded", { groups: next.groups.length, widgets: widgetCount(next) });
|
||||
for (const listener of this.listeners) listener(next);
|
||||
} catch (err) {
|
||||
const configError = err instanceof ConfigError ? err : new ConfigError((err as Error).message);
|
||||
console.error(`[config] ${configError.message}`);
|
||||
log.error("config reload failed", { error: configError.message });
|
||||
for (const listener of this.errorListeners) listener(configError);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
type LogLevel = "debug" | "info" | "warn" | "error";
|
||||
type LogFields = Record<string, unknown>;
|
||||
|
||||
const LEVEL_ORDER: Record<LogLevel, number> = { debug: 0, info: 1, warn: 2, error: 3 };
|
||||
|
||||
function resolveMinLevel(): LogLevel {
|
||||
const configured = process.env.LOG_LEVEL?.toLowerCase();
|
||||
if (configured === "debug" || configured === "info" || configured === "warn" || configured === "error") {
|
||||
return configured;
|
||||
}
|
||||
return process.env.NODE_ENV === "production" ? "info" : "debug";
|
||||
}
|
||||
|
||||
const MIN_LEVEL = resolveMinLevel();
|
||||
|
||||
function formatFields(fields?: LogFields): string {
|
||||
if (!fields) return "";
|
||||
const parts = Object.entries(fields)
|
||||
.filter(([, value]) => value !== undefined)
|
||||
.map(([key, value]) => `${key}=${typeof value === "string" ? value : JSON.stringify(value)}`);
|
||||
return parts.length > 0 ? ` ${parts.join(" ")}` : "";
|
||||
}
|
||||
|
||||
function write(level: LogLevel, scope: string, message: string, fields?: LogFields): void {
|
||||
if (LEVEL_ORDER[level] < LEVEL_ORDER[MIN_LEVEL]) return;
|
||||
const line = `${new Date().toISOString()} ${level.toUpperCase().padEnd(5)} [${scope}] ${message}${formatFields(fields)}`;
|
||||
if (level === "error") console.error(line);
|
||||
else if (level === "warn") console.warn(line);
|
||||
else console.log(line);
|
||||
}
|
||||
|
||||
export interface Logger {
|
||||
debug(message: string, fields?: LogFields): void;
|
||||
info(message: string, fields?: LogFields): void;
|
||||
warn(message: string, fields?: LogFields): void;
|
||||
error(message: string, fields?: LogFields): void;
|
||||
}
|
||||
|
||||
/** Scoped logger. `scope` is the bracketed tag, e.g. createLogger("scheduler") -> "[scheduler]". */
|
||||
export function createLogger(scope: string): Logger {
|
||||
return {
|
||||
debug: (message, fields) => write("debug", scope, message, fields),
|
||||
info: (message, fields) => write("info", scope, message, fields),
|
||||
warn: (message, fields) => write("warn", scope, message, fields),
|
||||
error: (message, fields) => write("error", scope, message, fields),
|
||||
};
|
||||
}
|
||||
+22
-4
@@ -6,6 +6,9 @@ import { effectiveConfigStore } from "@/lib/config/effective";
|
||||
import { toPublicConfig } from "@/lib/config/public";
|
||||
import type { Config } from "@/lib/config/schema";
|
||||
import type { WidgetResult } from "@/lib/types/widget-result";
|
||||
import { createLogger } from "@/lib/logger";
|
||||
|
||||
const log = createLogger("ws");
|
||||
|
||||
type Envelope =
|
||||
| { topic: string; type: "result"; ts: number; data: WidgetResult }
|
||||
@@ -22,6 +25,8 @@ export function attachWebSocketServer(httpServer: HttpServer): WebSocketServer {
|
||||
const wss = new WebSocketServer({ noServer: true });
|
||||
const subscriptions = new Map<string, Set<WebSocket>>();
|
||||
const allSockets = new Set<WebSocket>();
|
||||
const connectionIds = new WeakMap<WebSocket, number>();
|
||||
let nextConnectionId = 1;
|
||||
|
||||
function subscribe(socket: WebSocket, widgetId: string): void {
|
||||
let set = subscriptions.get(widgetId);
|
||||
@@ -46,12 +51,16 @@ export function attachWebSocketServer(httpServer: HttpServer): WebSocketServer {
|
||||
}
|
||||
|
||||
wss.on("connection", (socket) => {
|
||||
const connectionId = nextConnectionId++;
|
||||
connectionIds.set(socket, connectionId);
|
||||
allSockets.add(socket);
|
||||
log.info("client connected", { connectionId, clients: allSockets.size });
|
||||
|
||||
try {
|
||||
const config = effectiveConfigStore.get();
|
||||
send(socket, { topic: "config", type: "config:update", ts: Date.now(), data: toPublicConfig(config) });
|
||||
} catch {
|
||||
} catch (err) {
|
||||
log.debug("no valid config to send on connect", { connectionId, error: (err as Error).message });
|
||||
// no valid config loaded yet; client keeps its SSR-seeded config until one arrives
|
||||
}
|
||||
|
||||
@@ -59,18 +68,27 @@ export function attachWebSocketServer(httpServer: HttpServer): WebSocketServer {
|
||||
let message: { action?: string; widgetId?: string };
|
||||
try {
|
||||
message = JSON.parse(raw.toString());
|
||||
} catch {
|
||||
} catch (err) {
|
||||
log.warn("received malformed message", { connectionId, error: (err as Error).message });
|
||||
return;
|
||||
}
|
||||
if (message.action === "subscribe" && typeof message.widgetId === "string") {
|
||||
log.debug("client subscribed", { connectionId, widgetId: message.widgetId });
|
||||
subscribe(socket, message.widgetId);
|
||||
} else if (message.action === "unsubscribe" && typeof message.widgetId === "string") {
|
||||
log.debug("client unsubscribed", { connectionId, widgetId: message.widgetId });
|
||||
unsubscribe(socket, message.widgetId);
|
||||
}
|
||||
});
|
||||
|
||||
socket.on("close", () => cleanupSocket(socket));
|
||||
socket.on("error", () => cleanupSocket(socket));
|
||||
socket.on("close", (code) => {
|
||||
log.info("client disconnected", { connectionId, code, clients: allSockets.size - 1 });
|
||||
cleanupSocket(socket);
|
||||
});
|
||||
socket.on("error", (err) => {
|
||||
log.error("socket error", { connectionId, error: err.message });
|
||||
cleanupSocket(socket);
|
||||
});
|
||||
});
|
||||
|
||||
collectorScheduler.onResult((widgetId, result) => {
|
||||
|
||||
Reference in New Issue
Block a user