Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/natura-cosmeticos/clio-nodejs-logger

A logger with context per request
https://github.com/natura-cosmeticos/clio-nodejs-logger

nodejs

Last synced: about 5 hours ago
JSON representation

A logger with context per request

Awesome Lists containing this project

README 

        
[![Known Vulnerabilities](https://snyk.io/test/github/natura-cosmeticos/clio-nodejs-logger/badge.svg?targetFile=package.json)](https://snyk.io/test/github/natura-cosmeticos/clio-nodejs-logger?targetFile=package.json)

[![Build Status](https://travis-ci.org/natura-cosmeticos/clio-nodejs-logger.svg?branch=master)](https://travis-ci.org/natura-cosmeticos/clio-nodejs-logger)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/8426d68f7eac481c9f3ae07b8eb1805b)](https://www.codacy.com/app/handrus_1938/clio-nodejs-logger?utm_source=github.com&utm_medium=referral&utm_content=natura-cosmeticos/clio-nodejs-logger&utm_campaign=Badge_Grade)



# Clio Node.js Logger



## What For



This module offers a logger with context per request. So it's supporting correlation id, session id, etc in any point of your application. You just need create a `domain` and `Logger.current`.



## How to use



Install the package on your project using either npm or yarn:



```bash

npm i '@naturacosmeticos/clio-nodejs-logger'



yarn add '@naturacosmeticos/clio-nodejs-logger'

```



Example:



```js

const domain = require('domain');

const Logger = require('@naturacosmeticos/clio-nodejs-logger');



const currentDomain = domain.create();

const context = { correlationId: '39c74d4d-50a9-4ccb-8c7d-ac413564f4a1' };



currentDomain.logger = new Logger({ context, logPatterns: '*' });



function myAwesomeAppEntryPoint() {

  Logger.current().log('Awesome app running with execution context!');



  new Logger({ logPatterns: '*' }).log('Awesome app running without execution context!');

}



currentDomain.run(myAwesomeAppEntryPoint);

```



By default all log namespaces are disabled. To enable them you must pass the

`LOG_NAMESPACES` environment variable with the logging patterns you want to show.



If you need to filter your logs by level you can either use `LOG_LEVEL` environment variable or pass the option into

its contructor when instantiating `new Logger({ ...options, logLevel: 'info' })`.



This variable follows the same semantics as the

[debug](http://npmjs.com/package/debug) library on npm.



By default the log object will be truncated* when it exceed 7kb and the log level is not debug. If you need to increase this limit, you can set environment variable `LOG_LIMIT` with the value in bytes (i.e.: 10000 = 10kb) or pass the limit in the Logger constructor: `new Logger({ ...options, logLimit: 10000 });`



_* when the log object is truncated only the following attributes are logged: `context`, `level`, `message` and `timestamp`._



Available `options` and details of how use this lib can be found in the docs, that can be generated running `npm run docs` or `yarn docs`.



## Features



Clio has the basic features of a logger library:



  * log levels: you can use `debug`, `error`, `log` and `warn` levels

  * namespaces: with namespaces you can control which namespaces should be logged using the same semantics as the

[debug](http://npmjs.com/package/debug)



Beyond those common log features Clio has additional features:



  * Context per request: you can use [`domain`](https://nodejs.org/api/domain.html) and then `Logger.current` to use the same logger instance inside in your application. So we can have the same context and additional information in your log as: ` correlationId` and `sessionId` (see an example in [execution-context](https://github.com/natura-cosmeticos/clio-nodejs-logger/blob/master/samples/execution-context.js))

  * Limit your log event size: when the log level is not debug the log object will have size limit of 7kb (you can increase passing a new limit in the logger constructor). This limit exists to avoid problems during log parsing and avoid usage of unnecessary resources (i.e.: when developer forgets log call during debugging).



## Docs



Check out [Wiki](https://github.com/natura-cosmeticos/clio-nodejs-logger/wiki)



## Samples



Take a loot at the [samples](https://github.com/natura-cosmeticos/clio-nodejs-logger/tree/master/samples) folder for examples of usage.



## How to contribute



You can contribute submitting [pull requests](https://github.com/natura-cosmeticos/clio-nodejs-logger/pulls).



### Setup



Run `yarn`.



### Testing



Just run `yarn test`.



### Lint



To verify if any lint rule was broken run: `yarn lint`.