alexandrebodin/hapi-good-winston

A good reporter to send and log events with winston

hapi-good-winston

A good reporter to send and log events with winston

Disclaimer

• Use v3.* for hapi >= 18

• Use v2.* for version prior to hapi v18

• Use v1.* for version prior to hapi v17

Installation

$ npm install --save hapi-good-winston

Usage

import { Server } from 'hapi';
import winston from 'winston';
import goodWinston from 'hapi-good-winston';

const logger = winston.createLogger({
    level: 'info',
    format: winston.format.json(),
    transports: [new winston.transports.Console()],
});

const server = new Server();

// Set winston minimum log level to debug
// winston.level = 'debug';

// Only the 'response' and 'error' event levels will be overwritten
const goodWinstonOptions = {
    levels: {
        response: 'debug',
        error: 'info',
    },
};

const options = {
    ops: {
        interval: 1000,
    },
    reporters: {
        // Simple and straight forward usage
        winston: [goodWinston(logger)],
        // Adding some customization configuration
        winstonWithLogLevels: [goodWinston(logger, goodWinstonOptions)],
        // This example simply illustrates auto loading and instantiation made by good
        winston2: [
            {
                module: 'hapi-good-winston',
                name: 'goodWinston',
                args: [logger, goodWinstonOptions],
            },
        ],
    },
};

server
    .register({
        plugin: require('good'),
        options,
    })
    .then(() => {
        return server.start();
    })
    .then(() => {
        console.info(`Server started at ${server.info.uri}`);
    });

Links

• Hapi
• Good
• Winston

License

MIT

hapi-good-winston's Issues

How to log request payload?

How to configure this module to log request payload?

Issue 1

Good dependency deprecated

@hapi/good dependency got deprecated since December 2019 according to package description

Support for winston > 3.x

Hi,

I get the following warning.

[email protected] requires a peer of winston@>=2.x <3.x but none is installed. You must install peer dependencies yourself.

It is possible to update the winston version?

NPM Install Failure

Good morning - our builds started failing this morning with this issue -

npm WARN deprecated [email protected]: Use uuid module instead
npm WARN deprecated [email protected]: please upgrade to graceful-fs 4 for compatibility with current and future versions of Node.js
npm ERR! code ETARGET
npm ERR! notarget No matching version found for good@>=7.x <=0.x
npm ERR! notarget In most cases you or one of your dependencies are requesting
npm ERR! notarget a package version that doesn't exist.
npm ERR! notarget
npm ERR! notarget It was specified as a dependency of 'hapi-good-winston'
npm ERR! notarget

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/scottstunkel/.npm/_logs/2018-01-29T13_09_26_032Z-debug.log

Sort of a vague problem I know, but I'm really stuck - any ideas on why this could suddenly start happening?

Hapi v17 Support

Overview

If you are not aware yet, Hapi v17 is making the transition from callbacks to async/await, as well as deprecating some other rarely used functionality. This is a breaking change that may make your plugin no longer compatible with the Hapi API.

Changelog

Draft release notes can be found here: hapijs/hapi#3658

Target Release

The target release date for v17 is the beginning of November.

Tasks

• Reply to this to acknowledge that you are actively maintaining this module and are willing to update it
• Update plugin to be fully async/await compatible using the v17 branch from Hapi for testing

  Possible dev flow for updating

  • Clone Hapi
  • npm link within the Hapi repo
  • npm link hapi within your plugin repo
  • Your plugin will now be using v17 of Hapi branch for tests
• Release new major version of your plugin on npm. Please use a major version increment as this will be a breaking change and it would be terrible for it to sneak into current versions of Hapi.

Notes

• Support is being dropped for all versions of Node <8.0.0.
• Hapi v16 will continue to be supported for as long as there exists a Node LTS actively being supported that is not compatible with v17.
• Targeted release date is November 1st, 2017. Please try to have your plugin updated before then.

How to customize log level?

I want to disable ops logs. How do I send that argument to hapi-good-winston?
An example in the project readme would be great.

Thanks!