http-system-logger 1.0.4 → 1.0.5

package/README.md

@@ -8,6 +8,7 @@ A lightweight and configurable logging library for Node.js applications, built w
 - HTTP request logging using `morgan`.
 - Customizable log levels and formats.
 - Supports structured JSON logs for better integration with log management systems.
+- Ability to ignore logs from specific routes.
 
 ## Installation
 
@@ -67,6 +68,18 @@ app.listen(3000, () => {
 });
 ```
 
+### Ignoring Specific Routes
+
+You can configure the logger to ignore specific routes by setting the `IGNORED_ROUTES` environment variable. Provide a comma-separated list of routes to ignore.
+
+#### Example:
+
+```bash
+export IGNORED_ROUTES=/api/health,/api/skip
+```
+
+In this example, requests to `/api/health` and `/api/skip` will not be logged.
+
 ### Environment Variables
 
 You can configure the logger using the following environment variables:
@@ -78,5 +91,6 @@ You can configure the logger using the following environment variables:
 | `LOG_MAX_FILES`    | `7d`          | Maximum number of log files to retain.          |
 | `LOG_FILE_NAME`    | `application` | Base name for log files.                        |
 | `SERVICE_NAME`     | `logger`      | Default service name included in log metadata.  |
+| `IGNORED_ROUTES`   | `/api/health` | Comma-separated list of routes to ignore.       |
 
 

package/dist/{morgan.config.js → src/morgan.config.js}

@@ -29,7 +29,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const morgan_1 = __importDefault(require("morgan"));
 const winston_config_1 = __importDefault(require("./winston.config"));
 const uuid = __importStar(require("uuid"));
+const ignoredRoutes = (process.env.IGNORED_ROUTES || '/api/health')
+    .split(',')
+    .map((route) => route.trim()); // Load ignored routes from environment variables
 const morganMiddleware = (0, morgan_1.default)(function (tokens, req, res) {
+    if (ignoredRoutes.includes(req.path)) {
+        return null; // Skip logging for ignored routes
+    }
     return JSON.stringify({
         method: tokens.method(req, res),
         url: tokens.url(req, res),
@@ -45,7 +51,9 @@ const morganMiddleware = (0, morgan_1.default)(function (tokens, req, res) {
     stream: {
         // Configure Morgan to use our custom logger with the http severity
         write: (message) => {
-            winston_config_1.default.http(message, { context: 'HttpContext' });
+            if (message) {
+                winston_config_1.default.http(message, { context: 'HttpContext' });
+            }
         },
     },
 });

package/dist/test/index.d.ts

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

package/dist/test/index.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const express_1 = __importDefault(require("express"));
+const src_1 = require("../src");
+const app = (0, express_1.default)();
+const logger = new src_1.Logger('TestApp');
+// Middleware to parse JSON requests
+app.use(express_1.default.json());
+// Use the HTTP logger middleware
+app.use(src_1.httpLogger);
+// Test route
+app.get('/api/test', (req, res) => {
+    logger.info('Test route accessed');
+    res.send('Test route is working!');
+});
+// Ignored route
+app.get('/api/health', (req, res) => {
+    res.send('Health check route');
+});
+// Start the server
+const PORT = 3000;
+app.listen(PORT, () => {
+    logger.info(`Test server is running on http://localhost:${PORT}`);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "http-system-logger",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "A lightweight and configurable logging library for Node.js applications, built with winston and morgan.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -8,7 +8,7 @@
     "dist"
   ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "npx ts-node test/index.ts",
     "build": "npx tsc",
     "prepare": "npm run build"
   },
@@ -35,7 +35,9 @@
     "@types/morgan": "^1.9.9",
     "@types/node": "^20.12.5",
     "@types/uuid": "^9.0.8",
-    "typescript": "^5.4.4"
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.4",
+    "express": "^4.18.2"
   },
   "dependencies": {
     "morgan": "^1.10.0",