eyecontrol-web-logger

Service for logs of web

Usage no npm install needed!

<script type="module">
  import eyecontrolWebLogger from 'https://cdn.skypack.dev/eyecontrol-web-logger';
</script>

README

eyecontrol web-logger

A web logger service for node.js

Motivation

Eyecontrol-web-logger is designed to be simple and universal logging with support for multiple transports(winston and logz.io). Each instance can have multiple transports configured at different levels.

Quick installation

    npm i eyecontrol-web-logger

Usage

Instantiante the logger

In order to use the web-logger, you need to instantiate it with different parameters:

    const webLogger = require('eyecontrol-web-logger');
    const config = require('./config/config');

    const log = webLogger.createLogger({
        application: config.LOGZ_APPLICATIONS.SERVER,
        loggers: {
            winston: {
                activated: true
            },
            logzIo: {
                activated: true,
                token: 'xxxxxxxxxxxxxxxxxx',
                host: 'xxxxxxxxxxxxxxxxx'
            }
        }
    });

P.S: We recommand to instantiante it one time in a controller/service, and then export it.

Usage

After you instantianted the web-logger, you can work with it like with a classic logger. You need to call an instance of the logger and send 4 parameters: source, message, userEmail, deviceId.

    log.info("init", "init bluetooth connection...", "user@example.com", deviceId);

Logging levels

Three different levels: error, info, warn.

    log.error("getJson", err, "user@example.com", deviceId);
    log.info("init", "connect to bluetooth...", "user@example.com", deviceId);
    log.warn("fetchJson", "device undefined, get default json", "user@example.com", deviceId);

Installation

Installing npm (node package manager)

  curl https://npmjs.org/install.sh | sh

Installing eyecontrol-web-logger

  [sudo] npm install eyecontrol-web-logger

Author: Eyecontrol

Contributors: [Yohann]