Мониторинг: справочник зоны — в набор документов #122
Assignees
ddmitry (Dmitry Dementiev)
Clear assignees
ddmitry (Dmitry Dementiev)
No Assignees
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: ddmitry/clickstream-data-platform#122
Reference in new issue
Block a user
Closes #121.
Зачем
docs/architecture/monitoring.mdвырос до 1506 слов, и половина из них былапро один дашборд «Данные». #116 приносит ещё два дашборда, #117 — правила
оповещения и
system.text_log: описание самой зоны утонуло бы. Режем до #116,чтобы его исполнитель клал свой файл в готовую раскладку.
Что
Три коммита, каждый читается отдельно.
0011:
monitoring/README.md— зона (состав, цели Prometheus, источники Grafana,доступ к ClickHouse, каталог дашбордов),
monitoring/data.md— устройстводашборда «Данные». Обе входящие ссылки перенацелены:
README.mdрепозитория и ADR 0002.
лежали два разных прогона — пола из #114 и дашборда из #115; следующие
дашборды копили бы там осадок.
data.json(4 строки из 6 дословно) — остались только источники. Заголовок«Чтецов Kafka панели не читают» называл запрещённое действие в самой
заметной строке — назван по тому, что панели делают, а
kafka_commit_on_selectостался внутри как причина. Довод про отвергнутыеспособы счёта сходимости стоял в двух местах — в записи о приёмке остался
замер без пересказа довода.
Слов было 1506, стало 1500 — резали не объём, а раскладку и повторы.
Что не вошло
Раздел «Структура» в
AGENTS.mdне тронут: правило про подпапку крупногокомпонента там уже записано общим, второй пример к нему ничего не добавляет.
Ссылка на
monitoring.mdв теле #116 поправлена в трекере.Проверка
make config-testиmake lintзелёные. Обе входящие ссылки открыты руками,битых ссылок на
monitoring.mdв репозитории не осталось (grep). Дашбордdata.jsonне менялся — стенд трогать незачем.- Зачем: - половина справочника была про один дашборд «Данные», а этап приносит ещё два дашборда и правила оповещения: описание самой зоны утонуло бы. - Что: - заведён набор docs/architecture/monitoring/ по ADR 0011: README.md — зона и каталог дашбордов, data.md — устройство дашборда «Данные». - обе входящие ссылки перенацелены: README.md репозитория и ADR 0002. - Проверка: - make config-test; ссылки из README.md и ADR 0002 открываются.- Зачем: - в общем разделе «Что проверено» лежали два разных прогона, пола и дашборда; следующие дашборды копили бы там осадок. - Что: - запись о приёмке дашборда «Данные» перенесена в data.md, в README.md осталась приёмка самой зоны. - Проверка: - make config-test.- Зачем: - таблица панелей дублировала заголовки из data.json и уже правилась дважды; заголовок раздела называл запрещённое действие вместо нужного; довод про отвергнутые способы счёта сходимости стоял в двух местах. - Что: - в таблице панелей остались только источники, вопрос панели читается с её заголовка на экране. - раздел про чтецов Kafka назван по тому, что панели делают, опасность kafka_commit_on_select осталась внутри как причина. - из записи о приёмке убран пересказ довода, замер оставлен. - Проверка: - make config-test; make lint.- Зачем: - проход на вычитание: каталог дашбордов появился в этом же PR, и абзац «что здесь есть» стал называть «Данные» второй раз. - Что: - вводный абзац отсылает к каталогу, а имя дашборда и состав панелей остались только в самом каталоге. - Проверка: - make config-test.- Зачем: - «что скребёт Prometheus» — калька со scrape, по-русски звучит коряво; рядом нашлись ошибка падежа и пара фраз, которые читаются с запинкой. - Что: - заголовок набора и раздел названы по-русски: «за чем следит» и «кого опрашивает Prometheus». - «Единицы общие — сообщений за интервал» исправлено на именительный падеж. - разбиты две перегруженные фразы: про место диагностики версий и про то, что читать на панели сходимости. - Проверка: - make config-test.