Skip to content

A self-hostable bookmark-everything app (links, notes and images) with AI-based automatic tagging and full text search

fix(workers): avoid default metrics collection when Prometheus is unconfigured #2397

Mohamed Bassem864900dc8849
diff --git a/apps/workers/metrics.ts b/apps/workers/metrics.ts
index ad3a1ee6..fe4c95b2 100644
--- a/apps/workers/metrics.ts
+++ b/apps/workers/metrics.ts
@@ -1,12 +1,16 @@
import { prometheus } from "@hono/prometheus";
import { Counter, Histogram, Registry } from "prom-client";
+import serverConfig from "@karakeep/shared/config";
+
export const registry = new Registry();
export const { printMetrics } = prometheus({
registry: registry,
prefix: "karakeep_",
- collectDefaultMetrics: true,
+ // Default metrics start a recurring event-loop sampler and a GC observer.
+ // Without a configured token, the metrics endpoint is inaccessible.
+ collectDefaultMetrics: serverConfig.prometheus.enabled,
});
export const workerStatsCounter = new Counter({
diff --git a/packages/api/routes/metrics.ts b/packages/api/routes/metrics.ts
index 5cc45963..9e460257 100644
--- a/packages/api/routes/metrics.ts
+++ b/packages/api/routes/metrics.ts
@@ -18,7 +18,7 @@ const prometheusHandlers = (globalForPrometheus.__karakeepApiPrometheus ??=
prometheus({
registry: register,
prefix: "karakeep_",
- collectDefaultMetrics: true,
+ collectDefaultMetrics: serverConfig.prometheus.enabled,
}));
export const { printMetrics, registerMetrics } = prometheusHandlers;
diff --git a/packages/shared/config.ts b/packages/shared/config.ts
index 2345deac..4ec9de94 100644
--- a/packages/shared/config.ts
+++ b/packages/shared/config.ts
@@ -501,6 +501,7 @@ const serverConfigSchema = allEnv.transform((val, ctx) => {
},
},
prometheus: {
+ enabled: val.PROMETHEUS_AUTH_TOKEN !== undefined,
metricsToken:
val.PROMETHEUS_AUTH_TOKEN ?? crypto.randomBytes(64).toString("hex"),
},