@andretimm/pharus 1.0.0

package/README.md

@@ -0,0 +1,175 @@
+# @andretimm/pharus
+
+A framework-agnostic metrics collection library for Node.js applications. Designed to easily integrate with **Express**, **Fastify**, and **NestJS**. It automatically collects request and response metrics (such as latency, HTTP status codes, and payload sizes) and sends them to a configured ingestion endpoint.
+
+## Key Features
+
+- **Framework Agnostic:** Core logic separated from framework adapters (`express`, `fastify`, `nestjs`).
+- **Automatic Collection:** Captures response duration, HTTP status code, request/response sizes, route, and HTTP method.
+- **Optimized Batching:** Metrics are accumulated in memory and periodically sent in batches to reduce network overhead.
+- **Highly Configurable:** Full control over batch size, auto-flush intervals, and captured data (body, query params, route params).
+- **Native Security:** Built-in support for redacting sensitive data using regular expressions (e.g., passwords, tokens).
+
+---
+
+## 📦 Installation
+
+You can install the package directly using npm or yarn:
+
+```bash
+npm install @andretimm/pharus
+# or
+yarn add @andretimm/pharus
+```
+
+---
+
+## ⚙️ Configuration Options (`MetricsOptions`)
+
+All integrations accept the same options interface:
+
+| Property             | Type      | Required | Default | Description                                                                 |
+| -------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------- |
+| `projectId`          | `string`  | **Yes**  | -       | The ID of the project associated with the metrics being sent.               |
+| `ingestUrl`          | `string`  | **Yes**  | -       | The destination URL where metric batches will be ingested.                  |
+| `batchSize`          | `number`  | No       | `50`    | Number of metrics to accumulate in memory before flushing the batch.        |
+| `flushIntervalMs`    | `number`  | No       | `5000`  | Maximum time (in ms) to wait before automatically flushing the batch.       |
+| `enabled`            | `boolean` | No       | `true`  | Enables or disables metric collection globally.                             |
+| `captureBody`        | `boolean` | No       | `false` | Whether to capture the request `body` payload.                              |
+| `captureQuery`       | `boolean` | No       | `false` | Whether to capture URL `query string` parameters.                           |
+| `captureParams`      | `boolean` | No       | `false` | Whether to capture dynamic route parameters (e.g., `/user/:id`).            |
+| `sensitiveKeysRegex` | `RegExp`  | No       | -       | Regular expression to hide/redact (replace with `*****`) sensitive keys.    |
+
+---
+
+## 🚀 Usage Guide by Framework
+
+Below is how to configure and plug `@andretimm/pharus` into each of the main supported Node.js frameworks.
+
+### 1. Express.js
+
+Import the `metricsMiddleware` from the specific Express entry point.
+
+**Important Notice**: If you want to capture request bodies (`captureBody: true`), you MUST register your body parsing middleware (e.g., `express.json()`) **before** adding the metrics middleware.
+
+```typescript
+import express from 'express';
+import { metricsMiddleware } from '@andretimm/pharus/express';
+
+const app = express();
+
+// JSON Parsing (Required before metrics if using `captureBody: true`)
+app.use(express.json());
+
+// Registering the metrics middleware
+app.use(metricsMiddleware({
+  projectId: 'my-super-project',
+  ingestUrl: 'https://my-metrics-api.com/ingest',
+  captureBody: true,        // Optional: Captures request payloads
+  batchSize: 10,            // Optional: Sends a batch every 10 processed requests
+}));
+
+app.get('/', (req, res) => {
+  res.send('Metrics are being captured silently!');
+});
+
+app.listen(3000, () => {
+    console.log('Server is running on port 3000');
+});
+```
+
+### 2. Fastify
+
+The package exposes a plugin fully compatible with Fastify's internal ecosystem, safely handling the request/response lifecycle (`onRequest` and `onResponse`).
+
+```typescript
+import fastify from 'fastify';
+import { metricsPlugin } from '@andretimm/pharus/fastify';
+
+const app = fastify();
+
+// Register the metrics plugin in Fastify
+app.register(metricsPlugin, {
+  projectId: 'my-super-project',
+  ingestUrl: 'https://my-metrics-api.com/ingest',
+  flushIntervalMs: 2000, // Optional: Ensures metrics are sent at least every 2 seconds
+  captureQuery: true,    // Optional: Saves all query strings
+});
+
+app.get('/', async () => {
+  return { hello: 'world' };
+});
+
+app.listen({ port: 3000 }, (err) => {
+  if (err) {
+    console.error(err);
+    process.exit(1);
+  }
+  console.log('Fastify is running on port 3000');
+});
+```
+
+### 3. NestJS
+
+The package provides a native NestJS `MetricsModule`. Simply import the root module via `forRoot()` in your application, and it will automatically inject the global execution time and payload size `Interceptors`.
+
+```typescript
+import { Module } from '@nestjs/common';
+import { MetricsModule } from '@andretimm/pharus/nestjs';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+
+@Module({
+  imports: [
+    // Register the module globally
+    MetricsModule.forRoot({
+      projectId: 'my-super-project',
+      ingestUrl: 'https://my-metrics-api.com/ingest',
+      sensitiveKeysRegex: /password|token|secret|credit_card/i, // Redacts critical body data
+      captureBody: true, 
+    }),
+  ],
+  controllers: [AppController],
+  providers: [AppService],
+})
+export class AppModule {}
+```
+
+---
+
+## 🛡 Advanced Features
+
+### Masking / Redacting Sensitive Data
+
+One of the most useful features when logging full payloads is masking passwords or credit card data. You can control this using the `sensitiveKeysRegex` option.
+
+```typescript
+metricsMiddleware({
+  // ... other initial options
+  captureBody: true,
+  sensitiveKeysRegex: /password|credit_card|cvc|secret_key/i
+})
+```
+
+Any object or key in the extracted payload/parameters that matches the regular expression `/password|credit_card/i` will have its value replaced in memory with `"*****"` before being cached or sent to the metrics API.
+
+### Manual / Forced Flush
+
+In serverless environments (e.g., AWS Lambda) or during a **graceful shutdown** (cloud interruptions), Node might terminate your process before the `flushIntervalMs` triggers organically.
+
+To ensure no in-memory data loss, you can leverage the core singleton:
+
+```typescript
+import { MetricsCollector } from '@andretimm/pharus';
+
+const collector = MetricsCollector.getInstance();
+await collector.flush(); // Forces an immediate push of all pending metrics
+await collector.shutdown(); // And then, safely terminates the global dispatch loop
+```
+
+---
+
+## 📜 License
+
+This software is licensed under the [ISC License](./LICENSE).
+

package/dist/core/collector.d.ts

@@ -0,0 +1,18 @@
+import { Metric, MetricsOptions } from './types';
+export declare class MetricsCollector {
+    private static instance;
+    private buffer;
+    private flushInterval;
+    private readonly batchSize;
+    private readonly flushIntervalMs;
+    private readonly transport;
+    private readonly enabled;
+    private readonly projectId;
+    private constructor();
+    static initialize(options: MetricsOptions): MetricsCollector;
+    static getInstance(): MetricsCollector;
+    add(metric: Metric): void;
+    flush(): Promise<void>;
+    private startFlushInterval;
+    shutdown(): Promise<void>;
+}

package/dist/core/collector.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetricsCollector = void 0;
+const transport_1 = require("./transport");
+class MetricsCollector {
+    constructor(options) {
+        this.buffer = [];
+        this.flushInterval = null;
+        this.batchSize = options.batchSize || 50;
+        this.flushIntervalMs = options.flushIntervalMs || 5000;
+        this.transport = new transport_1.HttpTransport(options.ingestUrl);
+        this.enabled = options.enabled !== false;
+        this.projectId = options.projectId;
+        if (this.enabled) {
+            this.startFlushInterval();
+        }
+    }
+    static initialize(options) {
+        if (!MetricsCollector.instance) {
+            MetricsCollector.instance = new MetricsCollector(options);
+        }
+        return MetricsCollector.instance;
+    }
+    static getInstance() {
+        if (!MetricsCollector.instance) {
+            throw new Error('MetricsCollector not initialized. Call MetricsCollector.initialize() first.');
+        }
+        return MetricsCollector.instance;
+    }
+    add(metric) {
+        if (!this.enabled)
+            return;
+        this.buffer.push(metric);
+        if (this.buffer.length >= this.batchSize) {
+            void this.flush();
+        }
+    }
+    async flush() {
+        if (this.buffer.length === 0)
+            return;
+        const metricsToSend = [...this.buffer];
+        this.buffer = [];
+        await this.transport.send(metricsToSend);
+    }
+    startFlushInterval() {
+        if (this.flushInterval) {
+            clearInterval(this.flushInterval);
+        }
+        this.flushInterval = setInterval(() => {
+            void this.flush();
+        }, this.flushIntervalMs);
+    }
+    async shutdown() {
+        if (this.flushInterval) {
+            clearInterval(this.flushInterval);
+        }
+        await this.flush();
+    }
+}
+exports.MetricsCollector = MetricsCollector;
+//# sourceMappingURL=collector.js.map

package/dist/core/collector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collector.js","sourceRoot":"","sources":["../../src/core/collector.ts"],"names":[],"mappings":";;;AACA,2CAA4C;AAE5C,MAAa,gBAAgB;IAU3B,YAAoB,OAAuB;QARnC,WAAM,GAAa,EAAE,CAAC;QACtB,kBAAa,GAA0B,IAAI,CAAC;QAQlD,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC;QACzC,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,IAAI,CAAC;QACvD,IAAI,CAAC,SAAS,GAAG,IAAI,yBAAa,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACtD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,KAAK,KAAK,CAAC;QACzC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QAEnC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC5B,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,UAAU,CAAC,OAAuB;QAC9C,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC;YAC/B,gBAAgB,CAAC,QAAQ,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC5D,CAAC;QACD,OAAO,gBAAgB,CAAC,QAAQ,CAAC;IACnC,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,6EAA6E,CAC9E,CAAC;QACJ,CAAC;QACD,OAAO,gBAAgB,CAAC,QAAQ,CAAC;IACnC,CAAC;IAEM,GAAG,CAAC,MAAc;QACvB,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO;QAE1B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACzC,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;QACpB,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAErC,MAAM,aAAa,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QAEjB,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;IAEO,kBAAkB;QACxB,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,CAAC;QACD,IAAI,CAAC,aAAa,GAAG,WAAW,CAAC,GAAG,EAAE;YACpC,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;QACpB,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;IAC3B,CAAC;IAEM,KAAK,CAAC,QAAQ;QACnB,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,CAAC;QACD,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;CACF;AAvED,4CAuEC"}

package/dist/core/collector.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/core/collector.spec.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const collector_1 = require("./collector");
+const transport_1 = require("./transport");
+jest.mock('./transport');
+describe('MetricsCollector', () => {
+    beforeEach(() => {
+        collector_1.MetricsCollector.instance = undefined;
+        jest.clearAllMocks();
+    });
+    it('should throw if getInstance is called before initialize', () => {
+        expect(() => collector_1.MetricsCollector.getInstance()).toThrow('MetricsCollector not initialized');
+    });
+    it('should initialize correctly as a singleton', () => {
+        const options = {
+            apiKey: 'test-api-key',
+            ingestUrl: 'http://test.url/ingest',
+            projectId: 'test-project',
+            enabled: false,
+        };
+        const collector1 = collector_1.MetricsCollector.initialize(options);
+        const collector2 = collector_1.MetricsCollector.getInstance();
+        expect(collector1).toBeDefined();
+        expect(collector1).toBe(collector2);
+    });
+    it('should add metrics to buffer and not flush if below batch size', () => {
+        const options = {
+            apiKey: 'test-api-key',
+            ingestUrl: 'http://test.url/ingest',
+            projectId: 'test-project',
+            batchSize: 5,
+            enabled: true,
+        };
+        const collector = collector_1.MetricsCollector.initialize(options);
+        collector.add({
+            projectId: 'test-project',
+            duration: 100,
+            requestSize: 100,
+            responseSize: 100,
+            route: '/test',
+            method: 'GET',
+            statusCode: 200,
+            timestamp: new Date().toISOString(),
+        });
+        const mockTransportInstance = transport_1.HttpTransport.mock.instances[0];
+        expect(mockTransportInstance.send).not.toHaveBeenCalled();
+        void collector.shutdown();
+    });
+});
+//# sourceMappingURL=collector.spec.js.map

package/dist/core/collector.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collector.spec.js","sourceRoot":"","sources":["../../src/core/collector.spec.ts"],"names":[],"mappings":";;AAAA,2CAA+C;AAC/C,2CAA4C;AAE5C,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;AAEzB,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,UAAU,CAAC,GAAG,EAAE;QAEb,4BAAwB,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC/C,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;QACjE,MAAM,CAAC,GAAG,EAAE,CAAC,4BAAgB,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,kCAAkC,CAAC,CAAC;IAC3F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,OAAO,GAAG;YACd,MAAM,EAAE,cAAc;YACtB,SAAS,EAAE,wBAAwB;YACnC,SAAS,EAAE,cAAc;YACzB,OAAO,EAAE,KAAK;SACf,CAAC;QAEF,MAAM,UAAU,GAAG,4BAAgB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACxD,MAAM,UAAU,GAAG,4BAAgB,CAAC,WAAW,EAAE,CAAC;QAElD,MAAM,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,CAAC;QACjC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,OAAO,GAAG;YACd,MAAM,EAAE,cAAc;YACtB,SAAS,EAAE,wBAAwB;YACnC,SAAS,EAAE,cAAc;YACzB,SAAS,EAAE,CAAC;YACZ,OAAO,EAAE,IAAI;SACd,CAAC;QAEF,MAAM,SAAS,GAAG,4BAAgB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAGvD,SAAS,CAAC,GAAG,CAAC;YACZ,SAAS,EAAE,cAAc;YACzB,QAAQ,EAAE,GAAG;YACb,WAAW,EAAE,GAAG;YAChB,YAAY,EAAE,GAAG;YACjB,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,KAAK;YACb,UAAU,EAAE,GAAG;YACf,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;SACpC,CAAC,CAAC;QAGH,MAAM,qBAAqB,GAAI,yBAA2B,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC7E,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QAG1D,KAAK,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC5B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/core/transport.d.ts

@@ -0,0 +1,6 @@
+import { Metric, Transport } from './types';
+export declare class HttpTransport implements Transport {
+    private readonly ingestUrl;
+    constructor(ingestUrl: string);
+    send(metrics: Metric[]): Promise<void>;
+}

package/dist/core/transport.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpTransport = void 0;
+const axios_1 = __importDefault(require("axios"));
+class HttpTransport {
+    constructor(ingestUrl) {
+        this.ingestUrl = ingestUrl;
+    }
+    async send(metrics) {
+        try {
+            await axios_1.default.post(this.ingestUrl, { metrics }, {
+                headers: {
+                    'Content-Type': 'application/json',
+                },
+                timeout: 5000,
+            });
+            console.log('[Metrics] Metrics sent successfully');
+        }
+        catch (error) {
+            console.log(error);
+            console.error('[Metrics] Failed to send metrics:', axios_1.default.isAxiosError(error) ? error.message : error);
+        }
+    }
+}
+exports.HttpTransport = HttpTransport;
+//# sourceMappingURL=transport.js.map

package/dist/core/transport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transport.js","sourceRoot":"","sources":["../../src/core/transport.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAG1B,MAAa,aAAa;IACxB,YAA6B,SAAiB;QAAjB,cAAS,GAAT,SAAS,CAAQ;IAAG,CAAC;IAElD,KAAK,CAAC,IAAI,CAAC,OAAiB;QAC1B,IAAI,CAAC;YACH,MAAM,eAAK,CAAC,IAAI,CACd,IAAI,CAAC,SAAS,EACd,EAAE,OAAO,EAAE,EACX;gBACE,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,OAAO,EAAE,IAAI;aACd,CACF,CAAC;YACF,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC;QACrD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAEnB,OAAO,CAAC,KAAK,CACX,mCAAmC,EACnC,eAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAClD,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAzBD,sCAyBC"}

package/dist/core/types.d.ts

@@ -0,0 +1,36 @@
+export interface Metric {
+    route?: string;
+    method: string;
+    statusCode: number;
+    duration: number;
+    requestSize?: number;
+    responseSize?: number;
+    timestamp: string;
+    userAgent?: string;
+    ip?: string;
+    error?: string;
+    metadata?: Record<string, any>;
+    body?: any;
+    query?: any;
+    params?: any;
+    projectId: string;
+}
+export interface MetricsOptions {
+    ingestUrl: string;
+    projectId: string;
+    batchSize?: number;
+    flushIntervalMs?: number;
+    enabled?: boolean;
+    captureBody?: boolean;
+    captureQuery?: boolean;
+    captureParams?: boolean;
+    sensitiveKeysRegex?: RegExp;
+}
+export interface Route {
+    path: string;
+    method: string;
+    metadata?: Record<string, any>;
+}
+export interface Transport {
+    send(metrics: Metric[]): Promise<void>;
+}

package/dist/core/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/core/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/core/types.ts"],"names":[],"mappings":""}

package/dist/core/utils.d.ts

@@ -0,0 +1,7 @@
+import { Metric, MetricsOptions } from './types';
+export declare class MetricsExtractor {
+    private static readonly DEFAULT_SENSITIVE_REGEX;
+    static extract(options: MetricsOptions, req: any, res: any, duration: number, requestId?: string): Metric;
+    static calculateResponseSize(data: any): number;
+    private static redact;
+}

package/dist/core/utils.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetricsExtractor = void 0;
+class MetricsExtractor {
+    static extract(options, req, res, duration, requestId) {
+        var _a;
+        const method = req.method;
+        const url = req.url || req.originalUrl || req.path;
+        const ip = req.ip ||
+            ((_a = req.socket) === null || _a === void 0 ? void 0 : _a.remoteAddress) ||
+            (req.headers ? req.headers['x-forwarded-for'] : undefined);
+        const userAgent = req.headers ? req.headers['user-agent'] : undefined;
+        let statusCode = 200;
+        if (res.statusCode) {
+            statusCode = res.statusCode;
+        }
+        else if (res.raw && res.raw.statusCode) {
+            statusCode = res.raw.statusCode;
+        }
+        let requestSize = 0;
+        if (req.headers && req.headers['content-length']) {
+            requestSize = parseInt(req.headers['content-length'], 10);
+        }
+        let responseSize = 0;
+        const contentLength = res.getHeader
+            ? res.getHeader('content-length')
+            : res.headers
+                ? res.headers['content-length']
+                : null;
+        if (contentLength) {
+            responseSize = parseInt(contentLength, 10);
+        }
+        let route = undefined;
+        if (req.route && req.route.path) {
+            route = req.route.path;
+        }
+        else if (req.routeOptions && req.routeOptions.url) {
+            route = req.routeOptions.url;
+        }
+        else if (req.routerPath) {
+            route = req.routerPath;
+        }
+        const metric = {
+            route,
+            method,
+            statusCode,
+            duration,
+            requestSize,
+            responseSize,
+            timestamp: new Date().toISOString(),
+            userAgent,
+            ip,
+            projectId: options.projectId,
+        };
+        return metric;
+    }
+    static calculateResponseSize(data) {
+        if (!data)
+            return 0;
+        if (typeof data === 'string') {
+            return Buffer.byteLength(data);
+        }
+        if (Buffer.isBuffer(data)) {
+            return data.length;
+        }
+        try {
+            return Buffer.byteLength(JSON.stringify(data));
+        }
+        catch (e) {
+            return 0;
+        }
+    }
+    static redact(data, regex) {
+        if (!data)
+            return data;
+        if (typeof data !== 'object')
+            return data;
+        if (Array.isArray(data)) {
+            return data.map((item) => MetricsExtractor.redact(item, regex));
+        }
+        const redacted = {};
+        for (const key in data) {
+            if (Object.prototype.hasOwnProperty.call(data, key)) {
+                if (regex.test(key)) {
+                    redacted[key] = '*****';
+                }
+                else {
+                    redacted[key] = MetricsExtractor.redact(data[key], regex);
+                }
+            }
+        }
+        return redacted;
+    }
+}
+exports.MetricsExtractor = MetricsExtractor;
+MetricsExtractor.DEFAULT_SENSITIVE_REGEX = /pass(word|wd)?|secret|token|auth|api[._-]?key|credit[._-]?card|cvv|ccv|ssn/i;
+//# sourceMappingURL=utils.js.map

package/dist/core/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/core/utils.ts"],"names":[],"mappings":";;;AAGA,MAAa,gBAAgB;IAK3B,MAAM,CAAC,OAAO,CACZ,OAAuB,EACvB,GAAQ,EACR,GAAQ,EACR,QAAgB,EAChB,SAAkB;;QAKlB,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QAC1B,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,IAAI,CAAC;QACnD,MAAM,EAAE,GACN,GAAG,CAAC,EAAE;aACN,MAAA,GAAG,CAAC,MAAM,0CAAE,aAAa,CAAA;YACzB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAC7D,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAGtE,IAAI,UAAU,GAAG,GAAG,CAAC;QACrB,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;YACnB,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC;QAC9B,CAAC;aAAM,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC;YACzC,UAAU,GAAG,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC;QAClC,CAAC;QAGD,IAAI,WAAW,GAAG,CAAC,CAAC;QACpB,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACjD,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,EAAE,CAAC,CAAC;QAC5D,CAAC;QAGD,IAAI,YAAY,GAAG,CAAC,CAAC;QACrB,MAAM,aAAa,GAAG,GAAG,CAAC,SAAS;YACjC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,gBAAgB,CAAC;YACjC,CAAC,CAAC,GAAG,CAAC,OAAO;gBACX,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC;gBAC/B,CAAC,CAAC,IAAI,CAAC;QACX,IAAI,aAAa,EAAE,CAAC;YAClB,YAAY,GAAG,QAAQ,CAAC,aAAuB,EAAE,EAAE,CAAC,CAAC;QACvD,CAAC;QAGD,IAAI,KAAK,GAAG,SAAS,CAAC;QACtB,IAAI,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YAChC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;QACzB,CAAC;aAAM,IAAI,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;YACpD,KAAK,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC;QAC/B,CAAC;aAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;YAC1B,KAAK,GAAG,GAAG,CAAC,UAAU,CAAC;QACzB,CAAC;QAED,MAAM,MAAM,GAAW;YAGrB,KAAK;YACL,MAAM;YACN,UAAU;YACV,QAAQ;YACR,WAAW;YACX,YAAY;YACZ,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,SAAS;YACT,EAAE;YACF,SAAS,EAAE,OAAO,CAAC,SAAS;SAC7B,CAAC;QAiBF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,qBAAqB,CAAC,IAAS;QACpC,IAAI,CAAC,IAAI;YAAE,OAAO,CAAC,CAAC;QACpB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;QACD,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,CAAC;QACD,IAAI,CAAC;YACH,OAAO,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QACjD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,CAAC;QACX,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,MAAM,CAAC,IAAS,EAAE,KAAa;QAC5C,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC;QACvB,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC;QAC1C,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QAClE,CAAC;QAED,MAAM,QAAQ,GAAQ,EAAE,CAAC;QACzB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;gBACpD,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;oBACpB,QAAQ,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC;gBAC1B,CAAC;qBAAM,CAAC;oBACN,QAAQ,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;gBAC5D,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;;AA5HH,4CA6HC;AA3HyB,wCAAuB,GAC7C,6EAA6E,CAAC"}

package/dist/express/index.d.ts

@@ -0,0 +1 @@
+export * from './middleware';

package/dist/express/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./middleware"), exports);
+//# sourceMappingURL=index.js.map

package/dist/express/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/express/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B"}

package/dist/express/middleware.d.ts

@@ -0,0 +1,3 @@
+import { Request, Response, NextFunction } from 'express';
+import { MetricsOptions } from '../core/types';
+export declare const metricsMiddleware: (options: MetricsOptions) => (req: Request, res: Response, next: NextFunction) => void;

package/dist/express/middleware.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.metricsMiddleware = void 0;
+const collector_1 = require("../core/collector");
+const utils_1 = require("../core/utils");
+const uuid_1 = require("uuid");
+const metricsMiddleware = (options) => {
+    const collector = collector_1.MetricsCollector.initialize(options);
+    return (req, res, next) => {
+        if (options.enabled === false) {
+            return next();
+        }
+        const start = Date.now();
+        const requestId = (0, uuid_1.v4)();
+        req.requestId = requestId;
+        res.on('finish', () => {
+            const duration = Date.now() - start;
+            const metric = utils_1.MetricsExtractor.extract(options, req, res, duration, requestId);
+            collector.add(metric);
+        });
+        next();
+    };
+};
+exports.metricsMiddleware = metricsMiddleware;
+//# sourceMappingURL=middleware.js.map

package/dist/express/middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware.js","sourceRoot":"","sources":["../../src/express/middleware.ts"],"names":[],"mappings":";;;AACA,iDAAqD;AAErD,yCAAiD;AACjD,+BAAoC;AAE7B,MAAM,iBAAiB,GAAG,CAAC,OAAuB,EAAE,EAAE;IAC3D,MAAM,SAAS,GAAG,4BAAgB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAEvD,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;QACzD,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;YAC9B,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,MAAM,SAAS,GAAG,IAAA,SAAM,GAAE,CAAC;QAC1B,GAAW,CAAC,SAAS,GAAG,SAAS,CAAC;QAEnC,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;YACpB,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;YACpC,MAAM,MAAM,GAAG,wBAAgB,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;YAChF,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,IAAI,EAAE,CAAC;IACT,CAAC,CAAC;AACJ,CAAC,CAAC;AApBW,QAAA,iBAAiB,qBAoB5B"}

package/dist/fastify/index.d.ts

@@ -0,0 +1,3 @@
+import metricsPlugin from './plugin';
+export { metricsPlugin };
+export default metricsPlugin;

package/dist/fastify/index.js

@@ -0,0 +1,10 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.metricsPlugin = void 0;
+const plugin_1 = __importDefault(require("./plugin"));
+exports.metricsPlugin = plugin_1.default;
+exports.default = plugin_1.default;
+//# sourceMappingURL=index.js.map

package/dist/fastify/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/fastify/index.ts"],"names":[],"mappings":";;;;;;AAAA,sDAAqC;AAC5B,wBADF,gBAAa,CACE;AACtB,kBAAe,gBAAa,CAAC"}

package/dist/fastify/plugin.d.ts

@@ -0,0 +1,4 @@
+import { FastifyPluginAsync } from 'fastify';
+import { MetricsOptions } from '../core/types';
+declare const _default: FastifyPluginAsync<MetricsOptions>;
+export default _default;

package/dist/fastify/plugin.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fastify_plugin_1 = __importDefault(require("fastify-plugin"));
+const uuid_1 = require("uuid");
+const collector_1 = require("../core/collector");
+const utils_1 = require("../core/utils");
+const metricsPlugin = async (fastify, options) => {
+    const collector = collector_1.MetricsCollector.initialize(options);
+    if (options.enabled === false) {
+        return;
+    }
+    fastify.addHook('onRequest', async (req, reply) => {
+        req.metricsStartTime = Date.now();
+        if (!req.id) {
+            req.id = (0, uuid_1.v4)();
+        }
+    });
+    fastify.addHook('onResponse', async (req, reply) => {
+        const start = req.metricsStartTime || Date.now();
+        const duration = Date.now() - start;
+        const metric = utils_1.MetricsExtractor.extract(options, req, reply, duration, req.id);
+        collector.add(metric);
+    });
+};
+exports.default = (0, fastify_plugin_1.default)(metricsPlugin, {
+    name: 'metrics-plugin',
+});
+//# sourceMappingURL=plugin.js.map

package/dist/fastify/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/fastify/plugin.ts"],"names":[],"mappings":";;;;;AACA,oEAAgC;AAChC,+BAAoC;AACpC,iDAAqD;AAErD,yCAAiD;AAEjD,MAAM,aAAa,GAAuC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;IACnF,MAAM,SAAS,GAAG,4BAAgB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAEvD,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;QAC9B,OAAO;IACT,CAAC;IAID,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;QAC/C,GAAW,CAAC,gBAAgB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC3C,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,GAAG,CAAC,EAAE,GAAG,IAAA,SAAM,GAAE,CAAC;QACpB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;QACjD,MAAM,KAAK,GAAI,GAAW,CAAC,gBAAgB,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;QAC1D,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;QAMpC,MAAM,MAAM,GAAG,wBAAgB,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,CAAC,EAAY,CAAC,CAAC;QACzF,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,kBAAe,IAAA,wBAAE,EAAC,aAAa,EAAE;IAC/B,IAAI,EAAE,gBAAgB;CACvB,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './core/types';
+export * from './core/collector';