Node Monitor v0.6.5


StreamProbe Class

Extends Probe
Module: Probes

Base class for probes that stream data

Offering real time data streaming can result in degraded performance due to the I/O overhead of sending individual stream elements to remote monitors.

This class eases that overhead by bundling stream elements, and sending those bundles in scheduled intervals. The monitor gets to decide the interval based on the stream volume, and their needs.

Derived classes output their stream data as elements of the bundle attribute.

A sequence attribute is incremented sequentially to assure change events are fired, and to allow clients to insure stream ordering and completeness.



  • [initParams]


  • [initParams] Object optional

    Probe initialization parameters

    • [interval=1000] Numeric optional

      Number of milliseconds to wait between bundles.



() private

Send the bundle to the montitor


  • 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

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.


  • 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.


  • 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.


  • 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.


  • params
  • callback

Inherited from Probe:

Respond to a ping control sent from a monitor


  • 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


  • item

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.


  • item Any

    Item to place into the queue



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.