Node Monitor v0.6.5

Show:

LogProbe Class

Extends StreamProbe
Defined in: lib/probes/LogProbe.js:16
Module: Probes

Remote application log monitoring

This probe forwards application logs to the monitor.

Constructor

LogProbe

(
  • [initParams]
  • model
)

Parameters:

  • [initParams] Object optional

    Probe initialization parameters

    • [pattern=*] String optional

      Log name pattern to monitor (see Log)

    • [interval=1000] Numeric optional

      Queue interval (see StreamProbe)

  • model Object

    Monitor data model elements

    • bundle Log array

      Array of Log elements.

      • timestamp String
        Timestamp of the log statement
      • logType String
        Log type (error, info, etc)
      • module String
        Module that emitted the log
      • name String
        Log entry name
      • args Any
        Arguments to the log statement
    • sequence Integer

      A numeric incrementer causing a change event

Methods

_send

() private

Inherited from StreamProbe:

Send the bundle to the montitor

initialize

(
  • attributes
  • options
)

Inherited from Probe:

Initialize the probe

This is called on the probe during construction. It contains the probe initialization attributes and an option to make probe construction asynchronous.

Probe implementations can defer the initial response to the monitor until the initial state is loaded. This allows the callback on Monitor.connect() to have the complete initial state of the probe when called.

If the initial probe state cannot be determined in initialize, it should set the options.asyncInit option to true, and call the options.callback(error) once the initial state is determined.

// Asynchronous initialization
options.asyncInit = true;
var callback = options.callback

If asyncInit is set to true, the callback must be called once the initial state of the probe is known (or in an error condition).

// Set the initial state, and call the callback
this.set(...);
callback(null);

See the initialize method of the FileProbe probe for an example. It defers returning the probe to the monitor until the initial file contents are loaded.

Parameters:

  • attributes Object

    Initial probe attributes sent in from the Monitor

  • options Object

    Initialization options

    • asyncInit Boolean

      Set this to TRUE if the initial probe state can't be known immediately.

    • callback Function(error)

      The callback to call if asyncInit is set to true. If an error is passed, the probe will not be used.

onControl

(
  • name
  • [params]
  • [callback]
)

Inherited from Probe:

Dispatch a control message to the appropriate control function.

This is called when the control() method of a monitor is called. The name determines the method name called on the probe.

The probe must implement a method with the name {name}_control(), and that method must accept two parameters - an input params and a callback. The callback must be called, passing an optional error and response object.

For example, if the probe supports a control with the name go, then all it needs to do is implement the go_control() method with the proper signature. See ping_control() for an example.

Parameters:

  • name String

    Name of the control message.

  • [params] Any optional

    Input parameters specific to the control message.

  • [callback] Function(error, response) optional

    Called to send the message (or error) response.

    • error (Any) An object describing an error (null if no errors)
    • response (Any) Response parameters specific to the control message.

ping_control

(
  • params
  • callback
)

Inherited from Probe:

Respond to a ping control sent from a monitor

Parameters:

  • params Object

    Input parameters (not used)

  • callback Function(error, response)

    Called to send the message (or error) response.

    • error (Any) An object describing an error
    • response (String) The string 'pong' is returned as the response

queueItem

(
  • item
)

Inherited from StreamProbe:

Queue an item in the stream

This method places the item into the stream and outputs it to the monitor, or queues it up for the next bundle.

Parameters:

  • item Any

    Item to place into the queue

release

()

Inherited from Probe:

Release any resources consumed by this probe.

This can be implemented by derived classes that need to be informed when they are to be shut down.

Probes that listen to events should use this method to remove their event listeners.

Copyright © 2010-2014 Loren West, and other contributors. All rights reserved.
Docs generated using YUIDoc JS