Logging

1.0.1 • Public • Published

Logging

Simple logging module for microsystems that wraps winston and continuation-local-storage.

What we ultimately wanted to achieve is to generate microservice logs that are unique, traceable, and contain enough data to act on quickly and effectively. To create these logs: -Append a unique identifier to requests as they enter the architecture. -Identify the service that generates events. -Generate events specific to each microservice as the request enters and leaves the service. -Correlate events from each microservice to create an overall view of the request.

Install

 npm install logging

Usage

  var log = require('logging');

  log('hello world');

  log('hello world', 'Meta Data')

Features

  • Timestamp
  • API Name - Set as serverName in Config
  • Log Level - Set as logLevel in Config
  • Correlation id - Set as correlationid in context
  • Client Application - Set as clientapplication in context
  • Global User Id - Set as globaluserid in context
  • Message
  • Meta data

Set Context in calling application

var session = require('continuation-local-storage').createNamespace('request'); session.set('correlationid', req.headers.correlationid); session.set('correlationid', req.headers.clientapplication); session.set('correlationid', req.headers.globaluserid);

Set Confifg

serverName=Api Name logLevel=info, error, debug etc...

External Dependencies

  • Node
  • Config

License

(The MIT License)

Copyright (c) 2009-2010 Emer McVeigh <emerlundy@hotmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Readme

Keywords

none

Package Sidebar

Install

npm i Logging

Weekly Downloads

4

Version

1.0.1

License

MIT

Last publish

Collaborators

  • emcveigh