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

@shapeshiftoss/logger

v1.1.3

Published

A simple JSON logger with no external dependencies

Downloads

1,131

Readme

@shapeshiftoss/logger

ShapeShift DAO's simple logging library.

Installation

yarn add @shapeshiftoss/logger
# or
npm i @shapeshiftoss/logger

Initialization

import { Logger } from '@shapeshiftoss/logger'

const logger = new Logger({
  // name of the app or service
  namespace: ['Parent'],
  // alias: name: 'Parent'
  // severity threshold (default='info')
  level: 'debug',
  // extra fields to include on each message
  defaultFields: {
      fn: 'defaultFn'
  }
})

Custom logging output function

By default, the Logger will log a JSON string to the console.

You can customize this by providing a logFn option to the Logger constructor.

import { Logger } from '@shapeshiftoss/logger'
import type { LogLevel, LogData } from '@shapeshiftoss/logger'

const logger = new Logger({
  name: 'MyAppLogger',
  logFn: (level: LogLevel, data: LogData) => {
    myCentralLogger.send(JSON.stringify(data))
  }
})

Logging

Functions

  • trace
  • debug
  • info
  • warn
  • error

Examples

// (string)
logger.info('my message')
// {"fn":"defaultFn","message":"my message",
//   "timestamp":"2021-10-25T17:48:33.255Z","namespace":"Parent","status":"info"}

// (object)
logger.debug({ txid: '123aef' })
// {"fn":"defaultFn","txid":"123aef",
//   "timestamp":"2021-10-25T17:49:21.105Z","namespace":"Parent","status":"debug"}

// (error)
logger.error(new Error('something went wrong'))
// {"fn":"defaultFn","error":{"message":"something went wrong","stack":"...snip...","kind":"Error"},
//  "timestamp":"2021-10-25T17:49:31.626Z","namespace":"Parent","status":"error"}

// (error, object, string)
logger.error(
    new Error('something went wrong'),
    { data: { orderId: '123-aef-33' }},
    'error occured while fetching order'
)
/*
{"fn":"defaultFn",
  "error":{"message":"something went wrong","stack":"...snip...","kind":"Error"},
  "data":{"orderId":"123-aef-33"},
  "message":"error occured while fetching order",
  "timestamp":"2021-10-25T17:50:53.101Z",
  "namespace":"Parent",
  "status":"error"
}
 */

Child loggers

const child = logger.child({ foo: 'bar' })
child.info({ biz: 'baz' }, 'hello!') 
// {"fn":"defaultFn","foo":"bar","biz":"baz","message":"hello!",
//   "timestamp":"2021-10-25T17:52:29.111Z","namespace":"Parent","status":"info"}

Namespacing

The namespace configuration property can be used to keep track of the depth/call stack.

When including namespace in a child, it APPENDS the values to the existing namespace making it easy to see in the output the chain that leads to the output.

const child2 = child.child({ namespace: ['MyModule', 'myFunction']})
child.info({ biz: 'baz' }, 'hello!') 
// {"fn":"defaultFn","biz":"baz","message":"hello!",
//   "timestamp":"2021-10-25T17:53:55.909Z","namespace":"Parent:MyModule:myFunction","status":"info"}

Reserved Properties

The following property names are reserved. If you want to log out an object that contains these property names, you'll need to nest it inside another object.

  'namespace'
  'timestamp'
  'status'