76 lines
3.3 KiB
Markdown
76 lines
3.3 KiB
Markdown
# logcontext
|
|
enrich logs with context
|
|
|
|
## Availabililty
|
|
[](https://www.npmjs.com/package/logcontext)
|
|
[](https://GitLab.com/pushrocks/logcontext)
|
|
[](https://github.com/pushrocks/logcontext)
|
|
[](https://pushrocks.gitlab.io/logcontext/)
|
|
|
|
## Status for master
|
|
[](https://GitLab.com/pushrocks/logcontext/commits/master)
|
|
[](https://GitLab.com/pushrocks/logcontext/commits/master)
|
|
[](https://www.npmjs.com/package/logcontext)
|
|
[](https://david-dm.org/pushrocks/logcontext)
|
|
[](https://www.bithound.io/github/pushrocks/logcontext/master/dependencies/npm)
|
|
[](https://www.bithound.io/github/pushrocks/logcontext)
|
|
[](https://snyk.io/test/npm/logcontext)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](http://standardjs.com/)
|
|
|
|
## Usage
|
|
Use TypeScript for best in class instellisense.
|
|
|
|
the logconext module exposes an easy to use syntax for nodejs style async logcontexts.
|
|
|
|
```typescript
|
|
let testLogger = new logcontext.Logger('testNamespace');
|
|
|
|
testLogger.scope(async () => {
|
|
testLogger.addData('id1', {
|
|
someData: 'someValue'
|
|
});
|
|
testLogger.log('hi');
|
|
testLogger.error(new Error('custom error message'));
|
|
setTimeout(() => {
|
|
outsideFunction(); // log scope will travel through callbacks and promises
|
|
}, 2000);
|
|
});
|
|
|
|
let outsideFunction = () => {
|
|
// Note:
|
|
// the below testLogger reference will have different contexts
|
|
// depending from which scope "outsideFunction" was called".
|
|
testLogger.log('some message');
|
|
};
|
|
```
|
|
|
|
## class Logger
|
|
|
|
```typescript
|
|
import { Logger } from 'logcontext';
|
|
|
|
// instantiate new Logger
|
|
// argument optional, if left empty auto generated shortid will be used
|
|
let myLogger = new Logger('myNamespace');
|
|
|
|
// create a scope
|
|
myLogger.scope(async () => {
|
|
// everything that is appended to the call stack from inside here will have all appended context data available
|
|
|
|
// add some scoped context information
|
|
myLogger.addData('customerId', '12345678');
|
|
|
|
// will log something with priviously appended context of this scope in place
|
|
myLoger.log('awesomeText');
|
|
});
|
|
```
|
|
|
|
For further information read the linked docs at the top of this README.
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
|
|
[](https://push.rocks)
|