AWS Injector supports custom tag properties to enable certain features. Creating custom properties on MQTT tags is a simple process and is no different than custom properties on any other Ignition tag (as documented here).

A refresh of the AWS Injector will be required after any custom tag property is added, removed or updated

Custom Tag Properties

ExcludeFromPayload

Name: ExcludeFromPayload

Type: Boolean

Action: Controls whether or not a tag is included in the JSON message payloads.

Prior to v4.0.16, UDTs are not supported.

From v4.0.16 onward when applied to a UDT Definition, the UDT definition will not be added to the NBIRTH payload. If a nested UDT definition has the 'ExcludeFromPayload' property is set to 'true', the parent UDT will also be excluded from payload.


TagEventTracer

Name: TagEventTracer

Type: Boolean

Action: Controls whether or not a tag event tracing is generated for this tag.

  • Logs the timestamp (human readable and ms since epoch) and value when the BIRTH is built
  • Logs a timestamp (human readable and ms since epoch) and every time that tag changes and its value
  • Log a timestamp and value when a metric push happens

Available in release 4.0.17 or greater

Applying this custom parameter to multiple tags can result in significant system performance issues

  • No labels

New to MQTT? Start Here!