Общие принципы диагностики BPMSoft

Базовый

В статье описан процесс диагностики проблем при работе с BPMSoft, который можно разделить на несколько этапов:

Уточнение конфигурации и сути проблемы — что именно происходит и на каком стенде.
Проверка проблем инфраструктуры — исключение влияния внешних факторов.
Определение направления диагностики — выявление предполагаемого источника проблемы: ошибки в кастомизации, не работает микросервис, бизнес-процессы или что-то другое.
Сбор дополнительной информации — получение данных, необходимых для продолжения диагностики по выбранному направлению. Например, при подозрении на сбой в микросервисе стоит изучить его логи за день, когда проблема воспроизводилась.
Результаты исследования — определение причин и особенностей проблемы, а также способов ее решения.

Шаг 1. Уточнение конфигурации и сути проблемы

Основная цель этого этапа уточнить конфигурацию стенда, а также понять, как именно проявляется проблема и в каком контексте она возникает.

Уточните базовую информацию о стенде BPMSoft:

адрес — чтобы понять на какой среде возникает проблема;
версию и сборку системы — чтобы исключить известные ошибки, которые могли быть исправлены в новой версии. Сборка также определяет состав базовой функциональности. Иногда для решения вопроса полезно воспроизвести стенд с аналогичной базовой конфигурацией. Информацию о новых возможностях BPMSoft и исправленных ошибках смотрите в разделе «Обновления и релизы»;
СУБД — ее особенности могут влиять на поведение системы, так как для разных СУБД используются разные библиотеки и настройки. Например, причины долгой загрузки приложения могут отличаться у Microsoft SQL Server и PostgreSQL.

Также важно определить:

какие действия выполняются;
какой результат ожидается получить;
какой фактический результат получен.

Если некорректно работает базовая функциональность платформы BPMSoft, попробуйте найти материалы по этой теме в Базе знаний BPMSoft. Это поможет проверить корректность настроек и понять, соответствует ли ожидаемое поведение базовым возможностям системы.

Шаг 2. Проверка проблем инфраструктуры

Практика показывает, что проблемы нередко связаны с инфраструктурой или внешними факторами, поэтому их рекомендуется исключить до проверки самой системы BPMSoft.

Рекомендуем в первую очередь выполнить следующие действия:

Убедитесь в стабильности интернет‑соединения и сетевой связности между серверами приложения (при развертывании on-site).
Очистите кэш и куки браузера.
Убедитесь, что элементы серверной инфраструктуры работают без превышения нормальной нагрузки. Подробнее об анализе нагрузки смотрите в статье Общие принципы диагностики проблем с производительностью. Если найдены проблемы, проверьте соответствует ли конфигурация системным требованиям.

Если после выполнения этих проверок понятно, что проблема не связана с инфраструктурой, можно переходить к следующему шагу — выбору направления диагностики.

Примечание. При обращении в техническую поддержку BPMSoft добавьте информацию о выполненных проверках и расскажите, почему считаете, что причина проблемы не связана с инфраструктурой. Это поможет быстрее разобраться в ситуации и избежать повторных уточнений.

Шаг 3. Выбор направления диагностики

После исключения инфраструктурных причин выполняется анализ работы самой системы BPMSoft.

Анализ стоит начать с проверки прав доступа пользователя в системе и наличия лицензий. Если были найдены неправильные настройки, скорректируйте права или состав лицензий и повторите шаги воспроизведения проблемы.

Обычно далее выполняется анализ логов приложения за период воспроизведения проблемы. В логах можно найти технические детали ошибки и определить компонент системы, который ее вызывает:

Получите логи приложения BPMSoft за период возникновения проблемы. Подробнее: Логирование BPMSoft.
Ищите строки с уровнями ERROR или WARNING.
Сопоставьте время появления ошибки с действиями пользователя.

Примечание. Для более детального анализа рекомендуется включить уровень логирования INFO или DEBUG, однако из-за этого размер логов значительно увеличивается. Подробнее: Уровни логирования.

Выделите коды ошибок и сообщения (например, 500 Internal Server Error).

Ознакомиться с соответствием файлов логов и компонентов системы можно в статье Описание логгеров NLog в BPMSoft.

Шаг 4. Сбор уточняющей диагностической информации

После того как определено функциональное направление проблемы, необходимо провести углубленную диагностику в выбранном направлении. Для этого, в том числе, можно использовать специализированные материалы, собранные в разделе «Диагностика» Базы знаний BPMSoft. В нем представлены наиболее распространенные подходы и рекомендации по разным направлениям:

Этот список не является исчерпывающим, однако охватывает наиболее частые сценарии и популярные способы диагностики. Дополнительно можно воспользоваться другими материалами Базы знаний BPMSoft по интересующей вас теме.

Шаг 5. Результаты исследования

После сбора и анализа диагностической информации формируется итоговый результат исследования: в чем причина проблемы и какие действия требуются дальше.

В зависимости от ситуации результатом может быть:

устранение выявленной проблемы или выполнение необходимых корректировок;
предоставление временных обходных решений;
фиксация ошибки в продукте с последующей передачей на исправление.

Обращение в техническую поддержку BPMSoft

Команда технической поддержки использует те же подходы к диагностике, которые описаны выше. Ознакомившись с ними, можно действовать «на шаг вперед» и оперативно собирать и передавать необходимую информацию — это заметно сокращает время на уточнения и помогает быстрее найти решение вашего вопроса.

Если функциональная область проблемы определена, добавьте в обращение профильную диагностическую информацию:

Пример передачи информации об ошибке представлен в таблице ниже.

Таблица 1 — Информация, предоставляемая при обнаружении ошибок

Перечень сведений	Пример формулировки
Дата и время или регулярность воспроизведения проблемы, логи BPMSoft за проблемный период	Проблема воспроизводится постоянно. Четкой закономерности выявить не удалось; Проблема воспроизводится при запуске бизнес-процесса «Регистрация обращений»; Проблема воспроизвелась вчера в 21:13, нагрузка на сервер приложения была минимальной. В описании приложен архив с логами приложения
Последовательность действий (алгоритм), которую необходимо выполнить для повторного воспроизведения ошибки	Перейти в раздел «Продажи». Открыть страницу любой продажи. Перейти на вкладку «Файлы и ссылки» и нажать на кнопку «Добавить файл». Выбрать файл («Полная презентация системы.pptx»). Система отображает сообщение об ошибке: «Ошибка загрузки Файла». В описании приложен скриншот или текст ошибки
Результаты проведенного анализа	Результат проведенного анализа, подтверждение некорректной логики в базовой функциональности ПО. Иные результаты, полученные в ходе анализа проблемы
Описание некорректного поведения, которое проявляется в базовой логике или в проектном блоке функциональности	Ошибка начала проявляться после добавления бизнес-правил на страницу обращения. До внесения изменений данные на странице отображались корректно; После замещения объекта «Обращения» страница обращения стала долго загружаться. Замещающий объект во вложении
Результат отладки кода (в случае ошибки в пользовательском блоке)	В каком методе и на какой строке кода возникает ошибка