logger/README.md

Navy's logger

Simple logger I wrote to have a unified system for logging throughout my projects.

Features

Split into Master and Client for logging between processes, where master resides on the master process and the clients on the spawned processes.
Should be fairly trivial to modify it to work across nodes with websockets or some other IPC protocol.

Note
When logging from a child process, the master logger expects the child process to be be in a wrapper containing at the very least an ID property to work properly (used for identifying which child the message came from).
Notably the logger will work with just a raw child process object though, it will lack the identifier.

The child processes are expected to be attached with the attach() method found in the master logger. This will attatch a listener for the 'message' event.

Logger Options

{ 
    //////// SHARED BETWEEN CLIENT & MASTER
    guard: '_logger', // Message guard, e.g this property has to be true in the IPC message for the logger to read it
    loglevel: false, // On the master logger this determines whether the output is written to console (i.e. will always be written to file), on the client this determines whether it is sent to the master at all
    customTypes: [], // Log types, defaults are 'error', 'warn', 'info', 'debug', 'status'. Each one of these has an associated shorthand function, the custom ones will receive one too, e.g. adding 'access' to the custom types will add a logger.access() function
    logLevelMapping: {
        debug: 0,
        info: 1,
        status: 2,
        warn: 3,
        error: 4
    }
    
    /////// MASTER EXCLUSIVE
    customStreams: [], // File streams, by default there are streams for error and default
    customTypeMapping: {}, // This maps a type to a stream, e.g. adding "warn": "error" will pipe any warnings to the error log file
    customColours: {}, // Supports any colours chalk.js supports, e.g. "warn": "green" will turn warning outputs green
    fileRotationFreq: 1, // How frequently to roate files in days - will not work with anything less than 1 day currently
    directory: './logs', // Directory in which to write log files
    broadcastLevel: 4, // Level at which to broadcast to webhook if supplied
    webhook: {
        url: string
    }
}

Built-in log levels
0 - Debug
1 - Info
2 - Status
3 - Warning
4 - Error