@samuelaj1/eazisend-service-kit 1.0.7 → 1.0.8

package/dist/chunk-TS72ONWN.js

@@ -0,0 +1,97 @@
+// src/middlewares/monitoring.middleware.ts
+import { collectDefaultMetrics, Counter, Gauge, Histogram, Registry } from "prom-client";
+var applications = /* @__PURE__ */ new WeakMap();
+var methods = /* @__PURE__ */ new Set(["GET", "HEAD", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "CONNECT", "TRACE"]);
+function routeLabel(request) {
+  const path = request.route?.path;
+  if (typeof path === "string") return path;
+  if (Array.isArray(path) && path.every((value) => typeof value === "string")) {
+    return path.join("|");
+  }
+  return path instanceof RegExp ? "__regexp__" : "__unmatched__";
+}
+function setupMetrics(app, options) {
+  if (typeof options?.serviceName !== "string" || !options.serviceName.trim()) {
+    throw new Error("Metrics serviceName must be a non-empty string");
+  }
+  const existing = applications.get(app);
+  if (existing) {
+    if (existing.serviceName !== options.serviceName) {
+      throw new Error("Metrics already initialized with a different serviceName");
+    }
+    return existing.registry;
+  }
+  const registry = new Registry();
+  registry.setDefaultLabels({ service: options.serviceName });
+  collectDefaultMetrics({ register: registry });
+  const labelNames = ["method", "route", "status_code"];
+  const requests = new Counter({
+    name: "http_requests_total",
+    help: "Completed HTTP requests",
+    labelNames,
+    registers: [registry]
+  });
+  const duration = new Histogram({
+    name: "http_request_duration_seconds",
+    help: "HTTP request duration in seconds",
+    labelNames,
+    registers: [registry],
+    buckets: [5e-3, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10]
+  });
+  const errors = new Counter({
+    name: "http_request_errors_total",
+    help: "Completed HTTP requests with 4xx or 5xx status",
+    labelNames,
+    registers: [registry]
+  });
+  const active = new Gauge({
+    name: "http_active_requests",
+    help: "HTTP requests currently in progress",
+    registers: [registry]
+  });
+  active.set(0);
+  const middleware = (request, response, next) => {
+    if (/^\/metrics\/?$/i.test(request.path)) return next();
+    const started = process.hrtime.bigint();
+    active.inc();
+    let completed = false;
+    const complete = () => {
+      if (completed) return;
+      completed = true;
+      response.removeListener("finish", complete);
+      response.removeListener("close", complete);
+      active.dec();
+      const labels = {
+        method: methods.has(request.method) ? request.method : "OTHER",
+        route: routeLabel(request),
+        // A disconnected response has no completed HTTP status.
+        status_code: response.writableFinished ? String(response.statusCode) : "aborted"
+      };
+      requests.inc(labels);
+      duration.observe(labels, Number(process.hrtime.bigint() - started) / 1e9);
+      if (response.writableFinished && response.statusCode >= 400 && response.statusCode < 600) {
+        errors.inc(labels);
+      }
+    };
+    response.once("finish", complete);
+    response.once("close", complete);
+    next();
+  };
+  app.use(middleware);
+  app.get("/metrics", async (_request, response, next) => {
+    try {
+      const metrics = await registry.metrics();
+      response.setHeader("Content-Type", registry.contentType);
+      response.setHeader("Cache-Control", "no-store");
+      response.end(metrics);
+    } catch (error) {
+      next(error);
+    }
+  });
+  applications.set(app, { serviceName: options.serviceName, registry });
+  return registry;
+}
+
+export {
+  setupMetrics
+};

package/dist/index.cjs

@@ -38,6 +38,7 @@ __export(index_exports, {
   registerSecurityMiddleware: () => registerSecurityMiddleware,
   registerStandardMiddleware: () => registerStandardMiddleware,
   runServer: () => runServer,
+  setupMetrics: () => setupMetrics,
   verifyGatewayRequest: () => verifyGatewayRequest
 });
 module.exports = __toCommonJS(index_exports);
@@ -428,6 +429,100 @@ function registerErrorMiddleware(app) {
     res.status(import_http_status_codes.StatusCodes.INTERNAL_SERVER_ERROR).json({ error: err.message });
   };
 }
+
+// src/middlewares/monitoring.middleware.ts
+var import_prom_client = require("prom-client");
+var applications = /* @__PURE__ */ new WeakMap();
+var methods = /* @__PURE__ */ new Set(["GET", "HEAD", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "CONNECT", "TRACE"]);
+function routeLabel(request) {
+  const path = request.route?.path;
+  if (typeof path === "string") return path;
+  if (Array.isArray(path) && path.every((value) => typeof value === "string")) {
+    return path.join("|");
+  }
+  return path instanceof RegExp ? "__regexp__" : "__unmatched__";
+}
+function setupMetrics(app, options) {
+  if (typeof options?.serviceName !== "string" || !options.serviceName.trim()) {
+    throw new Error("Metrics serviceName must be a non-empty string");
+  }
+  const existing = applications.get(app);
+  if (existing) {
+    if (existing.serviceName !== options.serviceName) {
+      throw new Error("Metrics already initialized with a different serviceName");
+    }
+    return existing.registry;
+  }
+  const registry = new import_prom_client.Registry();
+  registry.setDefaultLabels({ service: options.serviceName });
+  (0, import_prom_client.collectDefaultMetrics)({ register: registry });
+  const labelNames = ["method", "route", "status_code"];
+  const requests = new import_prom_client.Counter({
+    name: "http_requests_total",
+    help: "Completed HTTP requests",
+    labelNames,
+    registers: [registry]
+  });
+  const duration = new import_prom_client.Histogram({
+    name: "http_request_duration_seconds",
+    help: "HTTP request duration in seconds",
+    labelNames,
+    registers: [registry],
+    buckets: [5e-3, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10]
+  });
+  const errors = new import_prom_client.Counter({
+    name: "http_request_errors_total",
+    help: "Completed HTTP requests with 4xx or 5xx status",
+    labelNames,
+    registers: [registry]
+  });
+  const active = new import_prom_client.Gauge({
+    name: "http_active_requests",
+    help: "HTTP requests currently in progress",
+    registers: [registry]
+  });
+  active.set(0);
+  const middleware = (request, response, next) => {
+    if (/^\/metrics\/?$/i.test(request.path)) return next();
+    const started = process.hrtime.bigint();
+    active.inc();
+    let completed = false;
+    const complete = () => {
+      if (completed) return;
+      completed = true;
+      response.removeListener("finish", complete);
+      response.removeListener("close", complete);
+      active.dec();
+      const labels = {
+        method: methods.has(request.method) ? request.method : "OTHER",
+        route: routeLabel(request),
+        // A disconnected response has no completed HTTP status.
+        status_code: response.writableFinished ? String(response.statusCode) : "aborted"
+      };
+      requests.inc(labels);
+      duration.observe(labels, Number(process.hrtime.bigint() - started) / 1e9);
+      if (response.writableFinished && response.statusCode >= 400 && response.statusCode < 600) {
+        errors.inc(labels);
+      }
+    };
+    response.once("finish", complete);
+    response.once("close", complete);
+    next();
+  };
+  app.use(middleware);
+  app.get("/metrics", async (_request, response, next) => {
+    try {
+      const metrics = await registry.metrics();
+      response.setHeader("Content-Type", registry.contentType);
+      response.setHeader("Cache-Control", "no-store");
+      response.end(metrics);
+    } catch (error) {
+      next(error);
+    }
+  });
+  applications.set(app, { serviceName: options.serviceName, registry });
+  return registry;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   LogLevelTypes,
@@ -438,5 +533,6 @@ function registerErrorMiddleware(app) {
   registerSecurityMiddleware,
   registerStandardMiddleware,
   runServer,
+  setupMetrics,
   verifyGatewayRequest
 });

package/dist/index.d.cts

@@ -1,6 +1,8 @@
 import { Express, Request, Response, NextFunction, Application } from 'express';
 import { LogEntry } from 'winston';
 import { Channel } from 'amqplib';
+export { MetricsOptions, setupMetrics } from './middlewares/monitoring.middleware.cjs';
+import 'prom-client';
 
 declare function registerStandardMiddleware(app: Express): void;
 

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 import { Express, Request, Response, NextFunction, Application } from 'express';
 import { LogEntry } from 'winston';
 import { Channel } from 'amqplib';
+export { MetricsOptions, setupMetrics } from './middlewares/monitoring.middleware.js';
+import 'prom-client';
 
 declare function registerStandardMiddleware(app: Express): void;
 

package/dist/index.js

@@ -1,3 +1,7 @@
+import {
+  setupMetrics
+} from "./chunk-TS72ONWN.js";
+
 // src/middlewares/standard.middleware.ts
 import { json, urlencoded } from "express";
 import compression from "compression";
@@ -389,5 +393,6 @@ export {
   registerSecurityMiddleware,
   registerStandardMiddleware,
   runServer,
+  setupMetrics,
   verifyGatewayRequest
 };

package/dist/middlewares/monitoring.middleware.cjs

@@ -0,0 +1,121 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/middlewares/monitoring.middleware.ts
+var monitoring_middleware_exports = {};
+__export(monitoring_middleware_exports, {
+  setupMetrics: () => setupMetrics
+});
+module.exports = __toCommonJS(monitoring_middleware_exports);
+var import_prom_client = require("prom-client");
+var applications = /* @__PURE__ */ new WeakMap();
+var methods = /* @__PURE__ */ new Set(["GET", "HEAD", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "CONNECT", "TRACE"]);
+function routeLabel(request) {
+  const path = request.route?.path;
+  if (typeof path === "string") return path;
+  if (Array.isArray(path) && path.every((value) => typeof value === "string")) {
+    return path.join("|");
+  }
+  return path instanceof RegExp ? "__regexp__" : "__unmatched__";
+}
+function setupMetrics(app, options) {
+  if (typeof options?.serviceName !== "string" || !options.serviceName.trim()) {
+    throw new Error("Metrics serviceName must be a non-empty string");
+  }
+  const existing = applications.get(app);
+  if (existing) {
+    if (existing.serviceName !== options.serviceName) {
+      throw new Error("Metrics already initialized with a different serviceName");
+    }
+    return existing.registry;
+  }
+  const registry = new import_prom_client.Registry();
+  registry.setDefaultLabels({ service: options.serviceName });
+  (0, import_prom_client.collectDefaultMetrics)({ register: registry });
+  const labelNames = ["method", "route", "status_code"];
+  const requests = new import_prom_client.Counter({
+    name: "http_requests_total",
+    help: "Completed HTTP requests",
+    labelNames,
+    registers: [registry]
+  });
+  const duration = new import_prom_client.Histogram({
+    name: "http_request_duration_seconds",
+    help: "HTTP request duration in seconds",
+    labelNames,
+    registers: [registry],
+    buckets: [5e-3, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10]
+  });
+  const errors = new import_prom_client.Counter({
+    name: "http_request_errors_total",
+    help: "Completed HTTP requests with 4xx or 5xx status",
+    labelNames,
+    registers: [registry]
+  });
+  const active = new import_prom_client.Gauge({
+    name: "http_active_requests",
+    help: "HTTP requests currently in progress",
+    registers: [registry]
+  });
+  active.set(0);
+  const middleware = (request, response, next) => {
+    if (/^\/metrics\/?$/i.test(request.path)) return next();
+    const started = process.hrtime.bigint();
+    active.inc();
+    let completed = false;
+    const complete = () => {
+      if (completed) return;
+      completed = true;
+      response.removeListener("finish", complete);
+      response.removeListener("close", complete);
+      active.dec();
+      const labels = {
+        method: methods.has(request.method) ? request.method : "OTHER",
+        route: routeLabel(request),
+        // A disconnected response has no completed HTTP status.
+        status_code: response.writableFinished ? String(response.statusCode) : "aborted"
+      };
+      requests.inc(labels);
+      duration.observe(labels, Number(process.hrtime.bigint() - started) / 1e9);
+      if (response.writableFinished && response.statusCode >= 400 && response.statusCode < 600) {
+        errors.inc(labels);
+      }
+    };
+    response.once("finish", complete);
+    response.once("close", complete);
+    next();
+  };
+  app.use(middleware);
+  app.get("/metrics", async (_request, response, next) => {
+    try {
+      const metrics = await registry.metrics();
+      response.setHeader("Content-Type", registry.contentType);
+      response.setHeader("Cache-Control", "no-store");
+      response.end(metrics);
+    } catch (error) {
+      next(error);
+    }
+  });
+  applications.set(app, { serviceName: options.serviceName, registry });
+  return registry;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  setupMetrics
+});

package/dist/middlewares/monitoring.middleware.d.cts

@@ -0,0 +1,15 @@
+import { Express } from 'express';
+import { Registry } from 'prom-client';
+
+interface MetricsOptions {
+    serviceName: string;
+}
+/**
+ * Register before authentication and application routes so GET /metrics bypasses auth.
+ * Restrict /metrics to internal access at the Kubernetes networking/Ingress level.
+ * Returns an app-local registry for custom metrics (use registers: [registry]).
+ * Router labels use leaf templates, omitting potentially dynamic mount prefixes.
+ */
+declare function setupMetrics(app: Express, options: MetricsOptions): Registry;
+
+export { type MetricsOptions, setupMetrics };

package/dist/middlewares/monitoring.middleware.d.ts

@@ -0,0 +1,15 @@
+import { Express } from 'express';
+import { Registry } from 'prom-client';
+
+interface MetricsOptions {
+    serviceName: string;
+}
+/**
+ * Register before authentication and application routes so GET /metrics bypasses auth.
+ * Restrict /metrics to internal access at the Kubernetes networking/Ingress level.
+ * Returns an app-local registry for custom metrics (use registers: [registry]).
+ * Router labels use leaf templates, omitting potentially dynamic mount prefixes.
+ */
+declare function setupMetrics(app: Express, options: MetricsOptions): Registry;
+
+export { type MetricsOptions, setupMetrics };

package/dist/middlewares/monitoring.middleware.js

@@ -0,0 +1,6 @@
+import {
+  setupMetrics
+} from "../chunk-TS72ONWN.js";
+export {
+  setupMetrics
+};

package/package.json

@@ -1,10 +1,20 @@
 {
   "name": "@samuelaj1/eazisend-service-kit",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "scripts": {
     "build": "tsup"
   },
   "exports": {
+    "./monitoring": {
+      "import": {
+        "types": "./dist/middlewares/monitoring.middleware.d.ts",
+        "default": "./dist/middlewares/monitoring.middleware.js"
+      },
+      "require": {
+        "types": "./dist/middlewares/monitoring.middleware.d.cts",
+        "default": "./dist/middlewares/monitoring.middleware.cjs"
+      }
+    },
     ".": {
       "import": {
         "types": "./dist/index.d.ts",
@@ -49,6 +59,7 @@
     "hpp": "^0.2.3",
     "http-status-codes": "^2.3.0",
     "jsonwebtoken": "^9.0.3",
+    "prom-client": "^15.1.3",
     "winston": "^3.19.0",
     "winston-elasticsearch": "^0.19.0"
   }