Publish to Elasticsearch Node

Publish pipeline metadata to Elasticsearch periodically or when a trigger condition is met, for reporting and dashboards.

Overview

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

Inputs & Outputs

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

Properties

PropertyValue
trigger_typeWhen to Collect Metadata
- custom_trigger :Collect metadata when a custom trigger is fired
- auto_trigger :when significant node properties change (auto trigger),
- periodic :at an interval (periodic)
- scheduled :at fixed times past the hour (scheduled)
triggerIf trigger_type is custom_trigger, the metadata is only collected when this trigger condition evaluates to True.

The trigger expression must be a valid Dot-notation expression that operates on Pipeline Metadata and evaluates to True or False. See details here.

ex. `nodes.annotate_line_counter1.lines.line1.total_objects_crossed_delta > 0
intervalMinimum time, in seconds, between consecutive publishing actions. 0 means publish every time it is collected.

ex. 60
schedule_publishingIf set, ignores the Interval property and schedules publishing at a synchronized time.

Options:
Every Day
Every Hour
Every 30 minutes
Every 15 minutes
managed_esIf true, publishes data to a Lumeo-managed Elasticsearch instance.
es_uriURI for Elasticsearch Server.

ex. https://lumeo1.elastic-cloud.com:9243
ex. https://user:[email protected]:9243
es_verify_certsIf true, verifies Elasticsearch server certificate. Turn off to allow self-signed certificates (Warning: insecure).
es_api_keyBase10 encoded API key for your Elasticsearch server. Leave empty if you specify credentials in the URI.

ex. V2F2Zk1YNEJkS2lTUHFvc0aUQ==
es_indexName of the index to which metadata will be published. This index will be created if it does not exist already.

ex. lumeometa
es_max_retriesNumber of times to retry publishing if connection to Elasticsearch server fails, before giving up and discarding the data.
node_ids_to_publishPublish metadata only for the specified Node IDs. If not specified, publishes metadata from all upstream nodes.

Ex. annotate_line_counter1, annotate_queue1
snapshot_typeIf not None, send snapshot as a base64 encoded jpeg to Elasticsearch.

Warning: Significantly increases your ES storage consumption.

Options:
None (null)
small : Max 320px width
medium : Max 640px width
use_stream_clockIf true, reports timestamps from the stream to Elasticsearch instead of using clock time. Enable to report correct time information when processing files, since they are typically processed faster than real time.

ex. true / false

Metadata

This node does not add any new metadata to the frame.

Metadata PropertyDescription
NoneNone

Elasticsearch Configuration

Viewing Snapshots in Kibana

Head to Stack Management -> Index Patterns -> lumeo-<application_id> and search for snapshot field. This field will appear once atleast one shapshot has been sent to ES from Lumeo.

  • Click "Edit Field" (pencil icon on the right end of the field name)
  • Enable "Set Format" and configure it with the following settings:
    • Format: Url
    • Type: Image
    • URL Template: data:image/jpg;base64,{{rawValue}}
    • Label Template: Image