A lightweight and simple logging library
inspired by jonnyreeves' work
$ npm install @isoss/logger.jsimport { Logger } from '@isoss/logger.js';
// or const { Logger } = require('@isoss/logger.js');
const logger = new Logger({
context: {
name: 'MyLogger'
}
});Note: a logger handles by default only fatal, error, warn and info levels. See Levels below.
import { Logger } from '@isoss/logger.js';
// or const { Logger } = require('@isoss/logger.js');
const logger = Logger.get('MyLogger');Note: The Logger.get method retrives a logger already instantiated or creates a new one.
A logger has 6 different levels of logging:
FATAL, ERROR, WARN, INFO, DEBUG, TRACE
Each of these logging levels has its own method on the logging interface.
logger.fatal('Whoops ! A fatal error occurs.');
// => [hh:mm:ss] [MyLogger] [Fatal] Whoops ! A fatal error occurs.
// [Program crash...]
logger.error('This is pretty embarassing...');
// => [hh:mm:ss] [MyLogger] [Error] This is pretty embarassing...
logger.warn('Something goes wrong but we can continue.');
// => [hh:mm:ss] [MyLogger] [Warn] Something goes wrong but we can continue.
logger.info('This is a neat info !');
// => [hh:mm:ss] [MyLogger] [Info] This is a neat info !
logger.debug('AAAAA');
// => [hh:mm:ss] [MyLogger] [Debug] AAAAA
logger.trace('Very verbose logging !');
// => [hh:mm:ss] [MyLogger] [Trace] Very verbose logging ! Logging levels are represented by a bitfield. Only FATAL, ERROR and INFO are enabled by default. A level which isn't enabled will not be handled by the logging handler (see Handler below).
import { Level } from '@isoss/logger.js';
// or const { Level } = require('@isoss/logger.js');As a level is represented by a flag in a bitfield, you can combine multiple levels easily using the bitwise operator |.
Level.FATAL | Level.ERROR | Level.INFO // FATAL, ERROR and INFO levelsUse Logger#enable to enable a logging level (or more).
logger.enable(Level.WARN); // Enables the WARN levelYou can check if a level is enabled using Logger#enabledFor
if(logger.enabledFor(Level.TRACE)) {
// Do something
}Use Logger#disable to enable a logging level (or more).
logger.disable(Level.DEBUG); // Disables the DEBUG levelAll log messages are routed through a handler functions which redirects them somewhere. You can configure it using Logge#setHandler. The supplied function expects three arguments; the first being the log messages, the second being the level key which represents the handled level (i.e. 'FATAL', 'ERROR', 'WARN', 'INFO', 'DEBUG', 'TRACE') and the third being the context (name and levels that the logger handles) to handle.
logger.setHandler((messages, level, context) => {
// Redirect messages somewhere
});logger.js provides a default logging handler which writes to the console object using the appropriate logging function (i.e. logger.info => console.info).
Use Logger.createDefaultHandler to return a new logging handler.
let handler = Logger.createDefaultHandler({
formatter: (messages, level, context) => {
// Prefix each log message by a timestamp
messages.unshift(new Date().toLocaleTimeString());
}
})A context object contains the logger's name and filter level (the levels which are enabled). You can get it using Logger#getContext and set it via Logger#setContext.
{
filterLevel: 0, // The bitfield representing the filter level
name: 'Logger' // The logger's name
}
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent