Проверка работоспособности платформы

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

  • Доступности платформы в производственной среде.

  • Проверки состояния критических компонентов системы (PostgreSQL, OpenSearch).

  • Интеграции с системами мониторинга и балансировки нагрузки.

Доступные методы

Метод /health

URL: http://<адрес_сервера>:<порт>/universe-backend/api/v1/hpe-core/health

Доступность: без аутентификации.

Коды ответов:

  • 200 (OK) - все компоненты платформы доступны и работают корректно.

  • 503 (Service Unavailable) - один или несколько критических компонентов системы недоступны.

  • 500 (Internal Server Error) - произошла внутренняя ошибка при выполнении проверки.

  • 404 (Not Found) - платформа не развернута или сервер приложений не запущен.

Пример использования в браузере:

  1. Откройте браузер.

  2. Перейдите по адресу: http://localhost:8082/universe-backend/api/v1/hpe-core/health.

  3. Нажмите F12 для просмотра деталей запроса и ответа.

Метод /ping

URL: http://<адрес_сервера>:<порт>/universe-backend/api/v1/hpe-core/ping

Доступность: без аутентификации.

Описание: Базовая проверка доступности сервиса. Метод используется для быстрой проверки, что приложение функционирует.

Коды ответов:

  • 204 (No Content) - сервис функционирует и доступен.

  • 404 (Not Found) - платформа не развернута или сервер приложений не запущен.

Особенности:

  • Выполняет минимальную проверку без глубокого анализа компонентов.

Проверяемые компоненты

Метод /health проверяет доступность следующих критических компонентов:

  1. PostgreSQL - основная база данных платформы.

  2. OpenSearch - поисковый движок и система индексации.

Архитектура проверок:

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

Конфигурация

Для настройки проверок работоспособности доступны следующие параметры:

Параметр

Описание

Значение по умолчанию

com.universe.mdm.hpe.core.health.check.interval

Интервал внутренних проверок (в миллисекундах)

15000

com.universe.mdm.hpe.core.health.check.info.visibility

Отображение детальной информации о проверках

true

com.universe.mdm.hpe.core.health.check.cluster.quorum

Минимальное количество узлов для работоспособности

1

Примечание по настройке пула соединений БД:

Для проверок базы данных используется отдельный источник данных com.universe.mdm.hpe.core.datasource.

Рекомендуемые значения для пула соединений:

  • minPoolSize = 1

  • maxPoolSize = 1

Устранение неполадок

Сценарий 1: Метод возвращает 404

  • Убедитесь, что платформа развернута и запущена.

  • Проверьте правильность URL (включая контекстный путь /universe-backend).

  • Убедитесь, что порт указан правильно.

Сценарий 2: Метод /health возвращает 503

  • Проверьте доступность PostgreSQL.

  • Проверьте доступность OpenSearch.

  • Убедитесь, что количество работающих узлов кластера не меньше значения cluster.quorum.

Сценарий 3: Метод /health возвращает 500

  • Проверьте логи приложения на наличие ошибок.

  • Убедитесь, что все необходимые конфигурационные параметры установлены корректно.

Примечания:

  • Все методы проверки работоспособноси доступны без аутентификации и авторизации.

  • Методы могут быть использованы любыми системами мониторинга.

  • Для получения детальной информации о состоянии компонентов при запросе /health убедитесь, что параметр info.visibility установлен в true.

  • Интервал внутренних проверок (по умолчанию 15 секунд) определяет, как часто система самостоятельно проверяет состояние компонентов.