Log Message CLS Hooked

A LogRoot Method Decorator that uses cls-hooked to handle and propagate log message details between different methods deeper in the callstack, removing the need to propagate a paremeter just for logging purposes.

Inspired by Typeorm Transactional CLS Hooked

Installation

npm install logmessage-cls-hooked --save
yarn add logmessage-cls-hooked

Initialization

In order to use it, you will first need to initialize the cls-hooked namespace before your application is started

1import { initLogMessageCls } from 'logmessage-cls-hooked';
2
3initLogMessageCls() // Initialize cls-hooked
4//...
5app = express()
6//...

Log Root

A Log root is a context that will receive log properties from all the subsequent methods that are called below it.

Imagine the following scenario:

1import { getLogData, LogRoot, setOnLog } from "logmessage-cls-hooked";
2
3class SomeClass {
4
5    @LogRoot()
6    sayHi() {
7        setOnLog('action', 'hi')
8        const language = this.getLanguage()
9        getLogData() // action=hi, lang=japanese
10    }
11
12    private getLanguage() {
13        setOnLog('lang', 'japanese')
14        getLogData() // action=hi, lang=japanese
15        return 'japanese'
16    }
17
18}

If you want to create a new context to add properties without making a mess in the parent context, just add a new LogRoot like that:

1import { getLogData, LogRoot, setOnLog } from "logmessage-cls-hooked";
2
3class SomeClass {
4
5    @LogRoot()
6    sayHi() {
7        setOnLog('action', 'hi')
8        const language = this.getLanguage()
9        getLogData() // action=hi
10    }
11
12    @LogRoot()
13    private getLanguage() {
14        setOnLog('lang', 'japanese')
15        getLogData() // action=hi, lang=japanese
16        return 'japanese'
17    }
18
19}