Subscription Diagnostic Items
- Last UpdatedSep 06, 2017
- 2 minute read
The subscription object contains diagnostic information for a specific subscription. The following syntax can be used to access a subscription diagnostic item
$SYS$DIAG/Conn=<ConnIndex>:<SubIndex>/<Item>
where:
-
<ConnIndex> is a connection index in the range 0 to n. ConnIndex is always 0 in case of OI Gateway
-
<SubIndex> is a subscription index in the range of 0 to n
-
<Item> is one of the diagnostic item names from the following table.
If the <ConnIndex> or <SubIndex> does not exists, then 0 will be updated for item of type Integer/Float and "" (blank) will updated for item of type string. Quality of these items will stay as Good.
|
<Item> |
Type |
R/W |
Description |
|
Enabled |
BOOL |
R |
Monitored item publishing enabled when true |
|
PublishInterval |
Int64 |
R |
Monitored item publish rate for this subscription in ms |
|
TotalPublishes |
Int32 |
R |
Total number of publishes since subscription creation |
|
TotalUpdates |
Int32 |
R |
Total number of publish values since subscription creation |
|
ActiveItemCount |
Int32 |
R |
Number of active items in this subscription |
|
LastPublishDuration |
Int32 |
R |
Duration in milliseconds of Last Publish in this subscription |
|
E.g. If MaxNotificationPerPublish is 2000 then it 5 Publish() calls to update 9000 values. In this case LastPublishDuration will be total duration to update 9000 items, after which PublishComplete code is returned to the client. |
|||
|
MaxQueueSize |
Int64 |
R |
Max queue size configured in this subscription |
|
MonitoredItemCount |
Int32 |
R |
Number of monitored items this subscription |
|
MonitoredItemErrCount |
Int32 |
R |
Number of monitored items with bad quality in this subscription |
|
PublishQueueSize |
Int32 |
R |
Current number of monitored item values queued and pending to be published to the subscribing client |
|
PublishQueueOverruns |
Int32 |
R |
Number of queue overruns occurrences since subscription creation or last reset. These counter increments by 1 if 1 or more item values are folded at a point in time |
|
ResetTotals |
BOOL |
R/W |
Reset TotalPublishes, TotalUpdates and PublishQueueOverruns |