Sentry предназначена для обнаружения и отслеживания проблем в производительности приложений. Система помогает выявлять узкие места, ошибки и неэффективные участки кода, что позволяет улучшить производительность и стабильность приложения.
Мониторинг производительности: Sentry предоставляет подробную информацию о времени выполнения запросов и других метриках производительности. Это позволяет идентифицировать узкие места и оптимизировать код для повышения производительности приложения. Например, вы можете обнаружить, что определенный запрос занимает слишком много времени и оптимизировать его для улучшения отклика приложения.
Отслеживание ошибок: Sentry автоматически отслеживает и регистрирует ошибки, возникающие в приложении. Вы получаете уведомления о возникших проблемах и подробную информацию для их анализа и исправления. Это помогает снизить время реакции на ошибки и улучшить качество приложения. Например, если в приложении возникает ошибка, вы будете получать уведомление с полной информацией о месте возникновения ошибки, стеке вызовов и контексте, что поможет быстро определить и исправить проблему.
Диагностика проблем: Sentry предоставляет возможность анализировать стек вызовов и другую информацию о контексте возникновения ошибок. Это помогает быстро определить причины проблем и принять меры для их устранения. Например, если приложение работает медленно, вы сможете анализировать стек вызовов и определить, какие участки кода занимают больше всего времени, чтобы оптимизировать их.
Внедрение APM системы Sentry в Bitrix Framework позволит вашей компании:
- Улучшить производительность приложения и удовлетворение пользователей;
- Снизить время реакции на проблемы и ускорить процесс их исправления;
- Повысить качество приложения и уменьшить количество ошибок;
- Оптимизировать использование ресурсов и снизить затраты на инфраструктуру.
Создание проекта в Sentry:
1. Войдите на сайт sentry. Sentry может быть развернут в вашей инфраструктуре, либо доступно использование облачной версии: в
https://sentry.io/pricing/. Подробнее:
https://open.sentry.io/2. Выберите пункт
Projects (Проекты) в меню слева. Откроется список проектов. (Он может быть пустым, если вы ещё не участвуете в проектах).
3. В правом верхнем углу нажимаем "
Create Project" ("Создать проект")и создаем конфигурацию для проекта (скриншот 2):
3.1.
Choose your platform: выбираем язык или фреймворк, который используется в проекте и который мы хотим отслеживать. Для проектов на Битрикс php - для бэкенда, js - для фронтенда (скриншот 3).
3.2.
Set your alert frequency: оповещения на каждую ошибку (Alert me on every new issue), в зависимости от количества уникальных ошибок в заданное время, возможность создания ошибки позднее (Я создам свои собственные оповещения позже).
3.3.
Name your project and assign it a team: назовите ваш проект в поле Project name (Название проекта) и назначьте команду в поле Team (Команда) (можно выбрать из существующих в выпадающем списке или создать новую).
3.4. Нажмите
Create Project (Создать проект). Оказываетесь на странице конфигурации Configure SDK. Нажав кнопку
Take me to Issues, переходите на страницу инцидентов нового проекта.
Подключение модуля к проекту:
1. Установить модуль из маркетплейса
2. Настроить модуль:
2.1.
Настройки мониторинга ошибок на фронте:2.1.1.Первым делом находим клиентский ключ dsn и вводим в поле `Имя источника данных`. Ключ находится на сайте по пути Проекты ->Настройки проекта -> Клиентские ключи (Client Keys) (скриншот 4).
2.1.2. Включаем галочку `Включить Sentry для js`, чтобы началась работа по инициализации библиотек;
2.1.3. Указываем `Частота выборки исключений` от 0 до 1.0, где 1.0 равен 100%, т.е указываем все ли мы ошибки js будем у себя в мониторинге отмечать;
2.1.4. Выбираем `Окружение` - это окружение, в котором будут записываться ошибки dev, pre-production или production;
2.1.5. `Режим отладки Sentry` - включает дебаг библиотеки sentry на фронте (если фронт не подключается к сервису);
2.1.6. `Частота записи сессии` - частота записи сессий пользователя, от 0 до 1.0, где 1.0 равен 100%, т.е указываем, все ли сессии записывать;
2.1.7. `Частота записи сессии пользователя при исключениях` - частота записи сессий пользователя при ошибках;
2.1.8. `Частота профилировки` - частота профилировки js, от 0 до 1.0, где 1.0 равен 100%;
2.1.9. Далее есть дополнительные настройки этого раздела - это проверка уровня url, данная настройка помогает подключать библиотеку sentry не на всем сайте, а, например, только со 2 уровня url, т.е с разделов сайта.
2.1.10.`Добавить заголовок Access-Control-Allow-Headers` включает CORS заголовок Access-Control-Allow-Headers: sentry-trace, baggage (подробности:
https://docs.sentry.io/platforms/javascript/usage/distributed-tracing/dealing-with-cors-issues/ ).
2.2. Настройки мониторинга ошибок на сервере:2.2.1.Первым делом запрашиваем у администратора sentry, dsn - `имя источника данных`;
2.2.2.Включаем галочку `Включить Sentry для серверной части`, чтобы началась работа инициализации модуля;
2.2.3. Указываем `Частота выборки` от 0 до 1.0, где 1.0 равен 100%, т.е указываем, все ли мы ошибки php будем у себя в мониторинге отмечать;
2.2.4. Выбираем `Окружение` - это окружение, в котором будут записываться ошибки dev, pre-production или production;
2.2.5. Можно выключить режим релиза, позволяет отслеживать тенденции ошибок в каждом из релизов;
2.2.6 Выбор, на основании чего будет выпускаться релиз - на основании тегов или хеша коммита;
2.2.7. `Отключить типы/уровни ошибок` - данная настройка позволяет отключать типы ошибок, отправляемых на сервер sentry.
2.3. Проверка работы модуля:2.3.1. Проверка работы на фронте: нужно добавить несуществующую функцию. Например: <script>test();</script>
2.3.2. Проверка работы на php: сделать что-нибудь, что вызывает фаталку, например в командной строке php в bitrix админке.
