@shopify/logger
Opinionated logger for production-scale applications
Last updated 8 months ago by shopify-dep .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @shopify/logger 
SYNC missed versions from official npm registry.

@shopify/logger

Build Status License: MIT npm version

Opinionated logger for production-scale applications

Installation

$ yarn add @shopify/logger

Usage

Instantiation

A basic logger can be created simply by calling the Logger constructor:

const logger = new Logger();

The Logger constructor also takes an options object. For example:

const logger = new Logger({
  name: 'my-logger',
  formatter: new ConsoleFormatter(),
});

The options object adheres to the following interface:

interface LoggerOptions {
  formatter?: Formatter;
  name?: string;
}

The name of a logger will be used as it's root scope. A formatter may use this to provide context when outputting a log entry. For example, the ConsoleFormatter will preface each log with its scope, such as:

[my-logger] ℹ info - some log text

A Formatter is simply an object that implements the Formatter interface:

export interface Formatter {
  format(entry: FormatEntry): any;
}

In addition to writing your own formatter, See Formatters below for a list of provided formatters.

Logging

Given the logger above, we can log information to the console using the built-in info, warn, and error functions. For example:

logger.info('Hello, world!');
logger.warn('Something bad might happen');
logger.error(new Error('Operation not permitted.'));

Formatters

This package provides the following formatters:

  • ConsoleFormatter

ConsoleFormatter

Formats and prints logs via console.log, console.warn, and console.error.

Screenshots

sample error output

sample log output on a dark background

sample log output on a light background

Current Tags

  • 0.1.12                                ...           latest (8 months ago)
  • 1.0.0-sknext-beta.2                                ...           next (2 months ago)

18 Versions

  • 1.0.0-sknext-beta.2                                ...           2 months ago
  • 1.0.0-sknext-beta.1                                ...           2 months ago
  • 0.1.12-sknext-beta.9                                ...           2 months ago
  • 0.0.8-sknext-beta.8                                ...           2 months ago
  • 0.0.2-sknext-beta.2                                ...           2 months ago
  • 0.0.1-sknext-beta.1                                ...           2 months ago
  • 0.1.12                                ...           8 months ago
  • 0.1.11                                ...           9 months ago
  • 0.1.10                                ...           10 months ago
  • 0.1.9                                ...           10 months ago
  • 0.1.8                                ...           a year ago
  • 0.1.7                                ...           a year ago
  • 0.1.6                                ...           a year ago
  • 0.1.5                                ...           2 years ago
  • 0.1.3                                ...           2 years ago
  • 0.1.2                                ...           2 years ago
  • 0.1.1                                ...           2 years ago
  • 0.1.0                                ...           2 years ago
Downloads
Today 0
This Week 0
This Month 3
Last Day 0
Last Week 2
Last Month 53
Dependencies (4)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |