Мониторинг: справочник зоны — в набор документов, дашборд «Данные» — своим файлом #121

New Issue

2026-08-21T20:57:32+03:00

ddmitry commented

2026-08-21 20:57:32 +03:00

Part of #11.

Цель

docs/architecture/monitoring.md — 1506 слов, и половина из них про один
дашборд «Данные». #116 приносит ещё два дашборда, #117 — правила оповещения и
system.text_log: описание самой зоны утонет раньше, чем кончится этап.
Резать надо до #116, чтобы его исполнитель клал свой файл в готовую раскладку,
а не переделывал чужую.

Что войдёт

Набор документов по ADR 0011
— индекс и файл на каждую часть устройства:

docs/architecture/monitoring/
├── README.md   ← зона: состав, что скребёт Prometheus, источники Grafana,
│                 доступ к ClickHouse, куда кладутся дашборды, указатели
└── data.md     ← дашборд «Данные» целиком, вместе со своей приёмкой

Приёмка переезжает следом за своим предметом: сейчас в разделе «Что проверено»
лежат два разных прогона — пола из #114 и дашборда из #115, — и #116 добавил бы
третий слой осадка.

Плюс три правки текста, найденные проходом оптикой writing-for-agents:

Таблица шести панелей повторяет заголовки панелей из data.json (4
строки из 6 — дословно). Цена уже проявилась: столбец паузы в панели слепка
правился дважды, в JSON и в таблице. Оставить карту шести панелей на один
экран, колонки-повторы снять.
Заголовок «Чтецов Kafka панели не читают» называет запрещённое действие
в самой заметной строке. Переписать положительно; опасность
(kafka_commit_on_select у чтеца заказов) остаётся внутри как причина.
Довод про отвергнутые способы счёта сходимости записан дважды —
развёрнуто в «Как считается сходимость» и пересказом в «Что проверено».
Замер оставить, пересказ довода снять.

Границы

Работа редакторская: фактов не добавлять, решений не пересматривать.
Отвергнутые способы счёта сходимости и отсутствие ряда «против вчерашнего» —
решения #115, они записаны и остаются.
cluster.md и queries.md кладёт #116 — здесь их не заводить.
infra/grafana/provisioning/dashboards/data.json не трогать.
Раздел «Структура» в AGENTS.md правки не требует: правило про подпапку
крупного компонента там уже общее, второй пример к нему ничего не добавит.

Сначала прочитать

ADR 0011 — почему набор,
а не один файл;
docs/architecture/orders/README.md — образец индекса набора.

Проверка

make config-test; входящие ссылки открываются.

Заведён docs/architecture/monitoring/: README.md — зона, data.md —
дашборд «Данные». Файла docs/architecture/monitoring.md больше нет.
Обе входящие ссылки перенацелены и ведут в живое место: README.md
репозитория и docs/adr/0002-monitoring-scope.md.
Приёмка дашборда лежит в data.md, приёмка пола — в README.md.
Таблица панелей не повторяет заголовки панелей из data.json.
Про чтецов Kafka сказано положительно — что панели читают, а не что им
запрещено.
Довод про отвергнутые способы счёта сходимости записан один раз.

Part of #11. ## Цель `docs/architecture/monitoring.md` — 1506 слов, и половина из них про один дашборд «Данные». #116 приносит ещё два дашборда, #117 — правила оповещения и `system.text_log`: описание самой зоны утонет раньше, чем кончится этап. Резать надо до #116, чтобы его исполнитель клал свой файл в готовую раскладку, а не переделывал чужую. ## Что войдёт Набор документов по [ADR 0011](../src/branch/main/docs/adr/0011-component-docs.md) — индекс и файл на каждую часть устройства: ``` docs/architecture/monitoring/ ├── README.md ← зона: состав, что скребёт Prometheus, источники Grafana, │ доступ к ClickHouse, куда кладутся дашборды, указатели └── data.md ← дашборд «Данные» целиком, вместе со своей приёмкой ``` Приёмка переезжает следом за своим предметом: сейчас в разделе «Что проверено» лежат два разных прогона — пола из #114 и дашборда из #115, — и #116 добавил бы третий слой осадка. Плюс три правки текста, найденные проходом оптикой `writing-for-agents`: 1. **Таблица шести панелей повторяет заголовки панелей** из `data.json` (4 строки из 6 — дословно). Цена уже проявилась: столбец паузы в панели слепка правился дважды, в JSON и в таблице. Оставить карту шести панелей на один экран, колонки-повторы снять. 2. **Заголовок «Чтецов Kafka панели не читают»** называет запрещённое действие в самой заметной строке. Переписать положительно; опасность (`kafka_commit_on_select` у чтеца заказов) остаётся внутри как причина. 3. **Довод про отвергнутые способы счёта сходимости записан дважды** — развёрнуто в «Как считается сходимость» и пересказом в «Что проверено». Замер оставить, пересказ довода снять. ## Границы - Работа редакторская: фактов не добавлять, решений не пересматривать. Отвергнутые способы счёта сходимости и отсутствие ряда «против вчерашнего» — решения #115, они записаны и остаются. - `cluster.md` и `queries.md` кладёт #116 — здесь их не заводить. - `infra/grafana/provisioning/dashboards/data.json` не трогать. - Раздел «Структура» в `AGENTS.md` правки не требует: правило про подпапку крупного компонента там уже общее, второй пример к нему ничего не добавит. ## Сначала прочитать - [ADR 0011](../src/branch/main/docs/adr/0011-component-docs.md) — почему набор, а не один файл; - `docs/architecture/orders/README.md` — образец индекса набора. ## Проверка `make config-test`; входящие ссылки открываются. - [x] Заведён `docs/architecture/monitoring/`: `README.md` — зона, `data.md` — дашборд «Данные». Файла `docs/architecture/monitoring.md` больше нет. - [x] Обе входящие ссылки перенацелены и ведут в живое место: `README.md` репозитория и `docs/adr/0002-monitoring-scope.md`. - [x] Приёмка дашборда лежит в `data.md`, приёмка пола — в `README.md`. - [x] Таблица панелей не повторяет заголовки панелей из `data.json`. - [x] Про чтецов Kafka сказано положительно — что панели читают, а не что им запрещено. - [x] Довод про отвергнутые способы счёта сходимости записан один раз.

ddmitry added the ready-for-agent label 2026-08-21 20:57:32 +03:00

ddmitry referenced this issue

2026-08-21 20:57:42 +03:00

Этап 9: мониторинг и runbook keeper #11

ddmitry referenced a pull request that will close this issue

2026-08-21 21:02:06 +03:00

Мониторинг: справочник зоны — в набор документов #122

ddmitry closed this issue

2026-08-21 21:19:05 +03:00

Sign in to join this conversation.