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

pn-logging

v5.3.1

Published

A logging wrapper around winston and sentry.

Downloads

15

Readme

pn-logging

A logging wrapper around winston and sentry.

Usage

Ad-hoc log message

var Log = require('pn-logging').Log;

var logger = new Log(config);

// Call methods
logger.info('Message', meta);

logger.error('Error message', err);
// or
logger.error('Error message', meta, err);

Request/response middleware

// Use Express middleware
app.use(logger.middleware());

app.get('/', (req, res, next) => {
  // ...
  res.locals._log.addMeta({ keyName: 'value' });
  // ...
})

The big picture idea is that every req/res gets one log message, the level of which is set according to the final response status code:

  • 200s = info
  • 400s = warning (usually)
  • 500s = error

The middleware attaches a log object to every req/res lifecycle as res.locals_log. This object exposes methods like addMeta and addError that attach fields to the final log for that req/res cycle.

addMeta attaches useful and relevant info about that req/res cycle as k/v pairs on its meta property. addError is a helper method that takes an Error, extracts useful info from it, and attaches it to meta.

(Errors within a req/res lifecycle may also warrant their own ad-hoc log messages, such as if an API request to a service fails.)

Report to Sentry

If error object is passed to logger's logging methods, e.g. error, in addition to sending data to defined transporter (most likely Loggly), the error will also be sent to Sentry.

var Log = require('pn-logging').Log;
var logger = new Log(config);

logger.error('Error message', {
  tags: {key: 'value'}
}, err);

Refer to sentry docs.

tags, fingerprint, and level properties of log meta object will be mapped to related sentry optional attributes. All other meta properties will become extra property in sentry optional attributes.

Config

The config object passed to Log constructor should look like:

var config = {
  transports: [
    {
      Console: {
        level: 'info',
        json: true,
        prettyPrint: true,
        silent: true // for test
      }
    },
    {
      Loggly: {
        level: 'warning',
        json: true,
        tag: 'APP_NAME',
        subdomain: process.env.LOGGLY_SUBDOMAIN,
        token: process.env.LOGGLY_TOKEN
      }
    }
  ],
  sentry: {
    // specify `false` here to disable sentry
    dsn: 'https://*****@app.getsentry.com/xxxxx',
    // pass directly to raven constructor refer to https://goo.gl/9Ud7Mz
    options: {}
  }
};