logger-steps
Version:
Group log messages and send them in one batch to the logger of your choize
113 lines (74 loc) ā¢ 4.51 kB
Markdown
# logger-steps
[](https://www.npmjs.com/package/logger-steps)
[](https://travis-ci.org/danielo515/logger-steps)
[](https://david-dm.org/danielo515/logger-steps)
[](https://coveralls.io/github/danielo515/logger-steps)
[](https://gitmoji.carloscuesta.me/)
> Group log messages and send them grouped the logger of your choice
Log messages are useful, but they can be missleading if the order is not correct or if related messages
do not appear close to each other (which is quite common on asynchronous programming).
Grouping messages could be a pain and would force you to refactorize your code deeply.
This library fixes this situation by wrapping the logger of your choize and providing an interface that mimics the one
of the logger. Then you can use the returned API in the same way you are used to but messages will be grouped toghether.
### Usage
The most basic usage is as follows:
```js
import loggerSteps from 'logger-steps';
trace = loggerSteps(console /* Reporter */, 'AUTH-FLOW' /* Flow title */, 15 /* Automatic flush timeout */);
trace.info('Starting auth flow', user.email);
/* Do things here ...*/
trace.warn('Something failed, trying alternative...');
/* Do more things here */
trace.error('The flow failed totally',error.message)
/* Send all the messages in one go to the selected logger, in this case the console*/
trace.flush();
/* Console output...
AUTH-FLOW:
{ title: 'Starting auth flow', details: 'yo@yo.com' }
{ title: 'Something failed, trying alternative...' }
{ title: 'The flow failed totally', details: 'User does not exists' }
*/
```
### Installation
Install via [yarn](https://github.com/yarnpkg/yarn)
yarn add logger-steps (--dev)
or npm
npm install logger-steps (--save-dev)
### configuration
You can pass in extra options to configure the behavior of the tracer (ā required, ā optional, āļø default).
```js
import loggerSteps from 'logger-steps';
```
ā **logger** ( logger )
<br/> š The logger you want to report to
<br/> āļø currently it should implement the following methods: `error`, `warn`, `log`, `info`, `debug`
<br/> ā¹ļø info
<br/> š” example: console
ā **logger** ( String ) `āļø Steps`
<br/> š The title of the trace
<br/> ā¹ļø It will appear at the top of the output
<br/> š” example: 'AUTH-FLOW'
ā **logger** ( Number ) `āļø 30`
<br/> š Timeout before triggering an automatic flush
<br/> āļø Setting a big timeout could lead to higher memmory usage in case you forget to flush often
<br/> ā¹ļø info:
<br/> š” example: 15
### methods
#### #name
```js
loggerSteps
```
### Examples
See [`example`](example/script.js) folder or the [runkit](https://runkit.com/danielo515/logger-steps) example.
### Builds
If you don't use a package manager, you can [access `logger-steps` via unpkg (CDN)](https://unpkg.com/logger-steps/), download the source, or point your package manager to the url.
`logger-steps` is compiled as a collection of [CommonJS](http://webpack.github.io/docs/commonjs.html) modules & [ES2015 modules](http://www.2ality.com/2014/0
-9/es6-modules-final.html) for bundlers that support the `jsnext:main` or `module` field in package.json (Rollup, Webpack 2)
The `logger-steps` package includes precompiled production and development [UMD](https://github.com/umdjs/umd) builds in the [`dist` folder](https://unpkg.com/logger-steps/dist/). They can be used directly without a bundler and are thus compatible with many popular JavaScript module loaders and environments. You can drop a UMD build as a [`<script>` tag](https://unpkg.com/logger-steps) on your page. The UMD builds make `logger-steps` available as a `window.loggerSteps` global variable.
### License
The code is available under the [MIT](LICENSE) license.
### Contributing
We are open to contributions, see [CONTRIBUTING.md](CONTRIBUTING.md) for more info.
### Misc
This module was created using [generator-module-boilerplate](https://github.com/duivvv/generator-module-boilerplate).