Общие принципы диагностики проблем эксплуатации
микросервисов
В статье описаны основные подходы к диагностике проблем при эксплуатации контейнерных компонентов BPMSoft.
Принципы диагностики, описанные в данной статье, затрагивают следующие темы:
- Диагностика сервиса синхронизации почты;
- Диагностика сервиса глобального поиска и объединения дублей;
- Диагностика сервиса машинного обучения.
Этапы диагностики
Диагностика сервиса синхронизации почты
Для анализа проблемы с сервисом синхронизации почты необходимо собрать следующую информацию:
- Тип развертывания: Kubernetes или Docker.
- Выполните диагностику среды развертывания:
Для Kubernetes выполните команду:
kubectl get pods --all-namespaces | grep <helm release name>
или
kubectl get pods -n <namespace name>
где:- <helm release name> — фильтр, по которому будут отобраны поды;
- <namespace name> — пространство имен, в котором находятся поды.
Для Docker:
docker ps
или
docker ps --filter "name=Exchange"
- Выполните дополнительную диагностику, если на уровне среды проблем не выявлено. Подробнее: Самостоятельная диагностика сервиса синхронизации почты.
- Проверьте состояние API почтового сервиса, выполнив команду:
curl --location "{EL_API_URL}/api/listeners/status" --header "Content-Type: application/json"
где EL_API_URL — адрес API компонента Exchange Listener. - Проверьте полные логи всех экземпляров компонентов сервиса за период, в который проблема начала проявляться.
Диагностика сервиса глобального поиска и объединения дублей
Для анализа проблемы с сервисом глобального поиска и объединения дублей необходимо собрать следующую информацию:
- Тип развертывания: Kubernetes или Docker.
- Проверить параметры подключения и настройки:
- Настройки подключения сервиса глобального поиска и объединения дублей;
- Конфигурацию на стороне BPMSoft.
Если проблема связана с конфигурацией сервисов, то проверьте актуальность настроек подключения и конфигурации и выполните восстановительные действия:
- Скорректируйте настройки подключения к сервису.
- Перезапустите приложение BPMSoft.
- Повторно выполните вход в систему.
Если проблема с глобальным поиском:
- Проверьте настройки сервиса GlobalSearch.
- Проверьте логи сервиса за период возникновения проблемы.
Дополнительно при необходимости:
- Выполните переиндексацию данных.
- Очистите кэш сервера кэширования.
- Перезапустите приложение BPMSoft.
- Повторно выполните вход в систему.
Если проблема с дедупликацией:
- Проверьте настройки сервиса Deduplication.
- Проверьте логи соответствующего компонента.
Дополнительно при необходимости:
- Очистите кэш сервера кэширования.
- Перезапустите приложение BPMSoft.
- Повторно выполните вход в систему.
Диагностика сервиса машинного обучения
Для анализа проблемы с сервисом машинного обучения необходимо собрать следующую информацию:
- Версия сервиса машинного обучения.
- Подробное описание проявления проблемы (что именно не работает, как и когда проявляется, постоянна ли проблема и т. п.).
Если проблема связана с конфигурацией, то уточните текущие настройки сервиса.
Если проблема связана с версией сервиса:
- Проверьте соответствие лицензий. Убедитесь в наличии действующих лицензий на использование сервиса машинного обучения.
- Проверьте входит ли сервис машинного обучения в используемый модуль BPMSoft.
Информация для обращения в техническую поддержку
Если самостоятельная диагностика не позволила устранить проблему, пожалуйста, соберите следующую информацию и обратитесь в техническую поддержку BPMSoft:
- Описание проблемы, возникшей при эксплуатации или настройке — подробная информация о проблеме ускоряет анализ и решение.
- Дата и время возникновения ошибки — эта информация необходима для максимально точного исследования причин возникновения проблемы.
- Версия микросервиса — эта информация требуется для проверки гипотез на инфраструктуре, приближенной к вашей, и анализа решенных проблем при выпуске новых версий микросервисов.
- Версия используемой операционной системы — эта информация требуется для проверки гипотез, связанных со спецификой используемой операционной системы.
- Описание способа, по которому выполнялось развертывание — эта информация требуется для проверки гипотез на инфраструктуре, приближенной к вашей.
- Значения системных настроек на стороне BPMSoft, указанных при установке микросервиса — эта информация требуется для проверки гипотез на инфраструктуре, приближенной к вашей, и анализа решенных проблем при выпуске новых версий микросервисов.
- Конфигурационные файлы микросервиса — эта информация требуется для анализа режимов работы микросервисов.
- Полные логи микросервиса за день, в который наблюдалась проблема — эта информация необходима для исследования проблемы и причин ее возникновения.
Решение типовых неполадок
Самостоятельная диагностика проблем сервиса синхронизации почты
Не выполняется ручная синхронизация почты по кнопке «Синхронизировать почту»
Не удается добавить почтовый ящик в BPMSoft (on-site)
Не работает почтовая синхронизация для писем с общим размером более 30 MB
Не удаляется почтовый ящик на стороне BPMSoft
Ошибка Request Entity Too Large