api-health-middleware 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,135 @@
+# health-monitor-middleware
+
+[![npm version](https://img.shields.io/npm/v/api-health-middleware)](https://www.npmjs.com/package/api-health-middleware)
+[![License](https://img.shields.io/npm/l/api-health-middleware)](LICENSE)
+[![Downloads](https://img.shields.io/npm/dt/api-health-middleware)](https://www.npmjs.com/package/api-health-middleware)
+
+A lightweight **Express middleware** to automatically monitor API health.  
+It tracks requests, responses, errors, response time, and uptime, sending logs to your dashboard (Under Development) using an API key.
+
+This package is plug-and-play — just install it, provide your API key, and it works out-of-the-box.
+
+---
+
+## Features
+
+- Automatic logging of all API requests
+- Tracks:
+  - Endpoint (`/api/users`, `/login`, etc.)
+  - HTTP method (GET, POST, PUT, DELETE)
+  - Status code (200, 404, 500, etc.)
+  - Response time in milliseconds
+  - Success / error messages
+  - IP address and User-Agent
+- Works with Express 4.x and above
+
+---
+
+## Installation
+
+```bash
+npm i api-health-middleware
+
+Usage
+1. Import and Initialize Middleware
+const express = require('express');
+const app = express();
+
+// Import health monitor middleware
+const healthMonitor = require('api-health-middleware');
+
+// Use middleware globally
+app.use(
+  healthMonitor({
+    apiKey: 'YOUR_DASHBOARD_API_KEY', // Required
+  })
+);
+
+app.get('/api/users', (req, res) => {
+  res.json({ message: 'Hello users' });
+});
+
+app.listen(3000, () => console.log('Server running on port 3000'));
+
+2. How It Works
+
+Middleware intercepts every request and response.
+
+Captures metrics: endpoint, method, status, response time, IP, User-Agent.
+
+Sends logs asynchronously to your monitoring dashboard using the API key.
+
+Your dashboard aggregates metrics per project, showing:
+
+Total API calls
+
+Error count
+
+Average response time
+
+Uptime percentage
+
+3. Middleware Configuration Options
+Option	Type	Required	Default	Description
+apiKey	string	✅ Yes	—	API key generated from your dashboard for authentication
+Example Log Object Sent to Dashboard
+{
+  "timestamp": "2026-02-11T16:24:00.123Z",
+  "method": "GET",
+  "endpoint": "/users",
+  "statusCode": 200,
+  "responseTimeMs": 123,
+  "success": true,
+  "errorMessage": null,
+  "ip": "192.168.0.1",
+  "userAgent": "PostmanRuntime/7.28.4",
+  "projectId": "623d2f6b9e1b0a0012345678"
+}
+
+Example Metrics from Dashboard
+
+Total API calls: 120
+
+Error count: 5
+
+Average response time: 135 ms
+
+Uptime: 95.83%
+
+Best Practices
+
+Async logging – middleware sends logs asynchronously to avoid blocking API responses.
+
+
+Use environments – differentiate production, staging, or development metrics.
+
+Batch logs – optionally batch logs to reduce network calls.
+
+Secure API key – never commit it publicly.
+
+Contributing
+
+We welcome contributions!
+
+Fork the repo
+
+Create a new branch (feature/my-feature)
+
+Run tests:
+
+npm test
+
+
+Submit a pull request
+
+License
+
+MIT © Your Name
+
+Acknowledgements
+
+Inspired by Postman Monitors and lightweight API monitoring systems.
+
+
+---
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-health-middleware",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Express middleware to report per-request API health to a monitoring backend",
   "main": "src/index.js",
   "scripts": {

package/src/middleware.js

@@ -1,7 +1,6 @@
 import axios from "axios";
 
-const INGEST_ENDPOINT = "https://devops-lite-backend.onrender.com/logs/health";
-
+const INGEST_ENDPOINT = "http://localhost:5000/logs/health";
 
 export function apiHealth({ apiKey }) {
   if (!apiKey) throw new Error("apiKey is required");
@@ -10,29 +9,43 @@ export function apiHealth({ apiKey }) {
     const start = process.hrtime.bigint();
 
     res.on("finish", () => {
-      const durationMs =
-        Number(process.hrtime.bigint() - start) / 1_000_000;
-
-       const payload = {
-        Method: req.method, 
-        api_End_Point: req.route?.path || req.path,
-        api_Status_Code: res.statusCode,
-        responseTime: durationMs,
-        api_Error: res.statusCode >= 400 ? "Error occurred" : null,
-        timestamp: Date.now()
-      };
-
-      axios
-        .post(INGEST_ENDPOINT, payload, {
+      try {
+        // Prevent self-logging
+        if (req.originalUrl.includes("/logs/health")) return;
+
+        const durationMs =
+          Number(process.hrtime.bigint() - start) / 1_000_000;
+
+        const payload = {
+          timestamp: new Date().toISOString(),
+          Method: req.method,
+          endpoint: req.route?.path || req.originalUrl,
+          fullUrl: req.originalUrl,
+          statusCode: res.statusCode,
+          responseTimeMs: Math.round(durationMs),
+          success: res.statusCode < 400,
+          errorMessage:
+            res.statusCode >= 400
+              ? res.statusMessage
+              : null,
+          ip: req.ip,
+          userAgent: req.headers["user-agent"] || null,
+        };
+
+        // Fire and forget (do not await)
+        axios.post(INGEST_ENDPOINT, payload, {
           headers: {
-            "x-api-key": `${apiKey}`,
-            "Content-Type": "application/json"
+            "x-api-key": apiKey,
+            "Content-Type": "application/json",
           },
-          timeout: 2000
-        })
-        .catch((err) => {
-          console.log(err);
+          timeout: 2000,
+        }).catch(() => {
+          // silently fail (monitoring should never break main API)
         });
+
+      } catch (err) {
+        // Never break main request
+      }
     });
 
     next();