Failover status
- Last UpdatedApr 16, 2025
- 1 minute read
- PI System
- Adapter for OPC UA 1.6
- Adapters
The Diagnostics.Failover.FailoverStatus dynamic type includes the following values, which are logged in a stream with the IdFailover.FailoverStatus. This diagnostic stream contains system level information related to the failover status of the adapter.
|
Property |
Type |
Description |
|---|---|---|
|
timestamp |
string |
Timestamp of event. |
|
FailoverScore |
float |
Value between 0 and 100 indicating the adapter's overall connectivity to each data source. 100 is 'Good' and all data source connections are successful. 0 is 'Bad' and no data is being collected. |
|
FailoverRole |
string |
Current role of the failover instance. When the adapter assumes the Primary role, it is egressing data. If the adapter is set to the Secondary role, it does not egress data to the failover endpoint, but it may retain a cache of data if the failover mode is set to Hot. |
The failover score is determined by considering the status of individual adapter components and the total number of streams each component is set up to collect.
For instance, let's take an example where there are four components, each configured to handle 1000 streams:
-
When all components are functioning correctly, the failover score is at its maximum, which is 100.
-
If one of these components experiences a loss of connection to its data source, the failover score drops to 75.
-
In the worst-case scenario where all components lose their connections to their respective data sources, the failover score reaches its minimum value, which is 0.