Copilot commented on code in PR #13581:
URL: https://github.com/apache/skywalking/pull/13581#discussion_r2536989670
##########
docs/en/setup/backend/backend-alarm.md:
##########
@@ -523,15 +524,16 @@ stateDiagram-v2
[*] --> NORMAL
NORMAL --> FIRING: Expression true<br/>not in silence period
- FIRING --> SILENCED: Expression true<br/>in silence period
+ FIRING --> SILENCED_FIRING: Expression true<br/>in silence period
FIRING --> OBSERVING_RECOVERY: Expression false<br/>in recovery window
FIRING --> RECOVERED: Expression false<br/>not in recovery window
OBSERVING_RECOVERY --> FIRING: Expression true<br/>not in silence period
+ OBSERVING_RECOVERY --> SILENCED_FIRING: Expression true<br/>in silence
period
OBSERVING_RECOVERY --> RECOVERED: Expression false<br/>not in recovery
window
- SILENCED --> RECOVERED: Expression false<br/>not in recovery window
- SILENCED --> OBSERVING_RECOVERY: Expression false<br/>in recovery window
+ SILENCED_FIRING --> RECOVERED: Expression false<br/>not in recovery window
and not in silence period
+ SILENCED_FIRING --> OBSERVING_RECOVERY: Expression false<br/>in recovery
window
Review Comment:
The transition condition is incomplete. According to the code logic (lines
537-541 in RunningRule.java), the transition from SILENCED_FIRING to
OBSERVING_RECOVERY happens when expression is false AND
(recoveryObservationCountdown >= 0 OR silenceCountdown >= 0). The current
description "in recovery window" only covers the recoveryObservationCountdown
>= 0 case but misses the silenceCountdown >= 0 case. It should be "in recovery
window or in silence period".
```suggestion
SILENCED_FIRING --> OBSERVING_RECOVERY: Expression false<br/>in recovery
window or in silence period
```
##########
docs/en/setup/backend/backend-alarm.md:
##########
@@ -523,15 +524,16 @@ stateDiagram-v2
[*] --> NORMAL
NORMAL --> FIRING: Expression true<br/>not in silence period
- FIRING --> SILENCED: Expression true<br/>in silence period
+ FIRING --> SILENCED_FIRING: Expression true<br/>in silence period
FIRING --> OBSERVING_RECOVERY: Expression false<br/>in recovery window
FIRING --> RECOVERED: Expression false<br/>not in recovery window
Review Comment:
The transition condition is incomplete. According to the code logic (line
537 in RunningRule.java), the transition from FIRING to RECOVERED happens when
expression is false AND recoveryObservationCountdown < 0 AND silenceCountdown <
0. The current description "not in recovery window" only covers the
recoveryObservationCountdown < 0 case but misses the silenceCountdown < 0
requirement. It should be "not in recovery window and not in silence period".
```suggestion
FIRING --> RECOVERED: Expression false<br/>not in recovery window and
not in silence period
```
##########
docs/en/status/query_alarm_runtime_status.md:
##########
@@ -233,8 +236,9 @@ Return the running context of the alarm rule.
`size` is the window size. Equal to the `period + additionalPeriod`.
`silenceCountdown` is the countdown of the silence period. -1 means silence
countdown is not running.
`recoveryObservationCountdown` is the countdown of the recovery observation
period.
-`windowValues` is the original metrics data. The `index` is the index of the
window, starting from 0.
-`mqeMetricsSnapshot` is the metrics data in the MQE format. When checking
conditions, these data will be calculated according to the expression.
+`windowValues` is the original metrics data when the metrics come in. The
`index` is the index of the window, starting from 0.
+`mqeMetricsSnapshot` is the metrics data in the MQE format which generated
when executing the checking.
Review Comment:
Grammar error: "which generated" should be "which is generated".
```suggestion
`mqeMetricsSnapshot` is the metrics data in the MQE format which is
generated when executing the checking.
```
##########
docs/en/setup/backend/backend-alarm.md:
##########
@@ -523,15 +524,16 @@ stateDiagram-v2
[*] --> NORMAL
NORMAL --> FIRING: Expression true<br/>not in silence period
- FIRING --> SILENCED: Expression true<br/>in silence period
+ FIRING --> SILENCED_FIRING: Expression true<br/>in silence period
FIRING --> OBSERVING_RECOVERY: Expression false<br/>in recovery window
Review Comment:
The transition condition is incomplete. According to the code logic (lines
537-541 in RunningRule.java), the transition from FIRING to OBSERVING_RECOVERY
happens when expression is false AND (recoveryObservationCountdown >= 0 OR
silenceCountdown >= 0). The current description "in recovery window" only
covers the recoveryObservationCountdown >= 0 case but misses the
silenceCountdown >= 0 case. It should be "in recovery window or in silence
period".
```suggestion
FIRING --> OBSERVING_RECOVERY: Expression false<br/>in recovery window
or in silence period
```
##########
docs/en/setup/backend/backend-alarm.md:
##########
@@ -523,15 +524,16 @@ stateDiagram-v2
[*] --> NORMAL
NORMAL --> FIRING: Expression true<br/>not in silence period
- FIRING --> SILENCED: Expression true<br/>in silence period
+ FIRING --> SILENCED_FIRING: Expression true<br/>in silence period
FIRING --> OBSERVING_RECOVERY: Expression false<br/>in recovery window
FIRING --> RECOVERED: Expression false<br/>not in recovery window
OBSERVING_RECOVERY --> FIRING: Expression true<br/>not in silence period
+ OBSERVING_RECOVERY --> SILENCED_FIRING: Expression true<br/>in silence
period
OBSERVING_RECOVERY --> RECOVERED: Expression false<br/>not in recovery
window
Review Comment:
The transition condition is incomplete. According to the code logic (line
544 in RunningRule.java), the transition from OBSERVING_RECOVERY to RECOVERED
happens when expression is false AND recoveryObservationCountdown < 0 AND
silenceCountdown < 0. The current description "not in recovery window" only
covers the recoveryObservationCountdown < 0 case but misses the
silenceCountdown < 0 requirement. It should be "not in recovery window and not
in silence period".
```suggestion
OBSERVING_RECOVERY --> RECOVERED: Expression false<br/>not in recovery
window and not in silence period
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
