Status

What's the Status node in Node-RED used for?

The Status node allows you to monitor the status of individual nodes or all the nodes running in your flow. The status node does not produce a payload but it does report on the operation of the node. This will allow you to programmatically react to error conditions or use case restrictions in a flow.

For example, a delay node that is queuing external messages may want to report an error message after the queue exceeds a specific number. The status node can be used to track the number of messages in the queue.

The output of the status node is in two formats: 1) the textual output is added in real-time below the node. The colour of the output will also change depending on the status. 2) An object called status is accessible from the debugger and other nodes, like the change node. The properties of the status object are listed below.

Example of Status nodes

Delay Node with Status Node

Debug output of Status Node

Node Documentation

Report status messages from other nodes on the same tab.

Outputs

status.text string
the status text.
status.source.type string
the type of the node that reported status.
status.source.id string
the id of the node that reported status.
status.source.name string
the name, if set, of the node that reported status.

Details

This node does not produce a payload.

By default the node reports status for all nodes on the same workspace tab. It can be configured to selectively report status for individual nodes.