Have ideas to improve npm?Join in the discussion! »

    @backendalpha/pancap_logger
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.1 • Public • Published

    pancaplogger

    pancaplogger is designed to be a simple logging library with support for multiple transports. A transport is essentially a storage device for your logs. Each logger can have multiple transports configured at different levels.It also supports querying of logs.

    Installation

    npm install pancaplogger npm install @types/pancaplogger

    Usage

    Streaming of logs

    //in index.ts file

    import logger from "pancaplogger";

    export logger.init(function () { });

    logger.error({ message: "error",tag:TagId,additionalInfo: {message: "Some additional message",otherData:"Some additional data"}}); logger.info({ message: "info",tag:TagId,additionalInfo: {message: "Some additional message",otherData:"Some additional data"}}); logger.debug({ message: "debug",tag:TagId,additionalInfo: {message: "Some additional message",otherData:"Some additional data"}}); logger.warn({ message: "warn",tag:TagId,additionalInfo: {message: "Some additional message",otherData:"Some additional data"}}); logger.exception({ message: "exception",tag:TagId,additionalInfo: {message: "Some additional message",otherData:"Some additional data"}});

    Querying of logs

    //In index.ts file

    import query from "pancaplogger";

    query(fromTimeStamp:"value",toTimeStamp:"value",tagId:"value",level:"value",pageNumber:"value",pageSize:"value");

    Table of Contents

    *Introduction *Logger *Query *Transport *HelpingUtilities *Transport logger *Constants *ExceptionHandler *ES6MapWrapper *Types(interface related to Pancap_logger)

    Introduction

    Pancap_logger is amde to get logs based on five different levels. 1.Error 2.Info 3.Debug 4.Warn 5.Exception

    Logger

    Logger contains how this logger works.It contains how the logger directory is created and how file rotation works.In this logger a HashMap is created whose "key" is timestamp and "value" is the log count of each level and separate log count of each level based on different tags.

    Query

    this file is used to retrieve Queries of logs based on different levels. It can be retrieved using tagId,FromTimeStamp,ToTimeStamp,levels,pageNumber and PageSize.

    Transport

    Transport contains on how to create stream and write logs into a specified directory.

    HelpingUtilities

    This contains all the utility functions used in cretaing this logger.New file is created after every 24 hours.

    Transport Logger

    This contains different logger transport based on level.

    Constants

    This contains all the constants Used in this logger.It also contains the tagId codes based on different scenarios.

    Exception Handler

    This contains on how to catch and log uncaught exceptions.

    ES6MapWrapper

    This contains different utility function related to the HashMap.

    Types

    This contains different Interfaces made for better usage.

    License

    panaeshacapital

    Install

    npm i @backendalpha/pancap_logger

    DownloadsWeekly Downloads

    3

    Version

    1.0.1

    License

    ISC

    Unpacked Size

    72.7 kB

    Total Files

    36

    Last publish

    Collaborators

    • avatar