63 lines
4.6 KiB
Markdown
63 lines
4.6 KiB
Markdown
# Capability: Агрегация health-состояния приложения
|
||
|
||
## Purpose
|
||
|
||
Агрегировать текущий health приложения из runtime, workers и health contributors.
|
||
|
||
## Границы
|
||
|
||
- В capability входят агрегация lifecycle приложения, состояний workers и health contributors, расчёт общего статуса и формирование отчёта.
|
||
|
||
## Requirements
|
||
|
||
### Requirement: Агрегация health-состояния
|
||
|
||
**ID:** `HL.AG-01`
|
||
|
||
Health aggregator SHALL формировать единый отчёт по lifecycle приложения и текущему состоянию компонентов.
|
||
|
||
#### Scenario: Получение health-отчёта
|
||
|
||
##### Участники
|
||
|
||
- Приложение, runtime, workers и health contributors.
|
||
|
||
##### Предусловия
|
||
|
||
- Каждый worker и contributor предоставляет состояние по health-контракту.
|
||
|
||
##### Основной поток
|
||
|
||
1. Собираем состояния runtime и компонентов — aggregator формирует отчёт по [HL.AG-01.FR-01](#hlag-01fr-01-состав-и-приоритет-статусов).
|
||
2. Рассчитываем общий статус и завершаем с `HEALTH_REPORT_CREATED` по [HL.AG-01.FR-02](#hlag-01fr-02-результат-агрегации).
|
||
|
||
##### Альтернативы и ошибки
|
||
|
||
- Входной статус не соответствует контракту — возвращаем `HEALTH_INPUT_INVALID` по [HL.AG-01.FR-02](#hlag-01fr-02-результат-агрегации).
|
||
|
||
##### Результат
|
||
|
||
Приложение получает единый статус и детализацию состояния каждого запущенного worker.
|
||
|
||
##### Коды завершения
|
||
|
||
| Код | Смысл | Связанные FR |
|
||
| --- | --- | --- |
|
||
| `HEALTH_REPORT_CREATED` | Отчёт сформирован из валидных состояний | [HL.AG-01.FR-02](#hlag-01fr-02-результат-агрегации) |
|
||
| `HEALTH_INPUT_INVALID` | Состояние не соответствует health-контракту | [HL.AG-01.FR-02](#hlag-01fr-02-результат-агрегации) |
|
||
|
||
#### Функциональные требования
|
||
|
||
##### HL.AG-01.FR-01: Состав и приоритет статусов
|
||
|
||
Worker сообщает status, critical, detail и meta через health-контракт. Отчёт содержит application_id, lifecycle приложения и состояния каждого запущенного worker/contributor. Worker с `disabled: true` исключён из набора ожидаемых компонентов и не ухудшает health. Статусы упорядочены как `ok < degraded < unhealthy`; применяется худший итоговый статус. Для критичного компонента учитывается переданный status. Для некритичного компонента `unhealthy` ограничивается до `degraded`; отсутствие некритичного worker также даёт не ниже `degraded`. Отсутствующий критичный worker даёт `unhealthy`. Lifecycle `new` и `failed` даёт `unhealthy`, `starting` и `stopping` — не ниже `degraded`. Когда lifecycle приложения `stopped`, общий health status — `stopped` независимо от прежних статусов компонентов.
|
||
|
||
##### HL.AG-01.FR-02: Результат агрегации
|
||
|
||
Health-статус является данными. Валидные агрегированные `ok`, `degraded`, `unhealthy` и `stopped` возвращаются в отчёте; `stopped` обозначает lifecycle приложения, а статусы запущенных worker/contributor остаются `ok`, `degraded` или `unhealthy`. Ошибка появляется только при нарушении контракта входного состояния.
|
||
|
||
| Код | Текст сообщения | Дальнейшее поведение |
|
||
| --- | --- | --- |
|
||
| `HEALTH_REPORT_CREATED` | Сообщение отсутствует | Отчёт возвращается вызывающему коду для представления клиенту |
|
||
| `HEALTH_INPUT_INVALID` | Сообщение отсутствует; ошибка контракта передаётся вызывающему коду | Отчёт не формируется; приложение исправляет contributor |
|