Interface Diagnostics Configuration

Interface Diagnostics Configuration

Some of the points that follow refer to a “performance summary interval”. This interval is 8 hours by default. You can change this parameter via the Scan performance summary box in the UniInt – Debug parameter category page:

Scan Class Performance Points

You configure one Scan Class Performance Point for each scan class in this interface. From the ICU, select this interface from the Interface drop-down list and click UniIntPerformance Points in the parameter category pane:

Rightclick the row for a particular Scan Class # to open the shortcut menu:

You need not restart the interface for it to write values to the Scan Class Performance Points.

To see the current values (snapshots) of the Scan Class Performance Points, rightclick and select Refresh Snapshots.

Create / Create All

Delete

Correct / Correct All

The Performance Points are created with the following PI attribute values:

Attribute	Details
Tag	Tag name that appears in the list box
Point Source	Point Source for tags for this interface, as specified on the first tab
Compressing	Off
Excmax	0
Descriptor	Interface name + “ Scan Class # Performance Point”

Rename

Column descriptions

Status

Scan Class #

Tagname

PS

Location1

ExDesc

Snapshot

Performance Counters Points

the amount of time that the interface has been running;

the number of points the interface has added to its point list;

the number of tags that are currently updating among others

There are two types or instances of Performance Counters that can be collected and stored in PI Points. The first is (_Total) which is a total for the Performance Counter since the interface instance was started. The other is for individual scan classes (Scan Class x) where x is a particular scan class defined for the interface instance that is being monitored.

OSIsoft’s PI Performance Monitor interface is capable of reading these performance values and writing them to PI points. Please see the Performance Monitor Interface for more information.

If there is no PI Performance Monitor Interface registered with the ICU in the Module Database for the PI Server the interface is sending its data to, you cannot use the ICU to create any interface instance’s Performance Counters Points:

After installing the PI Performance Monitor Interface as a service, select this interface instance from the Interface drop-down list, then click Performance Counters in the parameter categories pane, and rightclick on the row containing the Performance Counters Point you wish to create. This will open the shortcut menu:

Click Create to create the Performance Counters Point for that particular row. Click Create All to create all the Performance Counters Points listed which have a status of Not Created.

To see the current values (snapshots) of the created Performance Counters Points, rightclick on any row and select Refresh Snapshots.

Note: The PI Performance Monitor Interface – and not this interface – is responsible for updating the values for the Performance Counters Points in PI. So, make sure that the PI Performance Monitor Interface is running correctly.

Performance Counters

“PerformanceCounterName” (.PerformanceCounterPointSuffix)

The tagname created by the ICU for each Performance Counter point is based on the setting found under the Tools  Options  Naming Conventions  Performance Counter Points. The default for this is “sy.perf.[machine].[if service] followed by the Performance Counter Point suffix.

Performance Counters for both (_Total) and (Scan Class x)

“Point Count” (.point_count)

The .point_count Performance Counters Point indicates the number of PI Points per scan class or the total number for the interface instance. This point is similar to the Health Point [UI_SCPOINTCOUNT] for scan classes and [UI_POINTCOUNT] for totals.

The ICU uses a naming convention such that the tag containing "(Scan Class 1)" (for example, "sy.perf.etamp390.E1(Scan Class 1).point_count") refers to scan class 1, “(Scan Class 2)” refers to scan class 2, and so on. The tag containing "(_Total)" refers to the sum of all scan classes.

“Scheduled Scans: % Missed” (.sched_scans_%missed)

The .sched_scans_%missed Performance Counters Point indicates the percentage of scans the interface missed per scan class or the total number missed for all scan classes since startup. A missed scan occurs if the interface performs the scan one second later than scheduled.

The ICU uses a naming convention such that the tag containing “(Scan Class 1)” (for example, "sy.perf.etamp390.E1(Scan Class 1).sched_scans_%missed") refers to scan class 1, “(Scan Class 2)” refers to scan class 2, and so on. The tag containing “(_Total)” refers to the sum of all scan classes.

“Scheduled Scans: % Skipped” (.sched_scans_%skipped)

The .sched_scans_%skipped Performance Counters Point indicates the percentage of scans the interface skipped per scan class or the total number skipped for all scan classes since startup. A skipped scan is a scan that occurs at least one scan period after its scheduled time. This point is similar to the [UI_SCSKIPPED] Health Point.

The ICU uses a naming convention such that the tag containing "(Scan Class 1)" (for example, "sy.perf.etamp390.E1(Scan Class 1).sched_scans_%skipped") refers to scan class 1, "(Scan Class 2)" refers to scan class 2, and so on. The tag containing "(_Total)" refers to the sum of all scan classes.

“Scheduled Scans: Scan count this interval” (.sched_scans_this_interval)

The .sched_scans_this_interval Performance Counters Point indicates the number of scans that the interface performed per performance summary interval for the scan class or the total number of scans performed for all scan classes during the summary interval. This point is similar to the [UI_SCSCANCOUNT] Health Point.

Performance Counters for (_Total) only

“Device Actual Connections” (.Device_Actual_Connections)

“Device Expected Connections” (.Device_Expected_Connections)

“Device Status” (.Device_Status)

“Failover Status” (.Failover_Status)

“Interface up-time (seconds)” (.up_time)

“IO Rate (events/second)” (.io_rates)

“Log file message count” (.log_file_msg_count)

“PI Status” (PI_Status)

“Points added to the interface” (.pts_added_to_interface)

“Points edited in the interface”(.pts_edited_in_interface)

“Points Good” (.Points_Good)

“Points In Error” (.Points_In_Error)

“Points removed from the interface” (.pts_removed_from_interface)

“Points Stale 10(min)” (.Points_Stale_10min)

“Points Stale 30(min)” (.Points_Stale_30min)

“Points Stale 60(min)” (.Points_Stale_60min)

“Points Stale 240(min)” (.Points_Stale_240min)

Performance Counters for (Scan Class x) only

“Device Scan Time (milliseconds)” (.Device_Scan_Time)

The .Device_Scan_Time Performance Counters Point indicates the number of milliseconds the interface takes to read the data from the foreign device and package the data to send to PI. This counter does not include the amount of time to send the data to PI. This point is similar to the [UI_SCINDEVSCANTIME] Health Point.

The ICU uses a naming convention such that the tag containing “(Scan Class 1)” (for example, "sy.perf.etamp390.E1 (Scan Class 1).device_scan _time") refers to scan class 1, “(Scan Class 2) refers to scan class 2, and so on.

“Scan Time (milliseconds)” (.scan_time)

The .scan_time Performance Counter Point indicates the number of milliseconds the interface takes to both read the data from the device and send the data to PI. This point is similar to the [UI_SCINSCANTIME] Health Point.

The ICU uses a naming convention such that the tag containing “(Scan Class 1)” (for example, "sy.perf.etamp390.E1(Scan Class 1).scan_time") refers to scan class 1, “(Scan Class 2)” refers to scan class 2, and so on.