https://github.com/dissfall/winston-microlog
Log manager provides simple and clear logging system that in convenient to use for microservices. Uses winston
https://github.com/dissfall/winston-microlog
Last synced: 2 months ago
JSON representation
Log manager provides simple and clear logging system that in convenient to use for microservices. Uses winston
- Host: GitHub
- URL: https://github.com/dissfall/winston-microlog
- Owner: Dissfall
- License: mit
- Created: 2019-07-27T08:23:40.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-05-11T00:27:45.000Z (about 5 years ago)
- Last Synced: 2025-02-28T06:26:21.062Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://dissfall.github.io/winston-microlog/
- Size: 200 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# winston-microlog
Log manager provides simple and clear logging sysmem convenient to use for microservices.
[](https://nodei.co/npm/winston-microlog/)
[](https://npmcharts.com/compare/winston-microlog?minimal=true)
[](https://github.com/Dissfall/winston-microlog/commits/master)
[](https://github.com/prettier/prettier)
[](https://ko-fi.com/N4N510AEO)
[](https://www.patreon.com/join/dissfall?)
## Motivation
`winston-microlog` was developed in order to provide a way to keep logs from different sources (and parts of sources) in the most convenient and clear way. First of all, the project was created for microservices, where logs from different services are collected in one thread. Thus, the largest unit of logging is services. Services can include instances, which can be different functional parts of the service or just different files.
```
Unit A1 Unit A2 Unit B1 Unit B2
| | | |
| | | |
| | | |
+--v--------v--+ +--v--------v--+
| | | |
| Service A | | Service B |
| | | |
+------+-------+ +------+-------+
| |
| |
| |
+---> Logfile <---+
```
## Useful resources
* [API documentation](https://dissfall.github.io/winston-microlog/)
* [winston repository](https://github.com/winstonjs/winston)
## Usage
To start logging you need to initialize logger for every service and then for every instance.
Example for one service:
logger.js
``` js
const LogManager = require("winston-microlog")["default"];
const logManager = new LogManager('Service');
exports["default"] = logManager;
```
db_connect.js
``` js
const logManager = require('./logger')['default'];
const logger = logManager.getLogger('db-con');
logger.info('Connecting to database...');
let db = [{'data': 'data'}];
logger.info('Database succesfully connected!');
exports['default'] = db;
```
index.js
``` js
const logManager = require('./logger')['default'];
const db = require('./db_connect')['default'];
const logger = logManager.getLogger('Main');
logger.info('Service started');
logger.err('Test error');
logger.warn('Test warning');
```
To start `node index.js`
Result:
```
@SERVICE #DB-CON [10:52] ℹ| Connecting to database...
@SERVICE #DB-CON [10:52] ℹ| Database succesfully connected!
@SERVICE #MAIN [10:52] ℹ| Service started
@SERVICE #MAIN [10:52] ⛔| Test error
@SERVICE #MAIN [10:52] ⚠️| Test warning
```
## Importants
### Execution context
Note that if you want to pass logger in another module (function, class etc.) execution context wheel be changed and you need to pass logger with their context:
``` js
functionUsesLogger(logger.log.bind(logger));
```
### Using with container manager (like docker-compose)
Recomendet way to use winston-logger with managers like docker-compose is hide service name (because it already provided) with [showService](https://dissfall.github.io/winston-microlog/interfaces/lmconfig.html#showservice)
``` js
const logManager = new LogManager('Service', undefined, { showService: false });
```