Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For each Transmitter, a tag tree will be created with the tag path of TransmitterName > Tag Path > GroupID > EdgeNodeID

NameData TypeDescription
Enable Tag TrackingBooleanWritable tag to control whether or not to update Tags Per Seconds (added 4.0.17)
Largest Mesg Xmit (bytes)LongThe largest message size in bytes sent by the Edge Node since the last time the metrics were reset via the Edge Node Reset Metrics tag
Largest Mesg Xmit TimestampDateTimeThe time at which the largest message was sent by the Edge Node since the last time the metrics were reset via the Edge Node Reset Metrics tag
Last RefreshDateTimeThe time at which the last Edge Node refresh request was completed
Refresh AlarmsBooleanA writeable tag to request a full alarm refresh. This will force all Edge Nodes to publish all current alarms
Refresh Edge NodeBooleanA writeable tag to request a refresh of the Edge Node. This will force the Edge Node to disconnect and reconnect resulting in the sending of NDEATH, NBIRTH and DBIRTH messages
Refresh RequiredBooleanA tag indicating the new tags have been identified by Transmission for this Edge Node and a refresh is required.
Reset MetricsBooleanA writable tag to reset the metrics for this Edge Node
Tag CountLongThe number of tags identified for this Edge Node
Tags Per SecondLongThe number of tags changes published per second with the value updated every two seconds (added 4.0.17)
Total Bytes Xmit (bytes)LongThe number of bytes sent by the Edge Node since the last time the metrics were reset via the Edge Node Reset Metrics tag
Total Mesg XmitLongThe number of messages sent by the Edge Node since the last time the metrics were reset via the Edge Node Reset Metrics tag

MQTT Client

NameData TypeDescription
Command Latency (ms)Long

The amount of time for a test MQTT command message to be sent and received back by the MQTT

Client 

Client. Available for Sparkplug Transmitters only.

Enable Latency CheckBooleanWriteable tag to enable command latency checking for each MQTT Client. Available for Sparkplug Transmitters only.
In-flights Permits FreeIntegerThe number of inflight message permits available for use by the client. Available for UNS Transmitters only. (added 4.0.31)
MQTT Client IDStringThe Client ID for the MQTT Client
Offline DateTimeDateTimeThe last time at which the MQTT Client successfully disconnected from the MQTT Server
OnlineBooleanA read-only tag showing the connection status of the MQTT Client
OnlineDateTimeDateTimeThe last time at which the MQTT Client successfully connected to the MQTT Server
Primary Host IDStringThe Primary Host ID configured for this MQTT Client
Target Server URLStringThe URL of the target MQTT Server to connect to


History Store

For each History Store, a folder will be created with the name of the History Store

NameData TypeDescription
Database SizeLong

(Added 4.0.22) Created if the History Store type is Disk_Backed and shows the total size of the data tables used.

This value may be smaller than the Disk Used metric as when flushed rows are marked for deletion they are only deleted from the H2 DB on its internal schedule. This is to minimize the writes on a flash/SSD drive. 

Disk UsedLong

Created if the History Store type is Disk_Backed and shows the memory used since last module restartsize of the database file. This parameter will never go to zero for the following reasons:

  • The initial config of the DB will contain empty seeded tables based on the number of edge nodes and devices (table per edge node and per device) and at least one metadata table.Flushed rows are marked for deletion and will actually be deleted from the DB on its internal schedule. This is to minimize the writes on a flash/SSD drive.

Memory UsedLongCreated if the History Store type is In_Memory and shows the memory used since last module restart

...

NameData TypeDescription
Metrics StoredLong

Number of Edge Node or Device level tag change events stored. For Disk_Backed History Store, this tag is updated every 30 seconds

Records StoredLong

Number of Edge Node or Device level records stored. For Disk_Backed History Store, this tag is updated every 30 seconds

Metrics Percentage UsedFloat(Deprecated 4.0.19) Number of Edge Node or Device level tag change events stored as a percentage of the configured Edge Node or Device Tag Capacity
Records Percentage UsedFloat(Deprecated 4.0.19) Number of Edge Node or Device level tag change events stored as a percentage of the configured Edge Node or Device Record Capacity

...