@content-dynamics/logger v1.0.6

Simple logging for Node.Js with lots of config options.

Contents

• Getting Started
• Advanced Config
• Dependencies
• License
• Author

Getting Started

To install easy-logger simply run npm install @content-dynamics/logger in your project.

To get started simply require and initalize the logger:

Logger = require('@content-dynamics/logger')()

The base logger has 4 base types:

Usage:

Logger.Log(message, { options })

Configuration

Examples:

Logger.Log("By default this won't be logged to console or to the logging file");

Logger.Log("This will ensure that the info is logged to console and to the logging file",{ important: true });

Logger.Log("This will add a debug stack to the logging message and write it to the logging file and console",{ important:true, debug: true });

Usage:

Logger.Info(message, { options })

Configuration

Examples:

Logger.Info("This will simply show as info in the log!");

Logger.Info("This will ensure that the info is logged to console",{ important: true });

Logger.Info("Thiswill add a debug stack to the warn message",{ debug: true });

Usage:

Logger.Warn(message, { options })

Configuration

Examples:

Logger.Warn("This will simply show as a warning in the log!");

Logger.Warn("This will ensure that the warning is logged to console",{ important: true });

Logger.Warn("This won't add a stack to the warn message",{ debug: false });

Usage:

Logger.Error(message, { options })

Configuration

Examples:

Logger.Error("This will simply show as an error in the log!");

Logger.Error("This will set the debug message level to 50",{ level: 50 });

Logger.Error("This won't add a stack to the logged message",{ debug: false });

Advanced Configuration

The Logger instance can be defined with other options to match your requirements.

Example

const Logger = require('easylogger')({
    logFile:'./logs/main.log',
    logLevel:0,
    cmode:'json'})

The constructor takes several options passed through an object as defined below:

Configuring dateFormat

The dateFormat option accepts a callback that takes the default "date-object" created by the helper function:

getDate()

The object returned from getDate() has the following properties:

Example callback

dateFormat  = ( { DAY, DATE, MONTH, YEAR, HOUR, MINUTE, SECOND } )=>{
    return `[ ${DAY.SHORT} | ${DATE}:${MONTH}:${YEAR} | ${HOUR}:${MINUTE}:${SECOND} ]`;
},

Configuring logFormat

Example callback

logFormat = ( { prefix, timestamp, level, info, debugMsg } )=>{
    return `\n${prefix} - ${timestamp} - [LEVEL: ${level}]\nInfo:\n${info}${ debugMsg ? `\nDebug:${ inspect(debugMsg)}\n`:`\n`}`
}

Configuring consoleFormat

Example callback

consoleFormat = ( { prefix, timestamp, level, info, debugMsg } )=>{
    
    const formatMap = (num)=>{
        if (num >= 15) return {
            'prefix':chalk.bold.red,
            'timestamp':chalk.bold.red,
            'level':chalk.bold.red,
            'info':chalk.bold.yellow,
            'debug':chalk.yellow,
        }
        if (num >= 10) return {
            'prefix':chalk.bold.yellow,
            'timestamp':chalk.bold.yellow,
            'level':chalk.bold.yellow,
            'info':chalk.bold.white,
            'debug':chalk.yellow,
        }
        if (num >= 5) return {
            'prefix':chalk.bold.green,
            'timestamp':chalk.bold.green,
            'level':chalk.bold.green,
            'info':chalk.white,
            'debug':chalk.yellow,
        }
        return {
            'prefix':chalk.bold.green,
            'timestamp':chalk.green,
            'level':chalk.green,
            'info':chalk.white,
            'debug':chalk.white,
        }
    }

    const formatFromLevel = ( num, type, message)=>{
        return formatMap(num)[type](message);
    }

    const prefixFormatted = `${formatFromLevel(level, 'prefix', prefix)}`
    const timestampFormatted = `${formatFromLevel(level, 'timestamp', timestamp)}`;
    const levelFormatted = `${formatFromLevel(level, 'level', `[Level: ${level}]`)}`;
    const messageFormatted = `${formatFromLevel(level, 'info', `\nInfo:\n${info}\n`)}`;
    const debugFormatted = `${formatFromLevel(level, 'debug', `${debugMsg ? `\nDebug: ${ inspect(debugMsg)}\n`:''}`)}`;
    
    return `${prefixFormatted} - ${timestampFormatted} ${levelFormatted}\n${messageFormatted}${debugFormatted}`;
}

Further Reading

Stack Trace

The stack tracing function used by the logger returns an object with the following properties

The Day object

The day object properties returned by getDate().DAY

The Timezone object

The timezone object properties returned by getDate().TIMEZONE

Dependencies

Used to make console logging fun!

Used to test that the logger is working correctly during development

Contributing

Contributions to the project are more than welcome! Please visit the contributions guide for more information. Feel free to check the issues page if you want to contribute to solving issues.

If you would like to request a new feature please follow the request guide: Request a new feature

Author

:man_technologist: Elliot Gibson

• GitHub: @elliotgibson
• Twitter: @egibson_glass
• Instagram: @egibson_glass

License

Copyright 2021 Elliot Gibson. This project is licensed with the MIT license.