Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

PI Universal Interface UniInt Framework

Performance counter points

  • Last UpdatedApr 03, 2023
  • 5 minute read

To archive performance counter data in Data Archive, install PI Performance Monitor Interface and create performance points for the interface using PI ICU.

In addition to interface-specific counters, the following performance counters are associated with UniInt-based interfaces for which counters are enabled.

Counter Name

Description

Device Scan Time (milliseconds)

Time in milliseconds to gather data from data source. Does not include the amount of time to write the values to Data Archive. There is one "Device Scan Time" counter per scan class. Applies to scan classes only. Does not apply to the instance (_Total).

Device Actual Connections

The actual number of data sources currently connected to the interface instance and working properly.

Device Expected Connections

Total number of data sources that the interface is expected to be communicating with at runtime. Only applies to the instance ( _Total).

Device Status

Stores communication information about the interface and the connection to the data source. The device status performance counter indicates status using the following values:

  • 0: Interface working properly, reading/writing data

  • 10: Connected to data source, not receiving data

  • 30 to 79: Interface-specific statuses

  • 50: UniInt failover is in a state where the backup interface may take over if needed after a certain period of time. 10 minutes is the default, but can be configured using the location5 attribute of the active ID point.

  • 90: Starting interface, not connected to data source

  • 95: Communication error with data source

  • 99: Shutting down the interface

    Only applies to the instance (_Total).

Failover Status

Stores the failover state of the interface when configured for UniInt failover. Contains 0 if the interface is primary, 1 if backup.

Interface heartbeat

The heartbeat of the interface. Default: once a second. Set to the highest frequency scan rate, between once a second and once a minute. Uses default if no scan classes are defined. Only applies to the instance (_Total).

Interface up-time (seconds)

The number of seconds since the interface has started. This counter is incremented once a second. Only applies to the instance (_Total).

IO Rate (events/second)

The number of events per second received by the interface. If this counter is viewed from the Windows performance monitor, increase the update time of the performance monitor to the minimum scan period for the interface. For example, if the minimum scanning period for the interface is 5 seconds (/f=5), set the update rate of the performance monitor to 5 seconds by selecting the Chart command from the Options menu. On the window, change the periodic update time to 5 seconds. If the update time is left at 1 second, the IO Rate appears to go to zero between scans because no events are received between scans. Only applies to instance (_Total).

Log file message count

Number of messages that have been written to the log file. Only applies to the instance (_Total).

PI Status

Status of the connection to Data Archive. If the connection is GOOD the value is 0. If the connection is anything other than GOOD the value is 1. Only applies to the instance (_Total).

Points added to the interface

Number of points that have been added to the interface. Only applies to the instance (_Total).

Point edited in the interface

Number of point edits that have occurred. Only applies to the instance (_Total).

Point Count

Number of points loaded by the interface. Does not include UniInt-controlled points such as health points or failover points. Applies to both instance (_Total) and scan classes.

Points Good

Number of points that have sent a GOOD current value to Data Archive. If the last value sent to Data Archive is a system digital state value, or the last value sent to Data Archive is older than the Stale timeout, the point is not counted in the Points Good count. This value equals Point Count when all points are updating with a GOOD current value. Only applies to instance (_Total).

Points In Error

Number of points that have sent a system digital state value as the current value to Data Archive. The total number of Points In Error, Points Good and Points Stale equals the Point Count. Only applies to the instance (_Total).

Points removed from the interface

Number of points that have been removed from the interface. Only applies to the instance (_Total).

Points Stale 10(min)

Points Stale 30(min)

Points Stale 60(min)

Points Stale 240(min)

Number of points that have not received a new value in the last 10, 30, 60 or 240 minutes. If a point had a GOOD current value that is now stale, the Stale count goes up and the Points Good count goes down. Only good points go stale; points in error do not. Only applies to the instance (_Total).

Scan Time (milliseconds)

Time in milliseconds to collect values from data source. One "Scan Time" counter per scan class. Does not apply to the instance. Applies to scan classes only.

Scheduled Scans: % Missed

Percentage of missed scans since starting the interface. If a scan occurs more than one second after its scheduled time, the scan is considered missed. One "Missed Scans" counter per scan class. Applies to both instance (_Total) and scan classes.

Scheduled Scans, % Skipped

Percentage of skipped scans since starting the interface. If a scan occurs one scan period or more after its scheduled time, those scans are considered skipped. One "Skipped Scans" counter per scan class. Applies to both instance (_Total) and scan classes.

Scheduled Scans: Scan count this interval

The total number of scans in the current performance interval. This total is the current sample size that is used to evaluate the % Missed Scans and the % Skipped scans. The performance interval is 8 hours by default, and can be changed using PI ICU (Debug tab) or by setting the perf command-line parameter. The minimum performance interval is 60 seconds. When the performance interval is exceeded, the previous samples are discarded and sampling starts again. Applies to both instance (_Total) and scan classes.

Standard deviation above mean

The quantity calculated to indicate the extent of deviation for input and output data for each heartbeat interval above the average of the values. This calculation accounts for up to 30 days of history. Only applies to instance (_Total).

Standard deviation below mean

The quantity calculated to indicate the extent of deviation for input and output data for each heartbeat interval below the average of the values. This calculation accounts for up to 30 days of history. Only applies to instance (_Total).

TitleResults for “How to create a CRG?”Also Available in