- No dependencies
- Outstanding performance
- Support for
debug's filter - Browser compatible through
localStorage
npm add diaryimport { info, diary } from 'diary';
info('this important thing happened');
// ~> ℹ info this important thing happened
const scopedDiary = diary('my-module', (event) => {
if (event.level === 'error') {
Sentry.captureException(event.error);
}
});
scopedDiary.info('this other important thing happened');
// ~> ℹ info [my-module] this other important thing happenedControlling runtime emission of logs:
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 ✔// 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
import { diary, enable } from 'diary';
enable('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 ✔
enable('scopeA:*');
scopeA1.info('message'); // will log ✔
scopeA2.info('message'); // will log ✔
scopeB1.info('message'); // won't log ✗
scopeB2.info('message'); // won't log ✗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");
Type: string
The name given to this diary—and will also be available in all logEvents.
Type: Reporter
A reporter is run on every log message (provided its enabled). A reporter gets given the
LogEvent interface:
interface LogEvent {
name: string;
level: LogLevels;
message: string;
extra: unknown[];
}Errors (for error and fatal) there is also an error: Error property.
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 with theerrorproperty on the context, 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.
Type: Diary
The result of a calling diary;
Type: Function
Opts certain log messages into being output. See more here.
Validation
✔ @graphile/logger
✔ bunyan
✔ debug
✔ diary
✔ pino
✔ roarr
✔ ulog
✔ winston
Benchmark
@graphile/logger x 21,801,529 ops/sec ±0.88% (93 runs sampled)
bunyan x 109,073 ops/sec ±0.71% (94 runs sampled)
debug x 228,734 ops/sec ±1.28% (88 runs sampled)
diary x 6,962,434 ops/sec ±0.50% (93 runs sampled)
pino x 48,998 ops/sec ±0.93% (91 runs sampled)
roarr x 927,402 ops/sec ±0.64% (94 runs sampled)
ulog x 25,681 ops/sec ±27.59% (17 runs sampled)
winston x 12,314 ops/sec ±5.01% (83 runs sampled)
Ran with Node v16.2.0
MIT © Marais Rossouw
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent