@mmit/logging

Minimal Logging framework

0.1.8

latest

GitHub

npm

Version published: 2 years ago

Maintainers: 1

Weekly downloads: 604; increased by23.27%

Weekly downloads

Readme

Source

Minimal TS Logging framework

Live-Example | GitHub-Home

Very simple but extendable logger in TypeScript.

For now there are only two loggers define: ConsoleLogger and NoOpLogger but it should be easy to define your own logger

Install

# NPM
npm install @mmit/logging

# YARN
yarn add @mmit/logging

Usage

The "default LogLevel" is 'INFO'

The most simplest way to get the logger is:

    import { LoggerFactory } from '@mmit/logging';

    const logger = LoggerFactory.getLogger('test.Logger');
    
    // Will not be shown
    logger.debug("Shows message only if debug-level is set!");

    // Will not be shown
    logger.info("Shows message only if info-level is set!");

    // Shows the warning message 
    logger.warn("Shows message only if warn-level is set!");

If you need more control:

    import { LoggerFactory, LogLevel } from '@mmit/logging';

     const logger = LoggerFactory.for('test.Logger')
                .level(LogLevel.DEBUG)
                .get();
    
    // Will be shown
    logger.debug("Shows message only if debug-level is set!");

    // Will be shown
    logger.info("Shows message only if info-level is set!");

    // Will be shown
    logger.warn("Shows message only if warn-level is set!");

If you want to specify your own Log-Channel:

    import { LoggerFactory, LogLevel, Channel } from '@mmit/logger';

    class MyCoolLogChannel implements Channel {
        ...
    }

    const myChannel = new MyCoolLogChannel();
    
    const logger = LoggerFactory.for('test.Logger')
                .on(myChannel)
                .level(LogLevel.DEBUG)
                .get();
    
    logger.debug("Shows message only if debug-level is set!");

Output Example

    console.info node_modules/@mmit/logging/lib/channels/ConsoleLogger.js:23
      15:42:42.998 [INFO] Connecting to : wss://mobiad.int.mikemitterer.at:8060/message | ...st.integration.services.WebSocket
    console.info node_modules/@mmit/logging/lib/channels/ConsoleLogger.js:20
      15:42:43.148 [INFO] onOpenEvent-Payload:                               | ...st.integration.services.WebSocket
      "{\"event\":\"mm.services.websocket.onOpenEvent\"}"
    console.info node_modules/@mmit/logging/lib/channels/ConsoleLogger.js:20
      15:42:43.148 [INFO] Event:                                             | ...st.integration.services.WebSocket
      {
          "event": "showresourceevent",
          "data": {
              "resourcetype": "Job",
              "resourceid": "25ee12ff-1dc2-40dd-afc6-4a2901491e72",
              "url": "http://www.mikemitterer.at/images/mobiad.jpg"
          }
      }
    console.info node_modules/@mmit/logging/lib/channels/ConsoleLogger.js:20
      15:42:43.288 [INFO] onJsonEvent-Payload:                               | ...st.integration.services.WebSocket

Keywords

typescript logging

FAQs

What is @mmit/logging?

Is @mmit/logging popular?

Is @mmit/logging well maintained?

Last updated on 30 Jun 2021

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket