node package manager
Don’t reinvent the wheel. Reuse code within your team. Create a free org »

morgan-toolkit

Morgan ToolKit

by BideoWego

View it on NPM

Adds syntax highlighted logging of request objects: query, params, body, session, user to the Morgan logging package. Other features in development.

Installation

Install via NPM

$ npm install --save morgan-toolkit

Usage

Basic Morgan Toolkit usage is almost identical to usage for morgan. The only difference being that you must pass the morgan instance to configure morgan-toolkit when requiring. The default format for the Morgan Toolkit is 'tiny', however all morgan formats are supported.

const morgan = require('morgan');
const morganToolkit = require('morgan-toolkit')(morgan);
 
app.use(morganToolkit());

Logging Additional req Properties

Morgan Toolkit logs the following req properties by default:

  • query
  • params
  • body
  • session
  • user

Additional properties can be added by passing an options object when requiring the module:

const morgan = require('morgan');
const morganToolkit = require('morgan-toolkit')(morgan, {
  req: ['cookies', 'signedCookies']
});

Example Output

Here is an example screenshot of Morgan Toolkit logging:

Screenshot

License

Copyright 2017 Bideo Wego

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.