Giter Club home page Giter Club logo

mozlog's Introduction

mozlog

NPM version Build Status

A logger that outputs JSON that adheres to Heka's expected schema.

npm install --save mozlog

Usage

You must configure mozlog one time before using it's loggers. This is essentially setting the app name, the level, and the fmt.

For the brave (or those who know intel's configuration options), you can pass a config property to have fine-grained control.

// once, such as at app startup
require('mozlog').config({
  app: 'fxa-oauth-server',
  level: 'verbose', //default is INFO
  fmt: 'pretty', //default is 'heka'
  debug: true, //default is false
});

You may want the level set down to verbose or debug when developing. Likewise, you may want the line to be readable by humans when developing, so the pretty formatter will help.

In production, the defaults will serve you well: info and heka.

// elsewhere
var log = require('mozlog')('routes.client.register');

log.info(op, { some: details });
// such as
log.debug('newClient', { id: client.id, name: client.name });

First parameter is a string "op". It should be unique within the file. Second parameter is some optional object, with keys and values that would make sense when looking at the logs again.

The debug option (not level) in the config will add in some asserts that your usage adheres to the above: that there's only ever at most 2 arguments to a log function, the first is a string without spaces.

mozlog's People

Contributors

seanmonstar avatar dannycoates avatar whd avatar

Watchers

Rémy HUBSCHER avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.