Установка и настройка Sentry
В продукте реализована функция отправки ошибок в сервис аналитики Kibana или сервис Sentry. По умолчанию ошибки отправляются в сервис аналитики Kibana.
Сервис Sentry не входит в комплект поставки ПО, его установка и настройка выполняется администратором самостоятельно. При настройке Sentry следует учитывать рекомендации, изложенные в разделе «Рекомендации по конфигурированию Sentry».
Для настройки функции отправки ошибок необходимо использовать переменные, указанные в таблице.
Если в настройках оба сервиса отключены, то отчеты об ошибках отправляться не будут.
| Наименование сервиса * | Наименование переменной | Тип переменной | Значение | Описание |
|---|---|---|---|---|
| etcd (CO) | common/logger.analytics.enabled | boolean | true (по умолчанию)/ false | Включение/отключение отправки данных в сервис аналитики Kibana |
| etcd (CO) | config/wte/error.log.analytics.enabled | boolean | true (по умолчанию)/ false | Отправка ошибок в сервис аналитики Kibana. Ошибки отправляются только при включении переменной common/logger.analytics.enabled |
| etcd (CO) | config/wte/error.log.sentry.dsn | string | "" | Отправка ошибок в сервис Sentry |
| etcd (CO) | config/wte/sentry.wfe.log.dsn | string | "" | Отправка ошибок сервиса WFE в сервис Sentry |
| etcd (CO) | config/wte/sentry.board.wopi.log.dsn | string | "" | Отправка ошибок сервиса Доска в сервис Sentry |
| etcd (CO) | config/wte/sentry.sso.log.dsn | string | "" | Отправка ошибок сервиса SSO в сервис Sentry |
| etcd (CO) | config/wte/chatbot.sentry.dsn | string | "" | Отправка ошибок сервиса Chatbot в сервис Sentry |
| etcd (CO) | config/wfe/routing/error.log.sentry.url | string | "" | Hostname сервера Sentry, если сервер развернут в другом домене |
| etcd (CO) | config/wte/error.log.feedback.enabled | boolean | true (по умолчанию)/ false | Включение/отключение поля обратной связи. Функция доступна после включения отправки ошибок в один из сервисов с помощью переменных: wte/error.log.sentry.dsnwte/error.log.analytics.enabled |
* — Для сохранения конфигурации при обновлении или переустановке продукта следует добавить переменную и значение в файл ~/install_co/group_vars/co_setup/main.yml.
При включении поля обратной связи с помощью переменной wte/error.log.feedback.enabled пользователь может оставить собственный комментарий к ошибке. Этот комментарий будет отправлен в зависимости от конфигурации:
- в Sentry и дополнит соответствующее событие ошибки;
- в сервис аналитики Kibana отдельным событием, с сохранением идентификатора
eventIdиз оригинального события ошибки.
События ошибок сервиса аналитики дополняются идентификатором пользователя и идентификатором события.