http-system-logger 1.0.3 → 1.0.5

package/README.md

@@ -0,0 +1,96 @@
+# HTTP System Logger
+
+A lightweight and configurable logging library for Node.js applications, built with `winston` and `morgan`.
+
+## Features
+
+- Console and file-based logging with daily rotation.
+- 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
+
+Install the library and its dependencies:
+
+```bash
+npm install http-system-logger
+```
+
+## Usage
+
+### Logger Class
+
+The `Logger` class provides methods for logging messages at different levels (`info`, `error`, `warn`, `debug`).
+
+#### Example:
+
+```typescript
+import { Logger } from 'http-system-logger';
+
+const logger = new Logger('MyAppContext');
+
+// Log an informational message
+logger.info('This is an info message');
+
+// Log an error with a stack trace
+logger.error('An error occurred', 'Error stack trace');
+
+// Log a warning
+logger.warn('This is a warning');
+
+// Log a debug message
+logger.debug('Debugging details');
+```
+
+### HTTP Request Logging
+
+The library includes a `httpLogger` middleware for logging HTTP requests in Express applications.
+
+#### Example:
+
+```typescript
+import express from 'express';
+import { httpLogger } from 'http-system-logger';
+
+const app = express();
+
+// Use the HTTP logger middleware
+app.use(httpLogger);
+
+app.get('/', (req, res) => {
+  res.send('Hello, world!');
+});
+
+app.listen(3000, () => {
+  console.log('Server is running on port 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:
+
+| Variable           | Default Value | Description                                      |
+|--------------------|---------------|--------------------------------------------------|
+| `LOG_DIR`          | `logs`        | Directory where log files are stored.           |
+| `LOG_MAX_SIZE`     | `4m`          | Maximum size of a log file before rotation.     |
+| `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,35 +1,49 @@
-{
-  "name": "http-system-logger",
-  "version": "1.0.3",
-  "description": "",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "npx tsc"
-  },
-  "keywords": [
-    "node-logger",
-    "logger",
-    "http-logger"
-  ],
-  "author": "erik",
-  "license": "ISC",
-  "devDependencies": {
-    "@types/express": "^4.17.21",
-    "@types/morgan": "^1.9.9",
-    "@types/node": "^20.12.5",
-    "@types/uuid": "^9.0.8",
-    "typescript": "^5.4.4"
-  },
-  "dependencies": {
-    "morgan": "^1.10.0",
-    "uuid": "^9.0.1",
-    "winston": "^3.13.0",
-    "winston-daily-rotate-file": "^5.0.0",
-    "winston-transport": "^4.7.0"
-  }
-}
+{
+  "name": "http-system-logger",
+  "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",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "test": "npx ts-node test/index.ts",
+    "build": "npx tsc",
+    "prepare": "npm run build"
+  },
+  "keywords": [
+    "node-logger",
+    "logger",
+    "http-logger",
+    "winston",
+    "morgan",
+    "typescript"
+  ],
+  "author": "erik",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/buicuong1303/http-system-logger.git"
+  },
+  "bugs": {
+    "url": "https://github.com/buicuong1303/http-system-logger/issues"
+  },
+  "homepage": "https://github.com/buicuong1303/http-system-logger#README",
+  "devDependencies": {
+    "@types/express": "^4.17.21",
+    "@types/morgan": "^1.9.9",
+    "@types/node": "^20.12.5",
+    "@types/uuid": "^9.0.8",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.4",
+    "express": "^4.18.2"
+  },
+  "dependencies": {
+    "morgan": "^1.10.0",
+    "uuid": "^9.0.1",
+    "winston": "^3.13.0",
+    "winston-daily-rotate-file": "^5.0.0",
+    "winston-transport": "^4.7.0"
+  }
+}