docs(proto): send mirror_failed once per incident, not on failing to paused
- commit
- f5fe69a9987855bd37bc29e02ba938c76e439636
- author
- brice · · 2026-10-20 06:06 UTC
- committer
- brice · · 2026-10-20 07:06 UTC
- parent
- 6cfb42d
- signature
- GPG Verified
CD88F9E564E0102646FB6077A1A07C7C7C3E349D· arch-gpg Verified for the committer email
3 files · +7 -5
M docs/services.md +1 -1
| @@ -45,7 +45,7 @@ and sync with `force` to recover from authentication failures. Configuration can | |||
| 45 | 45 | be saved without `ERMITE_SECRETS_KEY`, but pushes cannot run without it. | |
| 46 | 46 | ||
| 47 | 47 | `EventService.Watch` adds `mirror_failed` (field 23, `MirrorFailed`) when a mirror | |
| 48 | - | enters failing or paused, including failing to paused, and `mirror_recovered` | |
| 48 | + | starts failing (ok or disabled to failing or paused, once per incident), and `mirror_recovered` | |
| 49 | 49 | (field 24, `MirrorRecovered`) when a failing or paused mirror succeeds again. | |
| 50 | 50 | These are transition events, not events for every attempt. They are delivered on | |
| 51 | 51 | `repo:<name>` and `home`, subject to repository visibility. Neither event carries | |
| @@ -45,7 +45,7 @@ and sync with `force` to recover from authentication failures. Configuration can | |||||
| 45 | be saved without `ERMITE_SECRETS_KEY`, but pushes cannot run without it. | 45 | be saved without `ERMITE_SECRETS_KEY`, but pushes cannot run without it. | ||
| 46 | 46 | ||||
| 47 | `EventService.Watch` adds `mirror_failed` (field 23, `MirrorFailed`) when a mirror | 47 | `EventService.Watch` adds `mirror_failed` (field 23, `MirrorFailed`) when a mirror | ||
| 48 | - | enters failing or paused, including failing to paused, and `mirror_recovered` | 48 | + | starts failing (ok or disabled to failing or paused, once per incident), and `mirror_recovered` |
| 49 | (field 24, `MirrorRecovered`) when a failing or paused mirror succeeds again. | 49 | (field 24, `MirrorRecovered`) when a failing or paused mirror succeeds again. | ||
| 50 | These are transition events, not events for every attempt. They are delivered on | 50 | These are transition events, not events for every attempt. They are delivered on | ||
| 51 | `repo:<name>` and `home`, subject to repository visibility. Neither event carries | 51 | `repo:<name>` and `home`, subject to repository visibility. Neither event carries | ||
M gen/ermite/event.pb.go +3 -2
| @@ -1702,8 +1702,9 @@ func (x *JobUpdated) GetJob() *RunJob { | |||
| 1702 | 1702 | return nil | |
| 1703 | 1703 | } | |
| 1704 | 1704 | ||
| 1705 | - | // MirrorFailed reports a transition into failing or paused, including failing | |
| 1706 | - | // to paused, not every failed attempt. Servers with feature "mirror" deliver it | |
| 1705 | + | // MirrorFailed reports the start of a failure incident: a transition from ok | |
| 1706 | + | // or disabled into failing or paused. It is sent once per incident, not for | |
| 1707 | + | // each failed attempt nor for failing to paused. Servers with feature "mirror" deliver it | |
| 1707 | 1708 | // on "repo:<name>" and "home", subject to repository visibility. It carries no | |
| 1708 | 1709 | // URL or error detail. | |
| 1709 | 1710 | type MirrorFailed struct { | |
| @@ -1702,8 +1702,9 @@ func (x *JobUpdated) GetJob() *RunJob { | |||||
| 1702 | return nil | 1702 | return nil | ||
| 1703 | } | 1703 | } | ||
| 1704 | 1704 | ||||
| 1705 | - | // MirrorFailed reports a transition into failing or paused, including failing | 1705 | + | // MirrorFailed reports the start of a failure incident: a transition from ok |
| 1706 | - | // to paused, not every failed attempt. Servers with feature "mirror" deliver it | 1706 | + | // or disabled into failing or paused. It is sent once per incident, not for |
| 1707 | + | // each failed attempt nor for failing to paused. Servers with feature "mirror" deliver it | |||
| 1707 | // on "repo:<name>" and "home", subject to repository visibility. It carries no | 1708 | // on "repo:<name>" and "home", subject to repository visibility. It carries no | ||
| 1708 | // URL or error detail. | 1709 | // URL or error detail. | ||
| 1709 | type MirrorFailed struct { | 1710 | type MirrorFailed struct { | ||
M proto/ermite/event.proto +3 -2
| @@ -312,8 +312,9 @@ message JobUpdated { | |||
| 312 | 312 | RunJob job = 1; | |
| 313 | 313 | } | |
| 314 | 314 | ||
| 315 | - | // MirrorFailed reports a transition into failing or paused, including failing | |
| 316 | - | // to paused, not every failed attempt. Servers with feature "mirror" deliver it | |
| 315 | + | // MirrorFailed reports the start of a failure incident: a transition from ok | |
| 316 | + | // or disabled into failing or paused. It is sent once per incident, not for | |
| 317 | + | // each failed attempt nor for failing to paused. Servers with feature "mirror" deliver it | |
| 317 | 318 | // on "repo:<name>" and "home", subject to repository visibility. It carries no | |
| 318 | 319 | // URL or error detail. | |
| 319 | 320 | message MirrorFailed { | |
| @@ -312,8 +312,9 @@ message JobUpdated { | |||||
| 312 | RunJob job = 1; | 312 | RunJob job = 1; | ||
| 313 | } | 313 | } | ||
| 314 | 314 | ||||
| 315 | - | // MirrorFailed reports a transition into failing or paused, including failing | 315 | + | // MirrorFailed reports the start of a failure incident: a transition from ok |
| 316 | - | // to paused, not every failed attempt. Servers with feature "mirror" deliver it | 316 | + | // or disabled into failing or paused. It is sent once per incident, not for |
| 317 | + | // each failed attempt nor for failing to paused. Servers with feature "mirror" deliver it | |||
| 317 | // on "repo:<name>" and "home", subject to repository visibility. It carries no | 318 | // on "repo:<name>" and "home", subject to repository visibility. It carries no | ||
| 318 | // URL or error detail. | 319 | // URL or error detail. | ||
| 319 | message MirrorFailed { | 320 | message MirrorFailed { | ||