the-logs
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.2 • Public • Published

    The Logs

    Stop using console.log and use this simple logs API at your daily proccess

    NPM Version NPM Downloads Build

    Installation

    This is a Node.js module available through the npm registry.

    Before installing, download and install Node.js. Node.js 0.10 or higher is required.

    If this is a brand new project, make sure to create a package.json first with the npm init command. Installation is done using the npm install command:

    $ npm install --save the-logs

    Usage

    // First of all, you should create a instance of the logger
    // This code goes before your application entry point
    
    import { Logger, LogLevel } from 'the-logs';
    
    Logger.buildLogger({
      serviceName: 'service-name',
      serviceVersion: '1.0.0',
      logLevel: LogLevel.Debug,
      environment: process.env.NODE_ENV,
      useCase: 'My example',
    });
    // This code goes in any file of your project
    // Creates your logger object
    
    let logger = Logger.getLogger({ interUseCase: 'First logs wave' });
    logger.debug('This is a debug log'); // [service-name@1.0.0][My example][First logs wave] - [Debug] This is a debug log
    logger.info('This is an info log'); // [service-name@1.0.0][My example][First logs wave] - [Info] This is an info log
    logger.error('This is an error log'); // [service-name@1.0.0][My example][First logs wave] - [Error] This is an error log
    
    // Updates your logger with other log level
    logger = Logger.getLogger({ logLevel: LogLevel.Error });
    logger.debug('This is a debug log'); //
    logger.info('This is an info log'); //
    logger.error('This is an error log'); // [service-name@1.0.0][My example] - [Error] This is an error log
    
    // Updates your logger with other log level and add an interUseCase
    logger = Logger.getLogger({ interUseCase: 'Last logs wave', logLevel: LogLevel.Info });
    logger.debug('This is a debug log'); //
    logger.info('This is an info log'); // [service-name@1.0.0][My example][Last logs wave] - [Info] This is an info log
    logger.error('This is an error log'); // [service-name@1.0.0][My example][Last logs wave] - [Error] This is an error log

    Features

    • [x] Log at console
    • [x] Refactor and use Singleton pattern
    • [x] Add multiple configs to track logs beetwen process
    • [x] Log at .log file
    • [ ] Create platform to display logs
    • [ ] Create writer to be consumed by platform
    • [ ] Create metrics using logs
    • [ ] Create custom metrics
    • [ ] Create notifications system

    Configs

    LogLevel Environment Platform Writers
    Debug Beta Container Console
    Info Development Docker File
    Notice Production Instance -
    Warning Stable Lambda -
    Error Staging Serverless -
    Critical Test VM -
    - Testing - -

    LogLevel Hierarchy

    Log levels below the configured level won't be logged

    Critical > Error > Warning > Notice > Info > Debug

    Install

    npm i the-logs

    DownloadsWeekly Downloads

    9

    Version

    1.1.2

    License

    MIT

    Unpacked Size

    28 kB

    Total Files

    45

    Last publish

    Collaborators

    • avatar