JSPM

hapi process monitoring

The 'Monitor' should be configured using a 'hapi' server instead of calling the 'Monitor' constructor directly.

good is a process monitor for three types of events:

• System and process performance (ops) - CPU, memory, disk, and other metrics.
• Requests logging (request) - framework and application generated logs generated during the lifecycle of each incoming request.
• General events (log) - logging information not bound to a specific request such as system errors, background processing, configuration errors, etc. Described in General Events Logging.

Applications with multiple server instances, each with its own monitor should only include one log subscription per destination as general events are a process-wide facility and will result in duplicated log events. To override some or all of the defaults, set options to an object with the following optional settings:

• broadcastInterval - the interval in milliseconds to send collected events to subscribers. 0 means send immediately. Defaults to 0.
• opsInterval - the interval in milliseconds to sample system and process performance metrics. Minimum is 100ms. Defaults to 15 seconds.
• extendedRequests - determines if the full request log is sent or only the event summary. Defaults to false.
• requestsEvent - the event type used to capture completed requests. Defaults to 'tail'. Options are:
  • 'response' - the response was sent but request tails may still be pending.
  • 'tail' - the response was sent and all request tails completed.
• subscribers - an object where each key is a destination and each value is either an array or object with an array of subscriptions. The subscriptions that are available are ops, request, and log. The destination can be a URI or console. Defaults to a console subscription to all three. To disable the console output for the server instance pass an empty array into the subscribers "console" configuration.

For example:

var options = {
    subscribers: {
        console: ['ops', 'request', 'log'],
        'http://localhost/logs': ['log']
    }
};

hapi.plugin.require('good', options, function (err) {
    
    if (!err) {
        // Plugin loaded successfully
    }
});

Disabling console output:

var options = {
    subscribers: {
        console: [],
        'http://localhost/logs': ['log']
    }
};

Log messages are created with tags. Usually a log will include a tag to indicate if it is related to an error or info along with where the message originates. If, for example, the console should only output error's that were logged you can use the following configuration:

var options = {
    subscribers: {
        console: { tags: ['error'], events: ['log'] }
    }
};

Broadcast Request Structure

When good broadcasts data to a remote endpoint it sends json that has the following properties:

• schema - the value of 'schemaName' in the settings. Default is 'good.v1'
• host - the operating system hostname
• appVer - the version of good
• timestamp - the current time of the server
• events - an array of the events that are subscribed to