@spinajs/telemetry 2.0.482

package/lib/cjs/PromMetricSink.js

@@ -0,0 +1,68 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PromMetricSink = exports.PERF_DURATION_BUCKETS_MS = void 0;
+const di_1 = require("@spinajs/di");
+const log_1 = require("@spinajs/log");
+const metrics_js_1 = require("./metrics.js");
+/** Duration histogram buckets ( ms ), mirroring the http telemetry middleware. */
+exports.PERF_DURATION_BUCKETS_MS = [1, 5, 10, 25, 50, 100, 250, 500, 1000, 2500, 5000, 10000];
+/**
+ * {@link PerfSink} that forwards perf measurements to the shared prom-client
+ * {@link Metrics} registry — the prom side of the dual-sink. Span durations go
+ * to `perf_span_duration_ms{name}`; counter/value events increment
+ * `perf_events_total{name}`; per-request scope totals go to their own
+ * `perf_scope_total_ms{name}` histogram so they don't conflate with the
+ * per-span distribution. Labels are restricted to `name` ( plus the metric's
+ * own low-cardinality labels are folded into the name label space via a single
+ * `name` label to stay bounded ).
+ */
+let PromMetricSink = class PromMetricSink extends log_1.PerfSink {
+    constructor() {
+        super(...arguments);
+        this.defined = false;
+    }
+    ensure() {
+        if (this.defined)
+            return;
+        this.metrics = di_1.DI.get(metrics_js_1.Metrics) ?? di_1.DI.resolve(metrics_js_1.Metrics);
+        const map = this.metrics.defineMetrics("perf", [
+            { name: "span_duration_ms", help: "Perf span duration in ms", type: "histogram", labelNames: ["name"], buckets: exports.PERF_DURATION_BUCKETS_MS },
+            { name: "events_total", help: "Perf counter/value events", type: "counter", labelNames: ["name"] },
+            { name: "scope_total_ms", help: "Perf per-request scope total duration in ms", type: "histogram", labelNames: ["name"], buckets: exports.PERF_DURATION_BUCKETS_MS },
+        ]);
+        this.duration = map["span_duration_ms"];
+        this.events = map["events_total"];
+        this.scopeTotal = map["scope_total_ms"];
+        this.defined = true;
+    }
+    collect(metric) {
+        this.ensure();
+        if (metric.kind === "span") {
+            this.duration.observe({ name: metric.name }, metric.durationMs ?? 0);
+        }
+        else {
+            this.events.inc({ name: metric.name }, metric.value ?? 1);
+        }
+    }
+    onScopeEnd(rollup) {
+        this.ensure();
+        for (const [name, e] of Object.entries(rollup.byName)) {
+            // per-request totals: record the aggregate duration once per request, into
+            // its own histogram so it doesn't conflate with the per-span distribution.
+            if (e.totalMs > 0)
+                this.scopeTotal.observe({ name }, e.totalMs);
+        }
+    }
+};
+exports.PromMetricSink = PromMetricSink;
+exports.PromMetricSink = PromMetricSink = __decorate([
+    (0, di_1.Singleton)(),
+    (0, di_1.Injectable)(log_1.PerfSink)
+], PromMetricSink);
+//# sourceMappingURL=PromMetricSink.js.map

package/lib/cjs/PromMetricSink.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PromMetricSink.js","sourceRoot":"","sources":["../../src/PromMetricSink.ts"],"names":[],"mappings":";;;;;;;;;AAAA,oCAAwD;AACxD,sCAAkE;AAElE,6CAAkD;AAElD,kFAAkF;AACrE,QAAA,wBAAwB,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;AAEnG;;;;;;;;;GASG;AAGI,IAAM,cAAc,GAApB,MAAM,cAAe,SAAQ,cAAQ;IAArC;;QAKG,YAAO,GAAG,KAAK,CAAC;IAiC1B,CAAC;IA/BS,MAAM;QACZ,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO;QACzB,IAAI,CAAC,OAAO,GAAG,OAAE,CAAC,GAAG,CAAC,oBAAO,CAAC,IAAI,OAAE,CAAC,OAAO,CAAC,oBAAO,CAAC,CAAC;QACtD,MAAM,GAAG,GAAc,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,EAAE;YACxD,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,0BAA0B,EAAE,IAAI,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,gCAAwB,EAAE;YAC1I,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,2BAA2B,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,MAAM,CAAC,EAAE;YAClG,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,6CAA6C,EAAE,IAAI,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,gCAAwB,EAAE;SAC5J,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,kBAAkB,CAAsB,CAAC;QAC7D,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,cAAc,CAAoB,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC,gBAAgB,CAAsB,CAAC;QAC7D,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;IACtB,CAAC;IAEM,OAAO,CAAC,MAAmB;QAChC,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAC3B,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC;QACvE,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC;IAEM,UAAU,CAAC,MAAmB;QACnC,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YACtD,2EAA2E;YAC3E,2EAA2E;YAC3E,IAAI,CAAC,CAAC,OAAO,GAAG,CAAC;gBAAE,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;CACF,CAAA;AAtCY,wCAAc;yBAAd,cAAc;IAF1B,IAAA,cAAS,GAAE;IACX,IAAA,eAAU,EAAC,cAAQ,CAAC;GACR,cAAc,CAsC1B"}

package/lib/cjs/bootstrap.d.ts

@@ -0,0 +1,13 @@
+import { Bootstrapper } from '@spinajs/di';
+/**
+ * Wires the telemetry collection layer at startup:
+ *
+ *  - registers prom-client's default process metrics against the PRIVATE
+ *    registry ( never the global default one ), when configured,
+ *  - builds the perf sinks and refreshes the Perf facade's sink list, so the
+ *    perf bridge is live in apps that use telemetry WITHOUT @spinajs/http.
+ */
+export declare class TelemetryBootstrapper extends Bootstrapper {
+    bootstrap(): void;
+}
+//# sourceMappingURL=bootstrap.d.ts.map

package/lib/cjs/bootstrap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bootstrap.d.ts","sourceRoot":"","sources":["../../src/bootstrap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,YAAY,EAAM,MAAM,aAAa,CAAC;AAM3D;;;;;;;GAOG;AACH,qBACa,qBAAsB,SAAQ,YAAY;IAC9C,SAAS,IAAI,IAAI;CAiCzB"}

package/lib/cjs/bootstrap.js

@@ -0,0 +1,57 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TelemetryBootstrapper = void 0;
+const di_1 = require("@spinajs/di");
+const configuration_1 = require("@spinajs/configuration");
+const log_1 = require("@spinajs/log");
+const metrics_js_1 = require("./metrics.js");
+/**
+ * Wires the telemetry collection layer at startup:
+ *
+ *  - registers prom-client's default process metrics against the PRIVATE
+ *    registry ( never the global default one ), when configured,
+ *  - builds the perf sinks and refreshes the Perf facade's sink list, so the
+ *    perf bridge is live in apps that use telemetry WITHOUT @spinajs/http.
+ */
+let TelemetryBootstrapper = class TelemetryBootstrapper extends di_1.Bootstrapper {
+    bootstrap() {
+        const cfg = di_1.DI.get(configuration_1.Configuration);
+        const metrics = di_1.DI.get(metrics_js_1.Metrics) ?? di_1.DI.resolve(metrics_js_1.Metrics);
+        if (cfg?.get('telemetry.collectDefaultMetrics', true)) {
+            metrics.collectDefault();
+        }
+        // Build the sinks through the ARRAY, never with a direct
+        // `DI.resolve( PromMetricSink )`. A direct resolve caches the instance under
+        // its own type name only; the later `Array.ofType( PerfSink )` — which is
+        // what the Perf facade uses — then hits that cache entry on its fast path,
+        // returns it WITHOUT adding it to the `PerfSink` list, and the facade stays
+        // blind to that sink. Resolving the array first creates them together.
+        const sinks = di_1.DI.resolve(Array.ofType(log_1.PerfSink));
+        // The array cache does not double as a per-type cache, so publish each
+        // instance under its own type name too. Without this a later
+        // `@Autoinject( InMemoryPerfSink )` ( the telemetry controller does exactly
+        // that ) would build a SECOND, permanently empty sink.
+        //
+        // `override` MUST be true: without it `asValue` APPENDS to an existing cache
+        // entry instead of replacing it, while the resolve fast path keeps handing
+        // out the entry it already had. So anything that resolved a sink directly
+        // BEFORE this bootstrapper ran — an earlier-ordered consumer bootstrapper,
+        // or an app still calling `DI.resolve( PromMetricSink )` — would pin
+        // `@Autoinject` to that earlier, permanently empty instance.
+        for (const sink of sinks) {
+            di_1.DI.register(sink).asValue(sink.constructor.name, true);
+        }
+        log_1.Perf.refreshSinks();
+    }
+};
+exports.TelemetryBootstrapper = TelemetryBootstrapper;
+exports.TelemetryBootstrapper = TelemetryBootstrapper = __decorate([
+    (0, di_1.Injectable)(di_1.Bootstrapper)
+], TelemetryBootstrapper);
+//# sourceMappingURL=bootstrap.js.map

package/lib/cjs/bootstrap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bootstrap.js","sourceRoot":"","sources":["../../src/bootstrap.ts"],"names":[],"mappings":";;;;;;;;;AAAA,oCAA2D;AAC3D,0DAAuD;AACvD,sCAA8C;AAE9C,6CAAuC;AAEvC;;;;;;;GAOG;AAEI,IAAM,qBAAqB,GAA3B,MAAM,qBAAsB,SAAQ,iBAAY;IAC9C,SAAS;QACd,MAAM,GAAG,GAAG,OAAE,CAAC,GAAG,CAAC,6BAAa,CAAC,CAAC;QAClC,MAAM,OAAO,GAAG,OAAE,CAAC,GAAG,CAAC,oBAAO,CAAC,IAAI,OAAE,CAAC,OAAO,CAAC,oBAAO,CAAC,CAAC;QAEvD,IAAI,GAAG,EAAE,GAAG,CAAU,iCAAiC,EAAE,IAAI,CAAC,EAAE,CAAC;YAC/D,OAAO,CAAC,cAAc,EAAE,CAAC;QAC3B,CAAC;QAED,yDAAyD;QACzD,6EAA6E;QAC7E,0EAA0E;QAC1E,2EAA2E;QAC3E,4EAA4E;QAC5E,uEAAuE;QACvE,MAAM,KAAK,GAAG,OAAE,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,cAAQ,CAAC,CAAC,CAAC;QAEjD,uEAAuE;QACvE,6DAA6D;QAC7D,4EAA4E;QAC5E,uDAAuD;QACvD,EAAE;QACF,6EAA6E;QAC7E,2EAA2E;QAC3E,0EAA0E;QAC1E,2EAA2E;QAC3E,qEAAqE;QACrE,6DAA6D;QAC7D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,OAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACzD,CAAC;QAED,UAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;CACF,CAAA;AAlCY,sDAAqB;gCAArB,qBAAqB;IADjC,IAAA,eAAU,EAAC,iBAAY,CAAC;GACZ,qBAAqB,CAkCjC"}

package/lib/cjs/config/telemetry.d.ts

@@ -0,0 +1,63 @@
+declare const config: {
+    system: {
+        dirs: {
+            controllers: string[];
+        };
+    };
+    telemetry: {
+        auth: {
+            token: string;
+            /**
+             * Policy class name per endpoint. Each route resolves its policy by
+             * reading the config key below, so access can be tightened or loosened
+             * per endpoint without touching code.
+             */
+            policies: {
+                metrics: string;
+                stats: string;
+                timeline: string;
+                routes: string;
+                perf: string;
+                health: string;
+                ready: string;
+            };
+        };
+        /**
+         * Register prom-client's process / heap / cpu / event-loop metrics against
+         * the private registry at bootstrap.
+         */
+        collectDefaultMetrics: boolean;
+        /** Metric name prefix for the http telemetry metrics. */
+        prefix: string;
+        /** Duration histogram buckets in ms. */
+        buckets: number[];
+        /** Apdex satisfied threshold in ms; tolerated is 4x this. */
+        apdexThresholdMs: number;
+        timeline: {
+            /** Number of buckets retained in the ring. */
+            length: number;
+            /** Bucket width in ms. */
+            bucketMs: number;
+        };
+        routes: {
+            enabled: boolean;
+            /** Cap on distinct method+route keys held in memory. */
+            maxEntries: number;
+        };
+        perf: {
+            enabled: boolean;
+            /** Cap on distinct perf measurement names held in memory. */
+            maxNames: number;
+        };
+        health: {
+            /** Per-check timeout in ms. A timed-out check counts as down. */
+            timeoutMs: number;
+            /** When true a degraded overall status returns 503 rather than 200. */
+            failOnDegraded: boolean;
+            /** Reported by /telemetry/health. Omitted from the response when unset. */
+            version: string | undefined;
+        };
+    };
+};
+export default config;
+//# sourceMappingURL=telemetry.d.ts.map

package/lib/cjs/config/telemetry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry.d.ts","sourceRoot":"","sources":["../../../src/config/telemetry.ts"],"names":[],"mappings":"AAcA,QAAA,MAAM,MAAM;;;;;;;;;YAYN;;;;eAIG;;;;;;;;;;;QAcL;;;WAGG;;QAGH,yDAAyD;;QAGzD,wCAAwC;;QAGxC,6DAA6D;;;YAI3D,8CAA8C;;YAE9C,0BAA0B;;;;;YAM1B,wDAAwD;;;;;YAMxD,6DAA6D;;;;YAK7D,iEAAiE;;YAEjE,uEAAuE;;YAEvE,2EAA2E;qBACrD,MAAM,GAAG,SAAS;;;CAG7C,CAAC;AAEF,eAAe,MAAM,CAAC"}

package/lib/cjs/config/telemetry.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+function dir(path) {
+    const inCommonJs = typeof module !== 'undefined';
+    return (0, path_1.resolve)((0, path_1.normalize)((0, path_1.join)(process.env.WORKSPACE_ROOT_PATH ?? process.cwd(), 'node_modules', '@spinajs', 'telemetry', 'lib', inCommonJs ? 'cjs' : 'mjs', path)));
+}
+/**
+ * Duration histogram bucket boundaries ( ms ) for http request timing. Kept in
+ * sync with DURATION_BUCKETS_MS in middleware.ts, which is the compile-time
+ * default when no configuration is present.
+ */
+const DURATION_BUCKETS_MS = [5, 10, 25, 50, 100, 250, 500, 1000, 2500, 5000, 10000];
+const config = {
+    system: {
+        dirs: {
+            controllers: [dir('controllers')],
+        },
+    },
+    telemetry: {
+        auth: {
+            // set this in your project
+            token: '',
+            /**
+             * Policy class name per endpoint. Each route resolves its policy by
+             * reading the config key below, so access can be tightened or loosened
+             * per endpoint without touching code.
+             */
+            policies: {
+                metrics: 'TelemetryTokenPolicy',
+                stats: 'TelemetryTokenPolicy',
+                timeline: 'TelemetryTokenPolicy',
+                routes: 'TelemetryTokenPolicy',
+                perf: 'TelemetryTokenPolicy',
+                // probe endpoints must be reachable without credentials
+                health: 'PublicPolicy',
+                ready: 'PublicPolicy',
+            },
+        },
+        /**
+         * Register prom-client's process / heap / cpu / event-loop metrics against
+         * the private registry at bootstrap.
+         */
+        collectDefaultMetrics: true,
+        /** Metric name prefix for the http telemetry metrics. */
+        prefix: 'http',
+        /** Duration histogram buckets in ms. */
+        buckets: DURATION_BUCKETS_MS,
+        /** Apdex satisfied threshold in ms; tolerated is 4x this. */
+        apdexThresholdMs: 25,
+        timeline: {
+            /** Number of buckets retained in the ring. */
+            length: 60,
+            /** Bucket width in ms. */
+            bucketMs: 60_000,
+        },
+        routes: {
+            enabled: true,
+            /** Cap on distinct method+route keys held in memory. */
+            maxEntries: 500,
+        },
+        perf: {
+            enabled: true,
+            /** Cap on distinct perf measurement names held in memory. */
+            maxNames: 200,
+        },
+        health: {
+            /** Per-check timeout in ms. A timed-out check counts as down. */
+            timeoutMs: 2000,
+            /** When true a degraded overall status returns 503 rather than 200. */
+            failOnDegraded: false,
+            /** Reported by /telemetry/health. Omitted from the response when unset. */
+            version: undefined,
+        },
+    },
+};
+exports.default = config;
+//# sourceMappingURL=telemetry.js.map

package/lib/cjs/config/telemetry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry.js","sourceRoot":"","sources":["../../../src/config/telemetry.ts"],"names":[],"mappings":";;AAAA,+BAAgD;AAEhD,SAAS,GAAG,CAAC,IAAY;IACvB,MAAM,UAAU,GAAG,OAAO,MAAM,KAAK,WAAW,CAAC;IACjD,OAAO,IAAA,cAAO,EAAC,IAAA,gBAAS,EAAC,IAAA,WAAI,EAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,UAAU,EAAE,WAAW,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AACtK,CAAC;AAED;;;;GAIG;AACH,MAAM,mBAAmB,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;AAEpF,MAAM,MAAM,GAAG;IACb,MAAM,EAAE;QACN,IAAI,EAAE;YACJ,WAAW,EAAE,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;SAClC;KACF;IAED,SAAS,EAAE;QACT,IAAI,EAAE;YACJ,2BAA2B;YAC3B,KAAK,EAAE,EAAE;YAET;;;;eAIG;YACH,QAAQ,EAAE;gBACR,OAAO,EAAE,sBAAsB;gBAC/B,KAAK,EAAE,sBAAsB;gBAC7B,QAAQ,EAAE,sBAAsB;gBAChC,MAAM,EAAE,sBAAsB;gBAC9B,IAAI,EAAE,sBAAsB;gBAE5B,wDAAwD;gBACxD,MAAM,EAAE,cAAc;gBACtB,KAAK,EAAE,cAAc;aACtB;SACF;QAED;;;WAGG;QACH,qBAAqB,EAAE,IAAI;QAE3B,yDAAyD;QACzD,MAAM,EAAE,MAAM;QAEd,wCAAwC;QACxC,OAAO,EAAE,mBAAmB;QAE5B,6DAA6D;QAC7D,gBAAgB,EAAE,EAAE;QAEpB,QAAQ,EAAE;YACR,8CAA8C;YAC9C,MAAM,EAAE,EAAE;YACV,0BAA0B;YAC1B,QAAQ,EAAE,MAAM;SACjB;QAED,MAAM,EAAE;YACN,OAAO,EAAE,IAAI;YACb,wDAAwD;YACxD,UAAU,EAAE,GAAG;SAChB;QAED,IAAI,EAAE;YACJ,OAAO,EAAE,IAAI;YACb,6DAA6D;YAC7D,QAAQ,EAAE,GAAG;SACd;QAED,MAAM,EAAE;YACN,iEAAiE;YACjE,SAAS,EAAE,IAAI;YACf,uEAAuE;YACvE,cAAc,EAAE,KAAK;YACrB,2EAA2E;YAC3E,OAAO,EAAE,SAA+B;SACzC;KACF;CACF,CAAC;AAEF,kBAAe,MAAM,CAAC"}

package/lib/cjs/controllers/Metrics.d.ts

@@ -0,0 +1,26 @@
+import { BaseController } from '@spinajs/http';
+import { Metrics } from './../metrics.js';
+import { PrometheusResponse } from './../responses.js';
+import './../policies/TelemetryTokenPolicy.js';
+import './../policies/PublicPolicy.js';
+/**
+ * Prometheus scrape endpoint.
+ *
+ * Deliberately kept at the bare `/metrics` path rather than under the
+ * `/telemetry` prefix used by the JSON api — this is the path existing
+ * `scrape_configs` already point at.
+ */
+export declare class MetricsController extends BaseController {
+    protected MetricsService: Metrics;
+    /**
+     * Prometheus exposition text for every metric on the registry: the `http_*`
+     * request metrics, the `perf_*` bridge metrics, any application metrics
+     * declared through `Metrics.defineMetrics`, and — when
+     * `telemetry.collectDefaultMetrics` is on — the `process_*` / `nodejs_*` set.
+     *
+     * @response 200 {string} Prometheus exposition text ( text/plain )
+     * @response 403 Access token missing or invalid
+     */
+    getMetrics(): Promise<PrometheusResponse>;
+}
+//# sourceMappingURL=Metrics.d.ts.map

package/lib/cjs/controllers/Metrics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Metrics.d.ts","sourceRoot":"","sources":["../../../src/controllers/Metrics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,cAAc,EAAe,MAAM,eAAe,CAAC;AAGtE,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAUvD,OAAO,uCAAuC,CAAC;AAC/C,OAAO,+BAA+B,CAAC;AAEvC;;;;;;GAMG;AACH,qBACa,iBAAkB,SAAQ,cAAc;IAEnD,SAAS,CAAC,cAAc,EAAE,OAAO,CAAC;IAElC;;;;;;;;OAQG;IAGU,UAAU;CAGxB"}

package/lib/cjs/controllers/Metrics.js

@@ -0,0 +1,63 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetricsController = void 0;
+const http_1 = require("@spinajs/http");
+const di_1 = require("@spinajs/di");
+const metrics_js_1 = require("./../metrics.js");
+const responses_js_1 = require("./../responses.js");
+// Importing the policy modules runs their @Injectable decorators, which is what
+// puts the classes in the DI container under the names the routes below name as
+// STRINGS ( via `telemetry.auth.policies.*` ). Nothing else forces them to load:
+// this controller is mounted by the config-declared directory scan, and that
+// configuration is auto-discovered from node_modules — so an app never has to
+// import the package barrel. And http FAILS OPEN on an unresolvable policy name
+// ( it logs `No policy named ...`, drops it, and a route left with no policies
+// calls next() ), which would serve /metrics unauthenticated.
+require("./../policies/TelemetryTokenPolicy.js");
+require("./../policies/PublicPolicy.js");
+/**
+ * Prometheus scrape endpoint.
+ *
+ * Deliberately kept at the bare `/metrics` path rather than under the
+ * `/telemetry` prefix used by the JSON api — this is the path existing
+ * `scrape_configs` already point at.
+ */
+let MetricsController = class MetricsController extends http_1.BaseController {
+    /**
+     * Prometheus exposition text for every metric on the registry: the `http_*`
+     * request metrics, the `perf_*` bridge metrics, any application metrics
+     * declared through `Metrics.defineMetrics`, and — when
+     * `telemetry.collectDefaultMetrics` is on — the `process_*` / `nodejs_*` set.
+     *
+     * @response 200 {string} Prometheus exposition text ( text/plain )
+     * @response 403 Access token missing or invalid
+     */
+    async getMetrics() {
+        return new responses_js_1.PrometheusResponse(this.MetricsService);
+    }
+};
+exports.MetricsController = MetricsController;
+__decorate([
+    (0, di_1.Autoinject)(metrics_js_1.Metrics),
+    __metadata("design:type", metrics_js_1.Metrics)
+], MetricsController.prototype, "MetricsService", void 0);
+__decorate([
+    (0, http_1.Get)('/'),
+    (0, http_1.Policy)('telemetry.auth.policies.metrics'),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], MetricsController.prototype, "getMetrics", null);
+exports.MetricsController = MetricsController = __decorate([
+    (0, http_1.BasePath)('metrics')
+], MetricsController);
+//# sourceMappingURL=Metrics.js.map

package/lib/cjs/controllers/Metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Metrics.js","sourceRoot":"","sources":["../../../src/controllers/Metrics.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wCAAsE;AACtE,oCAAyC;AAEzC,gDAA0C;AAC1C,oDAAuD;AAEvD,gFAAgF;AAChF,gFAAgF;AAChF,iFAAiF;AACjF,6EAA6E;AAC7E,8EAA8E;AAC9E,gFAAgF;AAChF,+EAA+E;AAC/E,8DAA8D;AAC9D,iDAA+C;AAC/C,yCAAuC;AAEvC;;;;;;GAMG;AAEI,IAAM,iBAAiB,GAAvB,MAAM,iBAAkB,SAAQ,qBAAc;IAInD;;;;;;;;OAQG;IAGU,AAAN,KAAK,CAAC,UAAU;QACrB,OAAO,IAAI,iCAAkB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACrD,CAAC;CACF,CAAA;AAlBY,8CAAiB;AAElB;IADT,IAAA,eAAU,EAAC,oBAAO,CAAC;8BACM,oBAAO;yDAAC;AAarB;IAFZ,IAAA,UAAG,EAAC,GAAG,CAAC;IACR,IAAA,aAAM,EAAC,iCAAiC,CAAC;;;;mDAGzC;4BAjBU,iBAAiB;IAD7B,IAAA,eAAQ,EAAC,SAAS,CAAC;GACP,iBAAiB,CAkB7B"}

package/lib/cjs/controllers/Telemetry.d.ts

@@ -0,0 +1,92 @@
+import { BaseController, Ok } from '@spinajs/http';
+import { TelemetryStore } from './../store.js';
+import { InMemoryPerfSink } from './../InMemoryPerfSink.js';
+import { HealthCheckRunner } from './../health.js';
+import { ServiceUnavailable } from './../responses.js';
+import './../dto/index.js';
+import './../policies/TelemetryTokenPolicy.js';
+import './../policies/PublicPolicy.js';
+/**
+ * JSON telemetry API. Machine-facing — consumed by dashboards, uptime monitors
+ * and orchestrator probes.
+ *
+ * The prometheus scrape endpoint deliberately lives on its own controller at
+ * the bare `/metrics` path, not under this prefix.
+ */
+export declare class TelemetryController extends BaseController {
+    protected Store: TelemetryStore;
+    protected PerfSink: InMemoryPerfSink;
+    protected Health: HealthCheckRunner;
+    protected Version: string;
+    /**
+     * Lifetime request statistics plus the rolling timeline.
+     *
+     * @returns {StatsResponse} Lifetime stats and the per-bucket timeline
+     * @response 403 Access token missing or invalid
+     */
+    getStats(): Promise<Ok<{
+        all: import("../requestStats.js").IRequestStatsSnapshot;
+        timeline: import("../timeline.js").ITimelineSnapshot;
+    }>>;
+    /**
+     * The rolling timeline alone, with each bucket annotated with the wall-clock
+     * window it covers so consumers do not have to reverse the bucket key.
+     *
+     * @param buckets - how many of the most recent buckets to return; all of them when omitted
+     * @returns {TimelineResponse} The annotated timeline
+     * @response 400 `buckets` was not a positive integer
+     * @response 403 Access token missing or invalid
+     */
+    getTimeline(buckets?: string): Promise<Ok<{
+        bucketMs: number;
+        length: number;
+        buckets: {
+            key: number;
+            from: number;
+            to: number;
+            stats: import("../requestStats.js").IRequestStatsSnapshot;
+        }[];
+    }>>;
+    /**
+     * Per method+route request breakdown.
+     *
+     * No percentiles — query them from prometheus against the `route`-labelled
+     * `http_request_duration_ms` histogram, which carries the same label values.
+     *
+     * @returns {RoutesResponse} Per-route request statistics
+     * @response 403 Access token missing or invalid
+     */
+    getRoutes(): Promise<Ok<import("../routeStats.js").IRouteStatsSnapshot>>;
+    /**
+     * Aggregated performance measurements collected through the `Perf` facade —
+     * every `Perf.measure`, `@Measure`, `Perf.count` and `Perf.value` in the
+     * process, including the ORM's `orm.query` spans.
+     *
+     * @returns {PerfResponse} Aggregated spans and events
+     * @response 403 Access token missing or invalid
+     */
+    getPerf(): Promise<Ok<import("./../InMemoryPerfSink.js").IPerfSnapshot>>;
+    /**
+     * Liveness. Runs no checks, so it can never be made slow or flaky by a
+     * dependency — if this answers, the process is alive.
+     *
+     * @returns {HealthResponse} Process liveness information
+     */
+    getHealth(): Promise<Ok<{
+        version?: string | undefined;
+        status: string;
+        startedAt: number;
+        uptimeMs: number;
+        pid: number;
+        node: string;
+    }>>;
+    /**
+     * Readiness. Runs every registered `HealthCheck`, each raced against
+     * `telemetry.health.timeoutMs`.
+     *
+     * @returns {ReadyResponse} Overall readiness and the per-check results
+     * @response 503 At least one check is down ( or degraded, when `telemetry.health.failOnDegraded` is set )
+     */
+    getReady(): Promise<ServiceUnavailable<import("./../health.js").IReadyReport> | Ok<import("./../health.js").IReadyReport>>;
+}
+//# sourceMappingURL=Telemetry.d.ts.map

package/lib/cjs/controllers/Telemetry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Telemetry.d.ts","sourceRoot":"","sources":["../../../src/controllers/Telemetry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,cAAc,EAAsB,EAAE,EAAE,MAAM,eAAe,CAAC;AAKjF,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAIvD,OAAO,mBAAmB,CAAC;AAW3B,OAAO,uCAAuC,CAAC;AAC/C,OAAO,+BAA+B,CAAC;AAEvC;;;;;;GAMG;AACH,qBACa,mBAAoB,SAAQ,cAAc;IAErD,SAAS,CAAC,KAAK,EAAE,cAAc,CAAC;IAGhC,SAAS,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IAGrC,SAAS,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAGpC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;IAE1B;;;;;OAKG;IAGU,QAAQ;;;;IAarB;;;;;;;;OAQG;IAGU,WAAW,CAAU,OAAO,CAAC,EAAE,MAAM;;;;;;;;;;IA0ClD;;;;;;;;OAQG;IAGU,SAAS;IAItB;;;;;;;OAOG;IAGU,OAAO;IAIpB;;;;;OAKG;IAGU,SAAS;;;;;;;;IAetB;;;;;;OAMG;IAGU,QAAQ;CAStB"}