Overview

This node is publishes pipeline metadata to Lumeo Dashboards periodically or when a trigger condition is met. You can use it for reporting and dashboards.

Pipeline usage

This node can publish 3 types of metadata to the Lumeo Dashboard.

Metadata Type	Description	When to Use
Node Metadata	This includes Node-specific metadata such as Line Counter Node's line crossing metadata or Occupancy Monitor node's occupancy metadata. Refer to Node's documentation for information on what metadata is published to the Dashboard.	Use it to publish Node-specific stats such as line crossings, or occupancy numbers.
Object Attributes Metadata	This includes object types and object attributes that are added to an object by AI Model Node or specific Recognition nodes.	Use it to capture and display attributes (such as license plate numbers, vehicle types, barcode values, colors, etc.) Note that if you are just trying to count object attributes you are better served by using the Node Metadata instead of publishing Object Attributes.
Event Metadata	This publishes an event to the Dashboard every time specific Trigger Conditions are met.	Use it to publish counts of custom events that are not already being published by Node metadata -- such as a car making an illegal left turn.

Custom Metrics

Custom Function nodes can publish custom metrics and metadata for specific objects by storing them under its node metadata. Refer to Custom Function for how to do so.

Dashboard Setup

After deploying a Pipeline with this node, create a Lumeo Dashboards and add a Data widget to it to visualize the data.

Inputs & Outputs

Inputs : 1, Media Format : Raw Video
Outputs : 1, Media Format: Raw Video
Output Metadata : None

Properties

Property	Description	Type	Default	Required
`nodes_to_publish`	Publish node metadata. Options: None (`none`); All (`all`); Specific (`specific`).	`enum`	`all`	No
`node_ids_to_publish`	Node to publish. Conditional on `nodes_to_publish` being `specific`.	`string`	`null`	Yes
`trigger`	Publish node metadata just when this condition evaluates to true. Uses default triggers if not specified.	trigger-condition	`null`	No
`objects_to_publish`	Publish objects. Options: None (`none`); Related to specific Node (above) (`node_related`); Specified by metadata pattern (`pattern_matched_objects`); Specific types (`type_matched_objects`).	`enum`	`none`	No
`object_match_patterns`	Publish object metadata for objects specified by this pattern. Conditional on `objects_to_publish` being `pattern_matched_objects`. Format: comma-separated metadata paths or patterns.	`string`	`null`	No
`object_types`	ex. `car`,`person`,`car.red`. Object types to publish. Leave blank to process all. Conditional on `objects_to_publish` being `type_matched_objects`.	model-labels	`null`	No
`event_type`	Metrics event type to publish. Use to filter or count specific events in the dashboard.	`string`	`null`	No
`event_trigger`	Publish a metrics event when this condition evaluates to true.	trigger-condition	`null`	No
`metrics_tag`	Tag published metrics with this tag to make it easier to filter or group them in the dashboard.	`string`	`null`	No
`objects_only_new_updated`	If true, only publish objects the first time they are seen else publish both new and updated objects.	`bool`	`true`	No
`object_track_lifespan`	Number of frames for which an object is tracked to prevent duplicate reporting when the new or updated option is set. Unit: frames.	`number`	`600`	No
`interval`	Min. time between consecutive publish actions. Unit: seconds.	`float`	`5`	No
`use_stream_clock`	Enable to report correct time information when processing files.	`bool`	`false`	No
`use_camera_as_source`	Enable to report a linked camera as the source for camera streams and Universal bridge clips.	`bool`	`false`	No
`debug`	Print each outbound metrics payload before publishing.	`bool`	`false`	No

Output Metadata

Node does not insert any output metadata; upstream metadata continues through the pipeline