@wictlab/error-catch

@wictlab/error-catch provides robust and customizable logging middleware for Express.js applications, designed to streamline the process of capturing request, response, and error logs, and dispatching them to a centralized logging API. This package helps developers monitor their applications effectively and debug issues with ease.

Features

• Request/Response Logging: Automatically logs details for every incoming HTTP request and outgoing response.
• Error Logging: Catches and logs errors that occur within your Express application, providing crucial debugging information.
• Centralized Logging: Easily send all logs to a specified external logging API endpoint.
• Service Identification: Tag logs with a serviceName to distinguish logs from different microservices or applications.
• Customizable: Configure logging behavior to fit your application's needs.

Installation

Install the package using npm:

npm install @wictlab/error-catch

Usage

Integrate @wictlab/error-catch into your Express application to start logging.

Basic Setup

First, import the middleware functions:

const express = require('express');
const { loggerMiddleware, errorLoggerMiddleware } = require('@wictlab/error-catch');

const app = express();

// Enable JSON body parsing
app.use(express.json());

// Configure and use the request/response logger middleware
app.use(loggerMiddleware({
  logApiUrl: 'http://localhost:3000/log', // Your centralized logging API endpoint
  serviceName: 'my-express-app',         // A name to identify this service in your logs
}));

// Example route
app.get('/', (req, res) => {
  res.status(200).send('Hello World! Check your logs.');
});

// Example route that throws an error
app.get('/error', (req, res, next) => {
  next(new Error('This is a test error!'));
});

// Configure and use the error logger middleware
// IMPORTANT: This middleware should be placed AFTER all other routes and middleware
// to ensure it catches errors from them.
app.use(errorLoggerMiddleware({
  logApiUrl: 'http://localhost:3000/log', // Your centralized logging API endpoint
}));

const PORT = 3000;
app.listen(PORT, () => {
  console.log(`Server listening on port ${PORT}`);
});

loggerMiddleware(options)

This middleware logs details about incoming requests and outgoing responses.

Options:

• logApiUrl (String, required): The URL of your centralized logging API endpoint where request/response logs will be sent.
• serviceName (String, required): A unique identifier for your service, which will be included in the logs.

errorLoggerMiddleware(options)

This middleware catches and logs errors that occur within your Express application. It should always be the last middleware added to your Express app.

Options:

• logApiUrl (String, required): The URL of your centralized logging API endpoint where error logs will be sent.
• serviceName (String, optional): A unique identifier for your service. If not provided, it attempts to infer it from loggerMiddleware's configuration or defaults to 'unknown-service'. It's recommended to explicitly provide it for clarity.

Contributing

We welcome contributions! Please feel free to submit issues or pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.