1.0.2 • Published 7 months ago
gcarde-logger v1.0.2
gcarde-logger
A simple, customizable logger for Node.js applications, including a middleware for Express.js.
Installation
npm install gcarde-logger
Usage
Logger
const { createLogger } = require('gcarde-logger');
// Configuration example
const logger = createLogger({
logLevels: { error: true, info: true, warn: true },
logFilePath: 'logs/app.log',
logToConsole: true,
logToFile: true
});
logger.info('12345', 'This is an informational message');
logger.warn('12345', 'This is a warning');
logger.error('12345', 'This is an error');
Middleware for Express.js
const express = require('express');
const { createLogger, createLoggingMiddleware } = require('gcarde-logger');
const logger = createLogger({
logLevels: { error: true, info: true, warn: true },
logFilePath: 'logs/app.log',
logToConsole: true,
logToFile: true
});
const app = express();
const loggingMiddleware = createLoggingMiddleware(logger);
// Use the middleware
app.use(loggingMiddleware);
app.get('/', (req, res) => {
res.send('Hello World!');
});
app.listen(3000, () => {
logger.info('SERVER', 'Server is running on port 3000');
});
API Reference
Logger Configuration
Option | Description | Default |
---|---|---|
logLevels | Log levels to enable (error , info , warn ). | { error: true, info: true, warn: true } |
logFilePath | Path to the log file. | logs/application.log |
logToConsole | Enable or disable logging to the console. | false |
logToFile | Enable or disable logging to a file. | true |
Middleware
- The middleware generates a unique transaction ID for each request and logs the request start and response completion time.