https://github.com/alexandrebodin/hapi-good-winston

A good reporter to send and log events with winston
https://github.com/alexandrebodin/hapi-good-winston

good hapi hapi-good hapi-plugin hapijs logger logging winston

Last synced: 9 days ago
JSON representation

A good reporter to send and log events with winston

• Host: GitHub
• URL: https://github.com/alexandrebodin/hapi-good-winston
• Owner: alexandrebodin
• License: mit
• Created: 2016-05-27T16:16:58.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-08-29T13:31:33.000Z (5 months ago)
• Last Synced: 2025-01-16T23:03:49.268Z (16 days ago)
• Topics: good, hapi, hapi-good, hapi-plugin, hapijs, logger, logging, winston
• Language: JavaScript
• Size: 120 KB
• Stars: 21
• Watchers: 1
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# hapi-good-winston

A good reporter to send and log events with winston

[![npm](https://img.shields.io/npm/v/hapi-good-winston.svg?style=flat-square)](https://www.npmjs.com/package/hapi-good-winston)

[![npm](https://img.shields.io/npm/dm/hapi-good-winston.svg?style=flat-square)](https://www.npmjs.com/package/hapi-good-winston)

[![license](https://img.shields.io/github/license/alexandrebodin/hapi-good-winston.svg?style=flat-square)](https://opensource.org/licenses/MIT)

[![CircleCI](https://img.shields.io/circleci/project/alexandrebodin/hapi-good-winston.svg?style=flat-square)](https://circleci.com/gh/alexandrebodin/hapi-good-winston)

[![Dependency Status](https://dependencyci.com/github/alexandrebodin/hapi-good-winston/badge?style=flat-square)](https://dependencyci.com/github/alexandrebodin/hapi-good-winston)

[![Issues](https://img.shields.io/github/issues-raw/alexandrebodin/hapi-good-winston.svg?style=flat-square)](https://github.com/alexandrebodin/hapi-good-winston/issues)

[![PR](https://img.shields.io/github/issues-pr-raw/alexandrebodin/hapi-good-winston.svg?style=flat-square)](https://github.com/alexandrebodin/hapi-good-winston/pulls)

## Disclaimer

-   Use `v3.*` for hapi >= 18

-   Use `v2.*` for version prior to hapi v18

*   Use `v1.*` for version prior to hapi v17

## Installation

```bash

$ npm install --save hapi-good-winston

```

## Usage

```javascript

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](https://github.com/hapijs/hapi)

-   [Good](https://github.com/hapijs/good)

-   [Winston](https://github.com/winstonjs/winston)

# License

[MIT](LICENSE)