- .github
- bench
- shots
- src
- test
- .editorconfig145 B
- .gitignore151 B
- example.ts541 B
- licence1.1 KB
- package.json1.9 KB
- readme.md5.9 KB
- rollup.config.js1.7 KB
- tsconfig.json425 B
readme.md
⚡ Features
- No dependencies
- Outstanding performance
- Support for
debug's filter - Browser compatible through
localStorage - Middleware to pipe into Sentry or alike
⚙️ Install
yarn add diary
🚀 Usage
import { info, diary, after } from 'diary';
after((logEvent) => {
if (logEvent.level === 'error') {
Sentry.captureException(logEvent.extra[0]);
}
});
info('this important thing happened');
// ~> ℹ info this important thing happened
const scopedDiary = diary('my-module');
scopedDiary.info('this other important thing happened');
// ~> ℹ info [my-module] this other important thing happened
Controlling runtime emission of logs:
browser
import { diary } from 'diary';
localStorage.setItem('DEBUG', 'scopeA:two,scopeB:*');
const scopeA1 = diary('scopeA:one');
const scopeA2 = diary('scopeA:two');
const scopeB1 = diary('scopeB:one');
const scopeB2 = diary('scopeB:two');
scopeA1.info('message'); // won't log ✗
scopeA2.info('message'); // will log ✔
scopeB1.info('message'); // will log ✔
scopeB2.info('message'); // will log ✔
node
// example.js
import { diary } from 'diary';
const scopeA1 = diary('scopeA:one');
const scopeA2 = diary('scopeA:two');
const scopeB1 = diary('scopeB:one');
const scopeB2 = diary('scopeB:two');
scopeA1.info('message'); // won't log ✗
scopeA2.info('message'); // will log ✔
scopeB1.info('message'); // will log ✔
scopeB2.info('message'); // will log ✔
$ DEBUG=scopeA:two,scopeB:* node example.js
🔎 API
diary(name: string)
Returns: log functions
A default diary is exported, accessible through simply importing any log function.
Example of default diary
import { info } from 'diary'; info("i'll be logged under the default diary");
name
Type: string
The name given to this diary, will appear in the middleware under the name
property as well as in console messages.
log functions
A set of functions that map to console.error, console.warn, console.debug,
console.info and console.info. Aptly named;
-
fatal(message: string|Error, ...extra: any[]) -
error(message: string|Error, ...extra: any[])If an
Errorinstance is sent, the error object will be accessible through the first item in theextra's array in a middleware. This is for bothfatalanderror. -
warn(message: string, ...extra: any[]) -
debug(message: string, ...extra: any[]) -
info(message: string, ...extra: any[]) -
log(message: string, ...extra: any[])
All extra parameters are simply spread onto the console function, so
node/browser's built-in formatters will format any objects etc.
{before,after}(callback: function, diary?: Diary)
Returns: Dispose
Middlewares are function handlers that run for every
log function. They allow for modifying the log event object,
or simply returning false to bailout. Executing in a forwards direction,
meaning middlewares will be run sequentially as they were defined.
When the return is called, it will remove the middleware from the diary instance.
handler
Type: Function
Which gets given a single argument of:
interface LogEvent {
name: string;
level: LogLevels;
message: string;
extra: unknown[];
}
Example
import { before, after, info } from 'diary';
before((logEvent) => {
logEvent.context = {
hello: 'world',
};
});
after((logEvent) => {
if (logEvent.level === 'error') {
fetch('/api/errors', {
method: 'POST',
body: JSON.stringify({
error: logEvent.extra[0],
context: logEvent.context,
}),
});
}
});
info('something informative');
This method isn't a Promise, so won't be awaited. It's a fire and forget kinda deal.
diary (optional)
Type: Diary
The result of a calling diary;
A middleware without the optional second parameter, will run for all diaries.
setLevel(level: LogLevel)
Returns: void
Sets the level form which log's will get output to the console.
level
Type: string
One of the log functions's name.
Example
import { setLevel, info } from 'diary';
setLevel('error');
info('something informative');
Note; this will also filter the events from all middlewares.
💨 Benchmark
Validation
✔ @graphile/logger
✔ bunyan
✔ debug
✔ diary
✔ pino
✔ roarr
✔ ulog
✔ winston
Benchmark
@graphile/logger x 21,464,898 ops/sec ±0.70% (91 runs sampled)
bunyan x 118,121 ops/sec ±0.75% (87 runs sampled)
debug x 231,880 ops/sec ±2.98% (88 runs sampled)
diary x 696,904 ops/sec ±4.16% (78 runs sampled)
pino x 49,684 ops/sec ±2.32% (89 runs sampled)
roarr x 1,102,717 ops/sec ±1.37% (90 runs sampled)
ulog x 23,496 ops/sec ±21.35% (20 runs sampled)
winston x 11,008 ops/sec ±11.58% (75 runs sampled)
Ran with Node v16.0.0
License
MIT © Marais Rossouw
