Introduction to Entity API Logger

The Entity API Logger is a comprehensive tool designed to streamline API logging within your application. It provides an extensive array of API functionalities to improve your application’s monitoring and debugging processes. In this document, we will explore various APIs of Entity API Logger with code snippets and an example application that utilizes these APIs for effective logging.

1. Initialization and Configuration

Before using the Entity API Logger, you need to initialize and configure it. Here is a basic setup:

 const { EntityAPILogger } = require('entity-api-logger');
const config = {
  level: 'info',
  filePath: '/var/log/api-logs',
  maxSize: '10m'
};
const logger = new EntityAPILogger(config); 

2. Basic Logging

Log different levels of messages:

 logger.info('This is an info message'); logger.warn('This is a warning message'); logger.error('This is an error message'); 

3. Log Request and Response

Automatically log request and response data for your APIs:

 const express = require('express'); const app = express();
app.use((req, res, next) => {
  logger.logRequest(req);
  res.on('finish', () => {
    logger.logResponse(res);
  });
  next();
}); 

4. Logging with Metadata

Include additional metadata in your logs:

 const metadata = {
  requestId: '12345',
  sessionId: 'abcde'
};
logger.info('User login successful', metadata); 

5. Logging Errors with Stack Trace

Log detailed error messages along with stack traces:

 try {
  throw new Error('Something went wrong');
} catch (err) {
  logger.error('Caught an exception', { stack: err.stack });
} 

6. Log Rotation

Automatically rotate log files to prevent them from growing too large:

 const rotatedLogger = new EntityAPILogger({
  ...config,
  rotation: {
    interval: '1d',
    maxFiles: '14d'
  }
}); 

7. Log Formatting

Customize the format of your log messages:

 const formattedLogger = new EntityAPILogger({
  ...config,
  format: '{timestamp} - {level}: {message}'
}); 

8. Integration with other services

Integrate Entity API Logger with logging services like Logstash:

 const logstashTransport = new LogstashTransport({
  host: 'localhost',
  port: 5000
});
logger.addTransport(logstashTransport); 

Example Application

Here is a complete example of an Express application that utilizes the Entity API Logger for effective API logging:

 const express = require('express'); const { EntityAPILogger } = require('entity-api-logger');
const app = express(); const logger = new EntityAPILogger({
  level: 'info',
  filePath: 'logs/api.log'
});
app.use((req, res, next) => {
  logger.logRequest(req);
  res.on('finish', () => {
    logger.logResponse(res);
  });
  next();
});
app.get('/', (req, res) => {
  res.send('Hello, world!');
  logger.info('Root endpoint accessed');
});
app.listen(3000, () => {
  logger.info('Server is listening on port 3000');
}); 

By following this setup, you will significantly improve the logging and monitoring capabilities of your application using Entity API Logger.

Hash: 4edcf3f3585303b023fde1bfd454d20f38675a96bba981d904a6331d16d9c118