feat: add combined docker+API service widgets for gitea/coolify/immich/n8n/umami/headscale
One new `service` widget type (nested discriminated union on `service`) rather than six, so a single config entry shows both docker container health and a service-specific stat (repo count, project list, photo count, workflow count, active users, users/nodes) - avoiding the overhead of configuring a docker widget and a separate service widget per container. All six collectors hit the service's container name + internal port directly on falcon_network, the same container-to- container pattern just proven out for Traefik's own API, avoiding vpn-only/hairpin-NAT entirely. Also adds the public/private config split that was scoped in the original project plan but never built: lib/config/public.ts strips apiToken/apiKey/password fields before the config reaches the browser via SSR or the WS config topic - required before any widget could carry a real secret. Verified via a throwaway secret field that it's absent from both the SSR HTML and the WS config:update frame. Endpoint shapes verified live against the running gitea/coolify/immich/ n8n/umami/headscale containers before committing (unauthenticated requests correctly 401/200 on every target route; gitea's X-Total-Count header confirmed present).
This commit is contained in:
@@ -1,11 +1,14 @@
|
||||
import Docker from "dockerode";
|
||||
import type { ContainerStats } from "dockerode";
|
||||
import pLimit from "p-limit";
|
||||
import type { DockerContainerResult } from "@/lib/types/widget-result";
|
||||
|
||||
const docker = new Docker({
|
||||
socketPath: process.env.DOCKER_SOCKET_PATH ?? "/var/run/docker.sock",
|
||||
});
|
||||
|
||||
export const dockerLimit = pLimit(4);
|
||||
|
||||
function calcCpuPercent(stats: ContainerStats): number | null {
|
||||
const cpuDelta = stats.cpu_stats.cpu_usage.total_usage - stats.precpu_stats.cpu_usage.total_usage;
|
||||
const systemDelta = stats.cpu_stats.system_cpu_usage - stats.precpu_stats.system_cpu_usage;
|
||||
|
||||
@@ -2,13 +2,13 @@ import pLimit from "p-limit";
|
||||
import type { Config, Widget } from "@/lib/config/schema";
|
||||
import { flattenWidgets } from "@/lib/config/widgets";
|
||||
import { parseDuration } from "@/lib/config/duration";
|
||||
import { collectDockerContainer } from "./docker";
|
||||
import { collectDockerContainer, dockerLimit } from "./docker";
|
||||
import { collectSystem } from "./system";
|
||||
import { collectHttp } from "./http";
|
||||
import { collectTraefik } from "./traefik";
|
||||
import { collectService } from "./service";
|
||||
import type { WidgetResult } from "@/lib/types/widget-result";
|
||||
|
||||
const dockerLimit = pLimit(4);
|
||||
const httpLimit = pLimit(8);
|
||||
|
||||
type ResultListener = (widgetId: string, result: WidgetResult) => void;
|
||||
@@ -20,7 +20,14 @@ interface Job {
|
||||
consecutiveFailures: number;
|
||||
}
|
||||
|
||||
const COLLECTOR_TYPES = new Set<Widget["type"]>(["docker", "database", "system", "http", "traefik"]);
|
||||
const COLLECTOR_TYPES = new Set<Widget["type"]>([
|
||||
"docker",
|
||||
"database",
|
||||
"system",
|
||||
"http",
|
||||
"traefik",
|
||||
"service",
|
||||
]);
|
||||
|
||||
function isCollectorWidget(widget: Widget): boolean {
|
||||
return COLLECTOR_TYPES.has(widget.type);
|
||||
@@ -32,7 +39,8 @@ function getIntervalMs(widget: Widget): number {
|
||||
widget.type === "database" ||
|
||||
widget.type === "system" ||
|
||||
widget.type === "http" ||
|
||||
widget.type === "traefik"
|
||||
widget.type === "traefik" ||
|
||||
widget.type === "service"
|
||||
) {
|
||||
return parseDuration(widget.interval);
|
||||
}
|
||||
@@ -55,6 +63,9 @@ function sameTarget(a: Widget, b: Widget): boolean {
|
||||
if (a.type === "traefik" && b.type === "traefik") {
|
||||
return a.apiUrl === b.apiUrl;
|
||||
}
|
||||
if (a.type === "service" && b.type === "service") {
|
||||
return a.containerName === b.containerName && a.service === b.service && a.showStats === b.showStats;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
@@ -81,6 +92,10 @@ async function collect(widget: Widget): Promise<WidgetResult> {
|
||||
const data = await collectTraefik(widget.apiUrl);
|
||||
return { type: "traefik", data };
|
||||
}
|
||||
if (widget.type === "service") {
|
||||
const data = await collectService(widget);
|
||||
return { type: "service", data };
|
||||
}
|
||||
throw new Error(`No collector for widget type "${widget.type}"`);
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
import type { ServiceWidget } from "@/lib/config/schema";
|
||||
import type { ServiceStat, ServiceWidgetResult } from "@/lib/types/service-result";
|
||||
import { collectDockerContainer, dockerLimit } from "./docker";
|
||||
import { collectGitea } from "./services/gitea";
|
||||
import { collectCoolify } from "./services/coolify";
|
||||
import { collectImmich } from "./services/immich";
|
||||
import { collectN8n } from "./services/n8n";
|
||||
import { collectUmami } from "./services/umami";
|
||||
import { collectHeadscale } from "./services/headscale";
|
||||
|
||||
function collectServiceStat(widget: ServiceWidget): Promise<{ stats: ServiceStat[]; detail?: string[] }> {
|
||||
switch (widget.service) {
|
||||
case "gitea":
|
||||
return collectGitea(widget);
|
||||
case "coolify":
|
||||
return collectCoolify(widget);
|
||||
case "immich":
|
||||
return collectImmich(widget);
|
||||
case "n8n":
|
||||
return collectN8n(widget);
|
||||
case "umami":
|
||||
return collectUmami(widget);
|
||||
case "headscale":
|
||||
return collectHeadscale(widget);
|
||||
}
|
||||
}
|
||||
|
||||
export async function collectService(widget: ServiceWidget): Promise<ServiceWidgetResult> {
|
||||
const dockerPromise = dockerLimit(() => collectDockerContainer(widget.containerName, widget.showStats));
|
||||
|
||||
// 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 [docker, statResult] = await Promise.all([dockerPromise, statPromise]);
|
||||
return { docker, ...statResult };
|
||||
}
|
||||
@@ -0,0 +1,14 @@
|
||||
import type { ServiceWidget } from "@/lib/config/schema";
|
||||
|
||||
const SERVICE_PORTS: Record<ServiceWidget["service"], number> = {
|
||||
gitea: 3000,
|
||||
coolify: 8080,
|
||||
immich: 2283,
|
||||
n8n: 5678,
|
||||
umami: 3000,
|
||||
headscale: 8080,
|
||||
};
|
||||
|
||||
export function serviceBaseUrl(widget: ServiceWidget): string {
|
||||
return `http://${widget.containerName}:${SERVICE_PORTS[widget.service]}`;
|
||||
}
|
||||
@@ -0,0 +1,30 @@
|
||||
import type { CoolifyServiceWidget } from "@/lib/config/schema";
|
||||
import type { ServiceStat } from "@/lib/types/service-result";
|
||||
import { serviceBaseUrl } from "./base-url";
|
||||
|
||||
const DETAIL_LIMIT = 5;
|
||||
|
||||
interface CoolifyProject {
|
||||
name: string;
|
||||
}
|
||||
|
||||
export async function collectCoolify(
|
||||
widget: CoolifyServiceWidget
|
||||
): Promise<{ stats: ServiceStat[]; detail?: string[] }> {
|
||||
const base = serviceBaseUrl(widget);
|
||||
const response = await fetch(`${base}/api/v1/projects`, {
|
||||
headers: { Authorization: `Bearer ${widget.apiToken}` },
|
||||
signal: AbortSignal.timeout(5_000),
|
||||
});
|
||||
if (!response.ok) {
|
||||
throw new Error(`Coolify API returned ${response.status}`);
|
||||
}
|
||||
const projects = (await response.json()) as CoolifyProject[];
|
||||
const names = projects.slice(0, DETAIL_LIMIT).map((p) => p.name);
|
||||
if (projects.length > DETAIL_LIMIT) names.push(`+${projects.length - DETAIL_LIMIT} more`);
|
||||
|
||||
return {
|
||||
stats: [{ label: "Projects", value: String(projects.length) }],
|
||||
detail: names.length > 0 ? names : undefined,
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
import type { GiteaServiceWidget } from "@/lib/config/schema";
|
||||
import type { ServiceStat } from "@/lib/types/service-result";
|
||||
import { serviceBaseUrl } from "./base-url";
|
||||
|
||||
export async function collectGitea(widget: GiteaServiceWidget): Promise<{ stats: ServiceStat[] }> {
|
||||
const base = serviceBaseUrl(widget);
|
||||
const response = await fetch(`${base}/api/v1/users/${widget.username}/repos?limit=1`, {
|
||||
headers: { Authorization: `token ${widget.apiToken}` },
|
||||
signal: AbortSignal.timeout(5_000),
|
||||
});
|
||||
if (!response.ok) {
|
||||
throw new Error(`Gitea API returned ${response.status}`);
|
||||
}
|
||||
const count = response.headers.get("X-Total-Count") ?? "0";
|
||||
return { stats: [{ label: "Repos", value: count }] };
|
||||
}
|
||||
@@ -0,0 +1,30 @@
|
||||
import type { HeadscaleServiceWidget } from "@/lib/config/schema";
|
||||
import type { ServiceStat } from "@/lib/types/service-result";
|
||||
import { serviceBaseUrl } from "./base-url";
|
||||
|
||||
async function fetchList(url: string, apiToken: string, label: string, key: "users" | "nodes"): Promise<unknown[]> {
|
||||
const response = await fetch(url, {
|
||||
headers: { Authorization: `Bearer ${apiToken}` },
|
||||
signal: AbortSignal.timeout(5_000),
|
||||
});
|
||||
if (!response.ok) {
|
||||
throw new Error(`Headscale ${label} API returned ${response.status}`);
|
||||
}
|
||||
const body = (await response.json()) as Record<string, unknown[]>;
|
||||
return body[key] ?? [];
|
||||
}
|
||||
|
||||
export async function collectHeadscale(widget: HeadscaleServiceWidget): Promise<{ stats: ServiceStat[] }> {
|
||||
const base = serviceBaseUrl(widget);
|
||||
const [users, nodes] = await Promise.all([
|
||||
fetchList(`${base}/api/v1/user`, widget.apiToken, "user", "users"),
|
||||
fetchList(`${base}/api/v1/node`, widget.apiToken, "node", "nodes"),
|
||||
]);
|
||||
|
||||
return {
|
||||
stats: [
|
||||
{ label: "Users", value: String(users.length) },
|
||||
{ label: "Nodes", value: String(nodes.length) },
|
||||
],
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
import type { ImmichServiceWidget } from "@/lib/config/schema";
|
||||
import type { ServiceStat } from "@/lib/types/service-result";
|
||||
import { serviceBaseUrl } from "./base-url";
|
||||
|
||||
interface ImmichStatistics {
|
||||
photos: number;
|
||||
videos: number;
|
||||
}
|
||||
|
||||
export async function collectImmich(widget: ImmichServiceWidget): Promise<{ stats: ServiceStat[] }> {
|
||||
const base = serviceBaseUrl(widget);
|
||||
const response = await fetch(`${base}/api/server/statistics`, {
|
||||
headers: { "x-api-key": widget.apiKey },
|
||||
signal: AbortSignal.timeout(5_000),
|
||||
});
|
||||
if (!response.ok) {
|
||||
throw new Error(`Immich API returned ${response.status}`);
|
||||
}
|
||||
const stats = (await response.json()) as ImmichStatistics;
|
||||
return {
|
||||
stats: [
|
||||
{ label: "Photos", value: String(stats.photos) },
|
||||
{ label: "Videos", value: String(stats.videos) },
|
||||
],
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
import type { N8nServiceWidget } from "@/lib/config/schema";
|
||||
import type { ServiceStat } from "@/lib/types/service-result";
|
||||
import { serviceBaseUrl } from "./base-url";
|
||||
|
||||
interface N8nWorkflowsPage {
|
||||
data: unknown[];
|
||||
}
|
||||
|
||||
export async function collectN8n(widget: N8nServiceWidget): Promise<{ stats: ServiceStat[] }> {
|
||||
const base = serviceBaseUrl(widget);
|
||||
const response = await fetch(`${base}/api/v1/workflows?limit=250`, {
|
||||
headers: { "X-N8N-API-KEY": widget.apiKey },
|
||||
signal: AbortSignal.timeout(5_000),
|
||||
});
|
||||
if (!response.ok) {
|
||||
throw new Error(`n8n API returned ${response.status}`);
|
||||
}
|
||||
const page = (await response.json()) as N8nWorkflowsPage;
|
||||
return { stats: [{ label: "Workflows", value: String(page.data.length) }] };
|
||||
}
|
||||
@@ -0,0 +1,48 @@
|
||||
import type { UmamiServiceWidget } from "@/lib/config/schema";
|
||||
import type { ServiceStat } from "@/lib/types/service-result";
|
||||
import { serviceBaseUrl } from "./base-url";
|
||||
|
||||
// Self-hosted Umami has no static API-key header (that's Cloud-only) - it needs
|
||||
// a username/password login exchanged for a Bearer token. Cache the token per
|
||||
// container and only re-login when a request comes back 401, since the docs
|
||||
// don't document a fixed token lifetime to pre-emptively refresh against.
|
||||
const tokenCache = new Map<string, string>();
|
||||
|
||||
async function login(widget: UmamiServiceWidget, base: string): Promise<string> {
|
||||
const response = await fetch(`${base}/api/auth/login`, {
|
||||
method: "POST",
|
||||
headers: { "Content-Type": "application/json" },
|
||||
body: JSON.stringify({ username: widget.username, password: widget.password }),
|
||||
signal: AbortSignal.timeout(5_000),
|
||||
});
|
||||
if (!response.ok) {
|
||||
throw new Error(`Umami login returned ${response.status}`);
|
||||
}
|
||||
const body = (await response.json()) as { token: string };
|
||||
tokenCache.set(widget.containerName, body.token);
|
||||
return body.token;
|
||||
}
|
||||
|
||||
export async function collectUmami(widget: UmamiServiceWidget): Promise<{ stats: ServiceStat[] }> {
|
||||
const base = serviceBaseUrl(widget);
|
||||
let token = tokenCache.get(widget.containerName) ?? (await login(widget, base));
|
||||
|
||||
let response = await fetch(`${base}/api/websites/${widget.websiteId}/active`, {
|
||||
headers: { Authorization: `Bearer ${token}` },
|
||||
signal: AbortSignal.timeout(5_000),
|
||||
});
|
||||
|
||||
if (response.status === 401) {
|
||||
token = await login(widget, base);
|
||||
response = await fetch(`${base}/api/websites/${widget.websiteId}/active`, {
|
||||
headers: { Authorization: `Bearer ${token}` },
|
||||
signal: AbortSignal.timeout(5_000),
|
||||
});
|
||||
}
|
||||
|
||||
if (!response.ok) {
|
||||
throw new Error(`Umami API returned ${response.status}`);
|
||||
}
|
||||
const body = (await response.json()) as { visitors: number };
|
||||
return { stats: [{ label: "Active", value: String(body.visitors) }] };
|
||||
}
|
||||
Reference in New Issue
Block a user