teletouch-observability 1.0.0

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "teletouch-observability",
+  "version": "1.0.0",
+  "description": "",
+  "main": "src/index.js",
+  "exports": {
+    ".": "./src/index.js"
+  },
+  "files": ["src"],
+  "type": "module",
+  "scripts": {
+    "test": "mocha"
+  },
+  "keywords": [
+    "observability",
+    "metrics",
+    "logs",
+    "prometheus"
+  ],
+  "author": "Rodrigo Ruiz <teparuiz>",
+  "license": "ISC",
+  "dependencies": {
+    "prom-client": "^15.1.3",
+    "winston": "^3.19.0"
+  },
+  "devDependencies": {
+    "chai": "^6.2.2",
+    "mocha": "^11.7.6",
+    "supertest": "^7.2.2"
+  }
+}

package/src/index.js

@@ -0,0 +1,4 @@
+export * from "./logger";
+export * from "./metrics";
+export * from "./middleware";
+export * from "./metricsServer";

package/src/logger.js

@@ -0,0 +1,91 @@
+import winston from 'winston';
+
+const logger = winston.createLogger({
+            level: "info",
+            format: winston.format.combine(
+                winston.format.timestamp({
+                    format: 'YYYY-MM-DD HH:mm:ss'
+                }),
+                winston.format.splat(),
+                winston.format.errors({ stack: true }),
+                winston.format.json()
+            ),
+            transports: [
+                new winston.transports.Console({
+                    stderrLevels: ["error", "warn"]
+                })
+            ]
+        })
+
+process.on('uncaughtException', (error) => {
+    logger.error({
+        source: 'process',
+        event: 'uncaughtException',
+        error: {
+            name: error?.name,
+            message: error?.message || String(error),
+            stack: error?.stack,
+        },
+    });
+    process.exit(1);
+})      
+
+process.on('unhandledRejection', (reason) => {
+    logger.error({
+        source: 'process',
+        event: 'unhandledRejection',
+        error: {
+            name: reason?.name,
+            message: reason?.message || String(reason),
+            stack: reason?.stack,
+        },
+    });
+});
+
+export function ErrorLog(source, error, requestId, req = null) {
+  logger.error({
+    requestId,
+    source,
+    event: 'error',
+    method: req?.method,
+    path: req?.path,
+    error: {
+      name: error?.name,
+      message: error?.message || String(error),
+      stack: error?.stack,
+    },
+  });
+}
+
+export function WarnLog(source, message, requestId, req = null) {
+  logger.warn({
+    requestId,
+    source,
+    event: 'warn',
+    method: req?.method,
+    path: req?.path,
+    message,
+  });
+}
+
+export function InfoLog(source, data, requestId, req = null) {
+  logger.info({
+    requestId,
+    source,
+    event: 'info',
+    method: req?.method,
+    path: req?.path,
+    data,
+  });
+}
+
+export function DebugLog(source, data, requestId, req = null) {
+  logger.debug({
+    requestId,
+    source,
+    event: 'debug',
+    method: req?.method,
+    path: req?.path,
+    data,
+  });
+}

package/src/metrics.js

@@ -0,0 +1,7 @@
+import client from "prom-client";
+
+export const register = new client.Registry();
+
+client.collectDefaultMetrics({ register });
+
+export const metrics = register.metrics;

package/src/metricsServer.js

@@ -0,0 +1,41 @@
+import http from "http";
+import { register } from "./metrics.js";
+
+export class MetricsServer {
+  constructor({ port = 9464, registry = register }) {
+    this.port = port;
+    this.registry = registry;
+    this.server = null;
+  }
+
+  start() {
+    this.server = http.createServer(async (req, res) => {
+        const url = new URL(req.url, `http://${req.headers.host}`);
+      if (url.pathname !== "/metrics") {
+        res.statusCode = 404;
+        return res.end("not found");
+      }
+
+      try {
+        res.setHeader(
+          "Content-Type",
+          this.registry.contentType
+        );
+
+        const metrics = await this.registry.metrics();
+        res.statusCode = 200;
+        res.end(metrics);
+      } catch (err) {
+        res.statusCode = 500;
+        res.end("error generating metrics");
+      }
+    });
+
+    this.server.listen(this.port);
+    return this.server;
+  }
+
+  stop() {
+    this.server?.close();
+  }
+}

package/src/middleware.js

@@ -0,0 +1,40 @@
+import { randomUUID } from 'crypto';
+
+
+export class HttpLogger {
+    constructor({logger}) {
+        this.logger = logger;
+    }
+
+    middleware() {
+        return (req, res, next) => {
+            const requestId = randomUUID();
+            req.requestId = requestId;
+
+            const start = process.hrtime.bigint();
+            const url = req.originalUrl || req.url;
+
+            this.logger.info("http_request_in", {
+                requestId,
+                method: req.method,
+                url,
+                body: req.body,
+                statusCode: res.statusCode,
+                source: 'http'
+            })
+
+            res.on('finish', () => {
+                this.logger.info("http_request_out", {
+                    requestId,
+                    method: req.method,
+                    url,
+                    source: 'http',
+                    statusCode: res.statusCode,
+                    duration: process.hrtime.bigint() - start
+                })
+            })
+
+            next();
+        }
+    }
+}