npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

serviser-logger

v2.0.4

Published

wrapper around winston logger

Downloads

10

Readme

Build Status

var logger = require('serviser-logger');
  • Logger's behavior is configured via a config object (Example 1) provided to logger.reinitialize method.
  • Unless the logger is reinitialized with user defined configuration, the logger saves logs to the porcess.cwd() + '/logs' dirrectory (=default behavior).

Example 1

{
    exitOnError: false,  // determines whether a process will exit with status code 1 on 'uncaughtException' event
    transports: [
        {
            type: 'fluentd', // [required]
            priority: 1, // [default=Infinity] [required]
            origin: 'bi-depot', // [required]
            host: '127.0.0.1', // [required]
            port: 24224, // [required]
            timeout: 3, // [optional]
            reconnectInterval: 60000 //ms [optional]
        },
        {
            type: 'file',
            level: 'error', // maximum log level of this sepecific transport, [optional]
            priority: 2,
            dir: 'logs', // can be absolute or relative to the node's process
            autocreate: true // whether the `dir` should be created if it does not exist
        },
        {
            type: 'console',
            level: 'uncaughtException',
            priority: 3
        }
    ]
}
  • The above config sets up the logger so that all messages are sent to fluentd server.
  • If temporary failure of the fluentd logger is experienced, reason behind the failure is logged into the ./logs/fault-${date}.json file.
  • Meanwhile, the fluentd transports continues to buffer its logs and tries to reconnect to the fluentd server.
  • Once connection is successfull, internal buffer with logs is flushed to the fluentd server.

Config

  • type - fluentd | file | console
  • priority - Highest=1 Lowest=Infinity
    • All logs are redirected to transports with the highest priority.
    • That means you can effectivelly log messages to more than one transport at the time given that two or more transports share same priority value.
    • Transports with lower priority define fallback log destinations in case main transport(s) (one(s) with the highest priority) experience temporary failure
  • level - maximum log level of this a transport
    • each logger possess the following levels (by default):
      uncaughtException | error | warn | info | verbose
    • The levels corresponds to a logger's methods eg. logger.error() & logger.info etc..
    • When transport's level option value equals eg. error - only uncaughException & error events will be logged. Other event will be ignored

Logging - usage

var logger = require('serviser-logger');

//if needed, reinitialize should be called once at app's initialization cycle
//every time `reinitialize` is called, static `serviser-logger` module is reconfigured
logger.reinitialize({
    transports: [
        type: 'file',
        dir: 'logs',
        autocreate: true
    ]
});

//somewhere in the app:
var err = new Error('test');
logger.error(err);

logger.error('message', {meta: 'data'});
logger.warn('message', {meta: 'data'});
logger.info('message', {meta: 'data'});

Custom loggers

So far, we discussed only logging of "fault" events in application's life cycle.
In case you need to log other types of data, eg. OAuth events, you want to create a new logger:


//create a new logger
var oauthLogger = logger.getOrBuildLogger('oauth', {
    levels: {
        authFailure: 0
        refreshAccess: 1,
    }
});

//use logger
oauthLogger.authFailure({
    accountId: 'id',
    ip: req.ip,
    origin: req.header('origin')
});