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

fh-logger

v1.0.0

Published

Enables a simple way of configuring and creating loggers, configured with request serializers, including clustering information.

Downloads

98

Readme

fh-logger

npm package

Build status Dependency Status Known Vulnerabilities

Enables a simple way of configuring and creating Bunyan loggers, configured with request serializers, including clustering information.

Install

npm install fh-logger

Usage

JavaScript object configuration

var fh_logger = require('fh-logger');
var logger = fh_logger.createLogger({name: 'first'});

This will produce a Bunyan logger that will have a request serializer, and will log to process.stdout.

String configuration

You can pass in a JSON string containing your logger configuration. This is useful if you define your logger configuration externally to your code, for example in a .json file:

{
  "name": "testing",
  "streams": [{
    "type": "file",
    "stream": "file",
    "path": "/path/to/testing.log",
    "level": "info"
  }, {
    "type": "stream",
    "src": true,
    "level": "trace",
    "stream": "process.stdout"
  }, {
    "type": "raw",
    "src": true,
    "level": "trace"
  }]
}

Create the logger passing in the string configuration read from the above file:

var fh_logger = require("fh-logger");
var logger = fh_logger.createLogger(stringConfig);

Testing

To run all the tests:

grunt mochaTest

Request Id logging

fh-loggger also exports express-compatible middleware to generate unique requestId and automatically include it in logging methods.

var fh_logger = require('fh-logger');

// must be called to setup the middleware
var logger = fh_logger.createLogger({
  name: 'first',
  requestIdHeader: 'X-SOME-HTTP-HEADER'
});
app.use(logger.requestIdMiddleware);
app.get('/', function(req, res) {
  console.log(req.requestId); // uuid
  console.log(logger.requestId); // uuid
  logger.info('some message'); // -> {msg: 'some message', requestId: 'some-uuid'}
  logger.info(logger.requestIdHeader) // -> {msg: 'X-SOME-HTTP-HEADER', requestId: 'some-uuid'}
})

By default it utilizes the 'X-FH-REQUEST-ID' header, this can be overridden by the configuration passed to createLogger as shown above

ensureRequestId

For logging inside callbacks that are supposed to display the requestId but for some reason do not, utilize the exported ensureRequestId({Function}):

logger.ensureRequestId(function asyncOperation(err, data){
  logger.error(err); // -> {req.reqId: 'some-uuid'}
});

For more information refer to the continuation-local-storage module docs