Collectors and data formats
Data Formats
Sparkplug B Settings
the mqtt sparkplug b collector connects to a mqtt broker that supports sparkplug b it subscribes on the configured topic, which you can set to spbv1 0/# if you want to receive all messages the topic is of the following format for sparkplug b namespace/group id/message type/edge node id/\[device id] the best way to configure the topic is to pass a comma separated list of topics containing only the groups, edge nodes or devices you’re interested in for every message that the collector receives it will check if there is a corresponding measurement configured and create points to configure a measurement you need to specify the group id , edge node id , device id (optional) and the metric name measurement discovery and auto onboarding the sparkplugb collector can be configured to discover new measurements and optionally to try to automatically onboard them incoming messages that are not yet linked to a measurement are given a default name group id/edge node id/device id/metric name and the measurement is added in status discovered if autoonboard is not enabled if autoonboard is enabled and the collector has a default database configured, factry historian will attempt to set the newly discovered measurement to status active discovered measurements can be promoted to active by setting a database and optionally changing their name collector settings some collector settings are specific to the mqtt sparkplug b collector discovermeasurements description automatically discover measurements by parsing incoming messages if enabled, the collector will try to parse incoming messages and create measurements based on the message contents currently only supported for sparkplugb messages autoonboard description automatically try to onboard discovered measurements using the collector’s default database prerequisites the default database has to be configured for the collector, and discovermeasurements has to be enabled nameregexmatcher description change the automatically generated name for discovered measurements by setting this field and nameregexreplaceby the regex in this field will be matched with the default name generated by the collector the capture groups in the regex here can be used to selectively replace (parts of) the generated name nameregexreplaceby description the replacement string to replace the automatically generated name by use $1 , $2 , …, $n to reference capture groups/submatches in the nameregexmatcher measurement settings the measurement settings reflect the configuration possibilities for mapping a measurement to a sparkplug b metric collectiontype description the way this measurement should be collected from the opc ua server required no default raw options raw | downsampled | monitored checkout the json settings docid\ wzx5o0po00yfahzxqixzw section for more information downsamplinginterval description the minimum interval between points for collectiontype downsampled only relevant for this collectiontype required no default 0 groupid description the group id, it provides for a logical grouping of mqtt eon nodes required yes edgenodeid description the edge node id, it uniquely identifies the mqtt eon node within the infrastructure required yes deviceid description the device id, it identifies a device attached (physically or logically) to the mqtt eon node required no metricname description the name of the metric required yes tagnames description comma separated list of tags to extract required no