Skip to content

Commit d750d0b

Browse files
Add status transition counter properties
1 parent d37e4f5 commit d750d0b

5 files changed

+24
-0
lines changed

docs/Overview.md

+24
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,26 @@ The `statusReportingDelay` property allows clients to customize the reporting de
7373
|:--:|
7474
| _**Status reporting delay example**_ |
7575

76+
### Sender status transition counters
77+
78+
All sender specific domain statuses have an associated status transition counter property. These increment each time the associated status transitions to a worse state. Transitions to/from neutral states like `Inactive` or `NotUsed` are ignored.
79+
80+
The intention is that these properties store historical negative trend transitions for each status.
81+
82+
The list of all status transition counter properties is:
83+
84+
* linkStatusTransitionCounter
85+
* transmissionStatusTransitionCounter
86+
* externalSynchronizationStatusTransitionCounter
87+
* essenceStatusTransitionCounter
88+
89+
Devices MUST be able to reset ALL status transition counter properties in the following two ways:
90+
91+
* When a sender activation occurs
92+
* When a client invokes the `ResetStatusTransitionCounters` method
93+
94+
The `autoResetStatusTransitionCounters` property allows clients to configure if ALL status transition counter properties automatically reset with each Sender activation (by default devices MUST have this enabled). If this is enabled, senders MUST reset ALL status transition counter properties to 0 after each activation. Devices MUST allow setting the `autoResetStatusTransitionCounters` property to a value of `true` and MAY allow setting the property to `false`. This supports use cases where users do not want to reset automatically after each activation.
95+
7696
### Sender overall status
7797

7898
The purpose of the overallStatus is to abstract and combine the specific domain statuses of a monitor into a single status which can be more easily observed and displayed by a simple client.
@@ -96,8 +116,10 @@ Devices MUST follow the rules listed below when mapping specific domain statuses
96116
* Properties
97117
* linkStatus
98118
* linkStatusMessage
119+
* linkStatusTransitionCounter
99120
* transmissionStatus
100121
* transmissionStatusMessage
122+
* transmissionStatusTransitionCounter
101123
* autoResetErrorCounters
102124
* Methods
103125
* GetTransmissionErrorCounters
@@ -164,6 +186,7 @@ Devices that do not have the capability to detect transmission errors MUST:
164186
* Properties
165187
* externalSynchronizationStatus
166188
* externalSynchronizationStatusMessage
189+
* externalSynchronizationStatusTransitionCounter
167190
* synchronizationSourceId
168191
* synchronizationSourceChanges
169192
* Methods
@@ -228,6 +251,7 @@ When devices do not use external synchronization they MUST:
228251
* Properties
229252
* essenceStatus
230253
* essenceStatusMessage
254+
* essenceStatusTransitionCounter
231255

232256
| ![Sender essence validation](images/sender-model-essence-validation.png) |
233257
|:--:|
-4.38 KB
Loading
-6.74 KB
Loading

docs/images/sender-model-minimal.png

-6.03 KB
Loading
-454 Bytes
Loading

0 commit comments

Comments
 (0)