The Logs

Stop using console.log and use this simple logs API at your daily proccess

[![NPM Version][npm-image]][npm-url]
[![NPM Downloads][downloads-image]][downloads-url]
[![Build][build-badge]][repository-url]

$3

This is a Node.js module available through the
npm registry.

Before installing, download and install Node.js.
Node.js 0.10 or higher is required.

If this is a brand new project, make sure to create a package.json first with
the npm init command.
Installation is done using the
npm install command:

``bash
$ npm install --save the-logs
`

$3

`ts
// First of all, you should create a instance of the logger
// This code goes before your application entry point

import { Logger, LogLevel } from 'the-logs';

Logger.buildLogger({
serviceName: 'service-name',
serviceVersion: '1.0.0',
logLevel: LogLevel.Debug,
environment: process.env.NODE_ENV,
useCase: 'My example',
});
`

`ts
// This code goes in any file of your project
// Creates your logger object

let logger = Logger.getLogger({ interUseCase: 'First logs wave' });
logger.debug('This is a debug log'); // [service-name@1.0.0][My example][First logs wave] - [Debug] This is a debug log
logger.info('This is an info log'); // [service-name@1.0.0][My example][First logs wave] - [Info] This is an info log
logger.error('This is an error log'); // [service-name@1.0.0][My example][First logs wave] - [Error] This is an error log

// Updates your logger with other log level
logger = Logger.getLogger({ logLevel: LogLevel.Error });
logger.debug('This is a debug log'); //
logger.info('This is an info log'); //
logger.error('This is an error log'); // [service-name@1.0.0][My example] - [Error] This is an error log

// Updates your logger with other log level and add an interUseCase
logger = Logger.getLogger({ interUseCase: 'Last logs wave', logLevel: LogLevel.Info });
logger.debug('This is a debug log'); //
logger.info('This is an info log'); // [service-name@1.0.0][My example][Last logs wave] - [Info] This is an info log
logger.error('This is an error log'); // [service-name@1.0.0][My example][Last logs wave] - [Error] This is an error log
``

$3

- [x] Log at console
- [x] Refactor and use Singleton pattern
- [x] Add multiple configs to track logs beetwen process
- [x] Log at .log file
- [ ] Create platform to display logs
- [ ] Create writer to be consumed by platform
- [ ] Create metrics using logs
- [ ] Create custom metrics
- [ ] Create notifications system

$3

| LogLevel | | Environment | | Platform | | Writers |
| -------- | --- | ----------- | --- | ---------- | --- | ------- |
| Debug | | Beta | | Container | | Console |
| Info | | Development | | Docker | | File |
| Notice | | Production | | Instance | | - |
| Warning | | Stable | | Lambda | | - |
| Error | | Staging | | Serverless | | - |
| Critical | | Test | | VM | | - |
| - | | Testing | | - | | - |

$3

##### Log levels below the configured level won't be logged

Critical > Error > Warning > Notice > Info > Debug

[npm-image]: https://img.shields.io/npm/v/the-logs
[npm-url]: https://npmjs.org/package/the-logs
[downloads-image]: https://img.shields.io/npm/dm/the-logs.svg
[downloads-url]: https://npmcharts.com/compare/the-logs?minimal=true
[build-badge]: https://github.com/zigante/the-logs/workflows/Compiler/badge.svg?branch=main
[repository-url]: https://github.com/zigante/the-logs#readme