@auxilin/common-logger

Common Logger

Common logger is preconfigured console based logger. Currently based on winston.

Installation

npm i @auxilin/common-logger

Quick example

Create logger.js file in the root of your project:

const {
  format,
  createConsoleLogger,
} = require('@auxilin/common-logger');

module.exports = createConsoleLogger({
  logToFiles: true,
  logDir: __dirname,
  format: format.combine(
    format.splat(),
    format.simple(),
  ),
});

Options:

Available variables:

Name	Default	Description
logToFiles	false	If false then log to console, instead write logs to the files info.log, errors.log, exceptions.log.
logDir	resolve(appRoot.path, './logs')	Directory where to save log files.
level	info	Log only if info.level less than or equal to this level. Available levels: error, warn, info, verbose, debug, silly
format	format.combine(format.timestamp(), format.json())	Format of logs.

Expose logger as global object

Since logger is such a common thing, it make sense to expose it as global variable, so it simpler to use it across the project.

global.logger = require('./logger');

// In a place, where you need logger:
const logger = global.logger;

Change Log

This project adheres to Semantic Versioning. Every release is documented on the Github Releases page.

License

Node-mongo is released under the MIT License.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Contributors

Thanks goes to these wonderful people (emoji key):

Evgeny Zhivitsa 💻 📖 🤔

Andrew Orsich 👀

This project follows the all-contributors specification. Contributions of any kind welcome!