Логгирование

docs/control.md

@@ -0,0 +1,65 @@
+# Логгирование и контроль за деградацией системы
+
+## Фронтенд
+
+Фронтэнд представлен на сервере только статическими файлами. Необходимо отслеживать только работоспособность nginx. 
+
+При текущих ресурсах и настройках деградация маловероятна, и возможно только, если сервер не обслуживать более года. 
+
+Достаточно следить за общей телеметрией сервера.
+
+## Бэкэнд
+
+Бэкэнд-сервис требует наблюдения.
+
+На данный момент наблюдение можно разделить на два направления:
+
+* Контроль логов и ошибок сервиса.
+* Общий контроль телеметрии сервера.
+
+### Контроль логов и ошибок сервиса
+
+Сервис ведет логирование по каждому микросервису в отдельности и общее на случай сбой узла.
+
+Логирование дублируется и ведется по разным уровням важности: 
+   * сообщения уровня информация, внимание, ошибка - пишутся в stdout и доступны из journalctl
+   * сообщения уровня внимание, ошибка - пишутся дополнительно в логи в папке сервиса
+
+Папки внутренних логов
+   * /home/services/profimall_api/logs/logs - общие ошибки
+   * /home/services/profimall_api/logs/* - по микросервисам в отдельности
+
+На данный момент достаточно просматривать логи из journalctl для profimall_api на предмет наличия ошибок в работе сервиса.
+Внутренние логи используются для поиска этой ошибки разработчиками.
+
+При необходимости можно подключить внешние сервиса контроля ошибок. (Задача для системного администратора)
+
+### Общий контроль телеметрии сервера
+
+По состоянию общей телеметрии сервера можно сделать выводы об общей деградации системы.
+
+Основные признаки деградации:
+* Постоянное использование ЦП более чем на 60-70%
+* Загруженность ОЗУ более чем на 70%
+* Загруженность ПЗУ более чем на 80%
+
+Проверка ОЗУ
+
+free -h
+
+Проверка ЦП
+
+top -i
+
+Проверка ЦП и ОЗУ
+
+htop
+
+Проверка ПЗУ
+
+df -h
+
+При необходимости можно подключить сервисы мониторинга и дашбордов: Prometheus, Grafana. 
+Реализовать информирование о превышении параметров и тд. (Задача для системного администратора)
+
+[Назад](../index.md)

index.md

@@ -18,4 +18,5 @@
     * [ArticlesService](/docs/backend/services/articles.md) - публикация статей: создание, обновление, архивирование, публикация, выборка.
     * [SupportService](/docs/backend/services/support.md) - техподдержка: создание обращений, закрытие, выборка запросов.
     * [DeliveryService](/docs/backend/services/delivery.md) - тарифы и информация по доставке, расчёт стоимости и сроков.
-* [Лицензии](/docs/legal.md)
+* [Лицензии](/docs/legal.md)
+* [Логгирование и контроль за деградацией системы](/docs/control.md)