Отчёт о проверке нужен тому, кто будет чинить, и в нём четыре обязательные части.
Хороший отчёт называет, откуда проверяли, полный адрес запроса, команду и что она напечатала. По нему коллега повторит проверку и увидит то же самое.
| В отчёте | Пример |
|---|---|
| откуда | клиент lab-client |
| что и как | curl -fsS --max-time 3 http://192.0.2.10:8080/health |
| что напечатал | curl: (22) … error: 503 |
| вывод | соединение есть, приложение не готово |
«Сайт не работает» теряет всё это: непонятно, был отказ, тайм-аут или ответ с ошибкой.
Ты проверил /health и передаёшь задачу коллеге. Какая запись поможет ему больше?
-
Не сказано, откуда проверяли, какой адрес и что напечатал
curl: коллега не повторит проверку. -
Раз пришёл ответ
503, соединение установилось — сеть работает. -
Сервер ответил статусом
503, значит он работает. Упавший сервер дал бы отказ или тайм-аут.
Запись называет, откуда проверяли, что спросили и что получили, и по ней видно этап — ответ приложения. Коллега повторит ту же проверку и начнёт с приложения.
Главное в шаге
- В отчёте — откуда проверяли, полный адрес, команда и её вывод.
- По выводу видно этап: отказ, тайм-аут или ответ приложения.