monilog-sdk 1.0.0

package/README.md

@@ -0,0 +1,55 @@
+# Monilog SDK
+
+A simple Node.js SDK to monitor backend logs, save them to a file, and send Slack notifications for 400/500 errors.
+
+## Installation
+
+```bash
+npm install logger_sdk
+```
+
+## Features
+
+- **Monitor Logs**: Automatically captures request details (method, URL, status code, duration, IP).
+- **Log File Creation**: Appends all logs to a local file (defaults to `logs.txt`).
+- **Error Filtering**: Automatically filters for 400 and 500 status codes.
+- **Slack Notifications**: Sends alerts to a Slack channel via Webhook URL when errors occur.
+
+## Usage
+
+### Express Middleware
+
+```javascript
+import express from 'express';
+import { monitor } from 'logger_sdk';
+
+const app = express();
+
+app.use(monitor({
+  slackWebhookUrl: 'https://hooks.slack.com/services/YOUR/WEBHOOK/URL',
+  logFilePath: './my-logs.txt', // Optional: defaults to process.cwd()/logs.txt
+  monitorStatusCodes: [200, 201] // Optional: monitor specific status codes in addition to 4xx/5xx
+}));
+
+app.get('/', (req, res) => {
+  res.send('Hello World!');
+});
+
+app.listen(3000);
+```
+
+### Options
+
+| Option | Type | Description |
+| --- | --- | --- |
+| `slackWebhookUrl` | `string` | (Optional) Your Slack incoming webhook URL. |
+| `logFilePath` | `string` | (Optional) Path where logs will be saved. Defaults to `./logs.txt`. |
+| `monitorStatusCodes` | `number[]` | (Optional) Specific status codes to monitor in addition to 400s and 500s. |
+
+
+## Development
+
+1. Clone the repository.
+2. Install dependencies: `npm install`
+3. Build the project: `npm run build`
+4. Run the test app: `cd test-app && node app.js`

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { monitor } from './monitor.js';
+export { sendSlackNotification } from './slack.js';

package/dist/index.js

@@ -0,0 +1,2 @@
+export { monitor } from './monitor.js';
+export { sendSlackNotification } from './slack.js';

package/dist/monitor.d.ts

@@ -0,0 +1,7 @@
+interface MonitorOptions {
+    slackWebhookUrl?: string;
+    logFilePath?: string;
+    monitorStatusCodes?: number[];
+}
+export declare function monitor(options?: MonitorOptions): (req: any, res: any, next: any) => void;
+export {};

package/dist/monitor.js

@@ -0,0 +1,42 @@
+import fs from 'fs';
+import path from 'path';
+import { sendSlackNotification } from './slack.js';
+export function monitor(options = {}) {
+    const logFilePath = options.logFilePath || path.join(process.cwd(), 'logs.txt');
+    const slackWebhookUrl = options.slackWebhookUrl;
+    const monitorStatusCodes = options.monitorStatusCodes || [];
+    return (req, res, next) => {
+        const start = Date.now();
+        // Capture the original end function
+        const originalEnd = res.end;
+        res.end = function (chunk, encoding) {
+            const duration = Date.now() - start;
+            const logEntry = {
+                timestamp: new Date().toISOString(),
+                method: req.method,
+                url: req.originalUrl || req.url,
+                statusCode: res.statusCode,
+                duration: `${duration}ms`,
+                ip: req.ip || req.connection.remoteAddress,
+            };
+            const logString = JSON.stringify(logEntry) + '\n';
+            //  Create/Append to logs file
+            fs.appendFileSync(logFilePath, logString);
+            //  Check for 400s, 500s or specific status codes
+            const isError = res.statusCode >= 400 && res.statusCode < 600;
+            const isMonitored = monitorStatusCodes.includes(res.statusCode);
+            if (isError || isMonitored) {
+                // Send notification to Slack
+                if (slackWebhookUrl) {
+                    sendSlackNotification(slackWebhookUrl, {
+                        title: `Monitor Alert: ${res.statusCode}`,
+                        ...logEntry
+                    });
+                }
+            }
+            // Call the original end function
+            originalEnd.apply(res, arguments);
+        };
+        next();
+    };
+}

package/dist/slack.d.ts

@@ -0,0 +1 @@
+export declare function sendSlackNotification(webhookUrl: string, message: any): Promise<void>;

package/dist/slack.js

@@ -0,0 +1,11 @@
+import axios from 'axios';
+export async function sendSlackNotification(webhookUrl, message) {
+    try {
+        await axios.post(webhookUrl, {
+            text: JSON.stringify(message, null, 2),
+        });
+    }
+    catch (error) {
+        console.error('Failed to send Slack notification:', error);
+    }
+}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "monilog-sdk",
+  "version": "1.0.0",
+  "type": "module",
+  "description": "A middleware-based logger SDK for Node.js backend applications to monitor logs and send Slack alerts.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "logger",
+    "sdk",
+    "monitoring",
+    "slack",
+    "express-middleware",
+    "error-alerting"
+  ],
+  "author": "Nikhil Dhaliya",
+  "license": "ISC",
+  "dependencies": {
+    "axios": "^1.8.1"
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.9",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.2"
+  }
+}