Welcome to the Comprehensive Guide on `dump-logger`

Discover the power and versatility of the `dump-logger` library with this guide. Here, we will provide an introduction to `dump-logger` along with dozens of useful API explanations and code snippets. By the end of this article, you should have a solid understanding of how to effectively use `dump-logger` in your applications.

Introduction

`dump-logger` is a cutting-edge logging library designed to offer extensive logging functionalities along with efficient performance. It is suitable for both small apps and large-scale enterprise applications.

Core API Examples

1. Basic Initialization

const DumpLogger = require('dump-logger');
const logger = new DumpLogger(); 

2. Setting Log Levels

logger.setLevel('debug'); // Available levels: 'error', 'warn', 'info', 'debug'

3. Writing Log Messages

logger.info('This is an info log message.');
logger.error('This is an error log message.');
logger.debug('This is a debug log message.');

4. Adding Custom Metadata

logger.info('User logged in', { userId: 'abc123' });

5. Rotating Log Files

logger.enableFileRotation({ 
  frequency: 'daily', 
  maxSize: '20m', 
  maxFiles: '14d' 
});

6. Using Transport Mechanisms

logger.addTransport(new DumpLogger.transports.File({ filename: 'app.log' }));
logger.addTransport(new DumpLogger.transports.Console());

7. Asynchronous Logging

logger.infoAsync('This is an asynchronous info log message').then(() => {
  console.log('Log message was written successfully.');
}).catch(err => {
  console.error('Failed to write log message:', err);
});

8. Logging HTTP Requests

const express = require('express');
const app = express();
app.use(logger.expressMiddleware());

9. Dynamically Changing Log Levels

logger.changeLevel('warn'); // Changing log level to 'warn'

Example Application

Below is an example application implementing some of the `dump-logger` features:

const DumpLogger = require('dump-logger');
const express = require('express');
const app = express();

const logger = new DumpLogger();
logger.setLevel('info');
logger.addTransport(new DumpLogger.transports.Console());
logger.enableFileRotation({
  frequency: 'daily', 
  maxSize: '20m', 
  maxFiles: '14d'
});

app.use(logger.expressMiddleware());

app.get('/', (req, res) => {
  logger.info('Home page accessed');
  res.send('Hello, this is the home page.');
});

app.listen(3000, () => {
  logger.info('Server is running on port 3000');
});

By following this guide, you will be able to integrate `dump-logger` seamlessly into your applications, enhancing the robustness and clarity of your logging system.

Hash: 05a20d0f4671ed88525fcc6240272c308cd4b565a687dc6d22962e6f5b65f559