Spring Boot Actuator: информация о работоспособности (health endpoint)

Вы можете использовать информацию о работоспособности (health), чтобы проверить состояние вашего работающего приложения. Он часто используется программным обеспечением для мониторинга, чтобы предупредить кого-либо, когда производственная система выходит из строя. Информация, предоставляемая конечной точкой health, зависит от свойств management.endpoint.health.show-details и management.endpoint.health.show-components, для которых можно настроить одно из следующих значений:

Имя Описание
never
Подробности никогда не показываются.
when-authorized
Подробности показываются только авторизованным пользователям. Авторизованные роли можно настроить с помощью management.endpoint.health.roles.
always
Подробности показаны всем пользователям.

Значением по умолчанию является never. Пользователь считается авторизованным, когда он выполняет одну или несколько ролей конечной точки. Если конечная точка не имеет настроенных ролей (по умолчанию), все аутентифицированные пользователи считаются авторизованными. Роли можно настроить с помощью свойства management.endpoint.health.roles.

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

Информация о работоспособности собирается из содержимого HealthContributorRegistry (по умолчанию все экземпляры HealthContributor, определенные в ApplicationContext). Spring Boot включает в себя несколько автоматически настраиваемых HealthContributors, и вы также можете написать свой собственный.

HealthContributor может быть HealthIndicator или CompositeHealthContributor. HealthIndicator предоставляет фактическую информацию о состоянии здоровья, включая статус. CompositeHealthContributor предоставляет набор других HealthContributors. Взятые вместе, участники формируют древовидную структуру для представления общего состояния системы.

По умолчанию окончательное состояние системы определяется с помощью StatusAggregator, который сортирует состояния из каждого HealthIndicator на основе упорядоченного списка состояний. Первый статус в отсортированном списке используется в качестве общего состояния здоровья. Если никакой HealthIndicator не возвращает состояние, известное StatusAggregator, используется состояние UNKNOWN.

HealthContributorRegistry может использоваться для регистрации и отмены регистрации индикаторов состояния во время выполнения.


Читайте также:


Комментарии

Популярные сообщения из этого блога

Методы класса Object в Java

Как получить текущий timestamp в Java

Основные опции JVM для повышения производительности и отладки