@applied/applied-logger

1.1.1 • Public • Published

Applied Logger

A simple logging utility that aims to make reading logs quickly locally as well as format our logs nicely for our log aggregation setup.

Installation

yarn add @applied/applied-logger

What can it do?

Rather than replacing the global console, the logger works by wrapping it. This means that you need to import the Applied logger: import logger from '@applied/applied-logger'

Then you can call it:

logger.log('foo bar blah blah')

The logger has a number of options:

logger.error() logger.warn() logger.info() logger.log() logger.debug()

Alt text

Each of these will style the output differently + will pretty print data structures it gets passed.

Alt text

Theres also a special option:

logger.sql()

This will pretty print sql queries given to it.

Tests

Unit tests can be run with yarn run test

By default this skips the fuzz tests in the repo. These fuzz tests are run regularly but given that they are CPU intensive and slow they are not run by default. Why on earth did we add fuzz testing? Well, the logger is used throughout our production setup and it'd be really lame if it failed because it was passed a weird string/object. The fuzz tasting generates hundreds of strings, arrays, objects and JSON objects and ensures that the logger doesn't error out on those things.

Readme

Keywords

none

Package Sidebar

Install

npm i @applied/applied-logger

Weekly Downloads

3

Version

1.1.1

License

ISC

Unpacked Size

173 kB

Total Files

4

Last publish

Collaborators

  • amym-applied
  • ryan-applied
  • rbkburke
  • brett-applied
  • hewi