Sparkplug Shared
The sparkplug-decode plugin combines the sparkplug-audit, sparkplug-decode, and sparkplug-rebirth-proxy features.
If enabled, these features all share a store of sparkplug birth information which allows the plugins to remap aliased metrics to their metric names, and for the rebirth proxy to redistribute birth messages.
The birth information store persists across restarts and across cluster nodes. Information from the store will be updated when new birth messages are received, but will never be automatically removed.
Two commands exist to manage the birth store: listStoredNodes and deleteStoredNodes:
listStoredNodes
This command lists the currently stored nodes. It takes a count and offset
parameter to control paging, and allows filtering on groupId and edgeNodeId.
deleteStoredNodes
This command can take two parameters, groupId and edgeNodeId.
| groupId | edgeNodeId | Valid? | Effect |
|---|---|---|---|
| (missing) | (missing) | Yes | Remove all nodes and devices in the birth store |
| (missing) | "node id" | No | None |
| "group id" | (missing) | Yes | Remove all nodes and devices that match groupId |
| "group id" | "node id" | Yes | Remove all nodes and devices that match both groupId and edgeNodeId |