good-format

good-format is a transform stream useful for turning good server events into formatted strings.

Maintainer: Yehor Manzhula

Due to lack of customization in good-console plugin new plugin come up. With possibilities set font colors, styles formatting etc.

Author was inspired by GraphQl and colors packages, the last one is used for coloring and styling fonts.

Usage

new GoodFormat([config])

Creates a new GoodFormat object with the following arguments:

- `[config]` - optional configuration object with the following keys
- `response` - template for response event 
- `error` - template for error event
- `log` - template for log event
- `opts` - template for opts event

In manifest.js

    const GoodFormat = require('good-format');

    module.exports = {
        // ...
        register: {
            plugins: {
                // ...
                plugin: 'good',
                options: {
                    reporters: {
                        consoleReporter: [
                            new GoodFormat(),
                            'stdout']
                    } 
                }
                // ...
            }
        }
    };

Output Formats

Below examples of default output for the event type:

- "ops" - 160318/013330.957, [ops] memory: 29Mb, uptime (seconds): 6, load: [1.650390625,1.6162109375,1.65234375]
- "error" - 160318/013330.957, [error,`event.tags`] message: Just a simple error, stack: `event.error.stack`
- "request" - 160318/013330.957, [request,`event.tags`] data: you made a request
- "log" - 160318/013330.957, [log,`event.tags`] data: you made a default
- "response" - 160318/013330.957, [response, `event.tags`] http://localhost:61253: post /data {"name":"adam"} 200 (150ms)

- "ops" - PID:29333 181213171922478 memory: 126.68Mb, uptime: 8s, load: [4.42,3.53,2.54]
- "log" - PID:29333 181213171917674 [`event.tags`] Database connection open mongodb://mongo.example.com:27017
- "error" - PID:2591 181213173743466 error some error happen
    Error: some error happen
        at findTemplate (/var/www/test/actions.js:51:19)
        at module.exports.internals.Manager.execute (/var/www/test/node_modules/hapi/lib/toolkit.js:35:106)
        at Object.internals.handler (/var/www/test/node_modules/hapi/lib/handler.js:52:48)
        at exports.execute (/var/www/test/node_modules/hapi/lib/handler.js:37:36)
        at Request._lifecycle (/var/www/test/node_modules/hapi/lib/request.js:262:62)
        at process._tickCallback (internal/process/next_tick.js:68:7)}
- "request" - PID:29333 181213171922261 [`event.tags`] request GET /partials [{content: "<span>test</span>"}]
- "response" - PID:29333 181213171922052 [`event.tags`] response GET /partials {"name": "test"} 200 (23ms)

Customization

Inroduction

Under the hood good-format operates with two basic abstractions:

• Templates - function that process template and call formatters chain with value of given keys when event poped-up To define new template template function should be used.

  Important! Pay attention that event keys should be wrapped in quotes or singlequotes but formatters invocation - not.

    const GoodFormat = require('good-format');
    const {template} = GoodFormat;

    const opsTemplate = template`Uptime is: ${'proc.uptime'}` // Will retrieve proc.uptime value and output it

• Formatters - function that process given key value To define new formatter - formatter function should be used.

    const GoodFormat = require('good-format');
    const {template, formatter} = GoodFormat;

    /**
      * Round bytes value to Mb
      * 
      * @param {int} value Value to be processed
      * @returns {float}
      */
    const bytesToMb = formatter(value => {
        const mb = Math.round(value) / (1024 * 1024)
        return Math.round(mb * 100) / 100;
    });

    // Memory info partial
    const memoryTemplate = template`${bytesToMb('proc.mem.rss')}`;

Wide list of built-in formatters already available

    const GoodFormat = require('good-format');

    const {template,
        // Time
        timestamp,
        // Fonts and colors 
        font,
        // Objects 
        stringify, 
        // Math
        math, 
        // Strings
        toUpper, 
        toLower, 
        toString, 
        capitalize} = GoodFormat;    

Change output to custom fields

    const GoodFormat = require('good-format');
    const {template} = GoodFormat;

    module.exports = {
        // ...
        register: {
            plugins: {
                // ...
                plugin: 'good',
                options: {
                    reporters: {
                        consoleReporter: [
                            new GoodFormat({
                                ops: template`Uptime is: ${'proc.uptime'}`
                            }),
                            'stdout']
                    } 
                }
                // ...
            }
        }
    };

Format output font styles

    const GoodFormat = require('good-format');
    const {template, font} = GoodFormat;

    module.exports = {
        // ...
        register: {
            plugins: {
                // ...
                plugin: 'good',
                options: {
                    reporters: {
                        consoleReporter: [
                            new GoodFormat({
                                ops: template`Uptime is: ${font.red.bold('proc.uptime')}`
                            }),
                            'stdout']
                    } 
                }
                // ...
            }
        }
    };

Use custom theme for font formatting

    const GoodFormat = require('good-format');
    const {template, font} = GoodFormat;

    /**
      * Add custom theme to font formatter
      */
    font.setTheme({
        info: ['blue', 'bold'],
        error: ['red', 'bold']
    });

    module.exports = {
        // ...
        register: {
            plugins: {
                // ...
                plugin: 'good',
                options: {
                    reporters: {
                        consoleReporter: [
                            new GoodFormat({
                                error: template`Error message: ${font.error('error.message')} stack: ${font.error('error.stack')}`,
                                ops: template`Uptime is: ${font.info('proc.uptime')}`
                            }),
                            'stdout']
                    } 
                }
                // ...
            }
        }
    };

Choose font theme/color/style based on value

    const GoodFormat = require('good-format');
    const {template, font} = GoodFormat;

    /**
      * Add custom theme to font formatter
      */
    font.setTheme({
        info: ['blue', 'bold'],
        error: ['red', 'bold']
    });

    /**
      * Returns theme name depending on code
      * 
      * @param {int} statusCode
      * @returns {string} 
      */
    const statusCodeColor = statusCode => {
        if (statusCode >= 500) {
            return 'error';
        } 
        
        if (statusCode >= 400) {
            return 'warn';
        } 
        
        if (statusCode >= 300) {
            return 'info';
        }
        
        return 'success';
    };

    /**
      * Returns theme name depending on HTTP method
      * 
      * @param {String} method
      * @returns {String} 
      */
    const methodColor = method => {
        return ({
            GET: 'info',
            POST: 'success',
            PUT: 'success',
            DELETE: 'error',
            OPTIONS: 'warn'
        })[method.toUpperCase()] || 'info';
    };

    module.exports = {
        // ...
        register: {
            plugins: {
                // ...
                plugin: 'good',
                options: {
                    reporters: {
                        consoleReporter: [
                            new GoodFormat({
                                error: template`Error message: ${font.error('error.message')} stack: ${font.error('error.stack')}`,
                                ops: template`Uptime is: ${font.info('proc.uptime')}`,
                                request: template`${general} ${font(method, methodColor)} ${'path'} ${data}`,
                                response: template`${general} ${font(method, methodColor)} ${'route'} ${query} ${font('statusCode', statusCodeColor)}`
 
                            }),
                            'stdout']
                    } 
                }
                // ...
            }
        }
    };

Use partials for template separation

    const GoodFormat = require('good-format');
    const {template, font} = GoodFormat;

    /**
      * Add custom theme to font formatter
      */
    font.setTheme({
        info: ['blue', 'bold'],
        error: ['red', 'bold']
    });

    const generalInfo = template`PID: ${font.info('pid')}`

    module.exports = {
        // ...
        register: {
            plugins: {
                // ...
                plugin: 'good',
                options: {
                    reporters: {
                        consoleReporter: [
                            new GoodFormat({
                                error: template`${generalInfo} Error message: ${font.error('error.message')} stack: ${font.error('error.stack')}`,
                                ops: template`${generalInfo} Uptime is: ${font.info('proc.uptime')}`
                            }),
                            'stdout']
                    } 
                }
                // ...
            }
        }
    };

Custom formatting function

    const GoodFormat = require('good-format');
    const {template, font, formatter} = GoodFormat;

    /**
      * Add custom theme to font formatter
      */
    font.setTheme({
        info: ['blue', 'bold'],
        error: ['red', 'bold']
    });
   
    /**
      * Round bytes value to Mb
      * 
      * @param {int} value Value to be processed
      * @returns {float}
      */
    const bytesToMb = formatter(value => {
        const mb = Math.round(value) / (1024 * 1024)
        return Math.round(mb * 100) / 100;
    });

    // General info partial
    const generalInfo = template`PID: ${font.info('pid')}`
    
    // Memory info partial
    const memory = template`${bytesToMb('proc.mem.rss')}`;

    module.exports = {
        // ...
        register: {
            plugins: {
                // ...
                plugin: 'good',
                options: {
                    reporters: {
                        consoleReporter: [
                            new GoodFormat({
                                error: template`${generalInfo} Error message: ${font.error('error.message')} stack: ${font.error('error.stack')}`,
                                ops: template`${generalInfo} Uptime is: ${font.info('proc.uptime')} ${memory}`
                            }),
                            'stdout']
                    } 
                }
                // ...
            }
        }
    };