Spring Boot Actuator: написание пользовательских HealthIndicators

Чтобы предоставить пользовательскую информацию о работоспособности (health), вы можете зарегистрировать компоненты Spring, которые реализуют интерфейс HealthIndicator. Вам необходимо предоставить реализацию метода health() и вернуть ответ Health. Ответ о работоспособности должен включать статус и при желании может включать дополнительные сведения, которые будут отображаться. В следующем коде показан пример реализации HealthIndicator:

import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.stereotype.Component;

@Component
public class MyHealthIndicator implements HealthIndicator {

    @Override
    public Health health() {
        int errorCode = check(); // выполняем определенную проверку работоспособности
        if (errorCode != 0) {
            return Health.down().withDetail("Error Code", errorCode).build();
        }
        return Health.up().build();
    }

}

Идентификатором данного HealthIndicator является имя компонента без суффикса HealthIndicator, если он существует. В предыдущем примере информация о работоспособности доступна в записи с именем my.

В дополнение к предопределенным типам состояния Spring Boot Health также может возвращать пользовательский статус, который представляет новое состояние системы. В таких случаях также необходимо предоставить пользовательскую реализацию интерфейса StatusAggregator, или реализацию по умолчанию необходимо настроить с помощью свойства конфигурации management.endpoint.health.status.order.

Например, предположим, что новый статус с кодом FATAL используется в одной из ваших реализаций HealthIndicator. Чтобы настроить порядок серьезности (severity order), добавьте следующее свойство в свойства своего приложения:

management.endpoint.health.status.order=fatal,down,out-of-service,unknown,up

Код состояния HTTP в ответе отражает общее состояние работоспособности (например, UP отображается на 200, а OUT_OF_SERVICE и DOWN на 503). Вы также можете зарегистрировать пользовательские сопоставления состояний, если вы получаете доступ к конечной точке health по HTTP. Например, следующее свойство сопоставляет FATAL с 503 (service unavailable):

management.endpoint.health.status.http-mapping.fatal=503

Если вам нужно больше контроля, вы можете определить свой собственный компонент HttpCodeStatusMapper.

В следующей таблице показаны сопоставления состояния по умолчанию для встроенных статусов:

Статус Сопоставление 
DOWN
 SERVICE_UNAVAILABLE (503) 
OUT_OF_SERVICE
 SERVICE_UNAVAILABLE (503) 
UP
 По умолчанию сопоставление отсутствует, поэтому http статус 200 
UNKNOWN
 По умолчанию сопоставление отсутствует, поэтому http статус 200

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


Комментарии

Отправить комментарий

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

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

Изображение
Чтобы получить текущий timestamp в Java : package main; import java.sql.Timestamp; public class Main { public static void main(String[] args){ Timestamp timestamp = new Timestamp(System.currentTimeMillis()); System.out.println(timestamp); } } Вывод: 2019-10-03 10:09:21.61 Вот еще два более подробных примера как получить текущий timestamp в Java: 1. java.sql.Timestamp Есть два метода получить текущий java.sql.Timestamp package main; import java.sql.Timestamp; import java.text.SimpleDateFormat; import java.util.Date; public class Main { private static final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy.MM.dd.HH.mm.ss"); public static void main(String[] args) { // Метод 1 Timestamp timestamp = new Timestamp(System.currentTimeMillis()); System.out.println(timestamp); // Метод 2 - через Date Date date = new Date(); System.out.println(new Timestamp(date.getTime()...
Далее...

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

Изображение
Класс Object является корнем иерархии классов. У каждого класса есть Object как суперкласс. Все объекты, включая массивы, реализуют методы этого класса. Методы класса Object Метод getClass() public final Class getClass() Возвращает класс времени исполнения (runtime class) этого Object. Возвращенный объект Class - это объект, который заблокирован статическими синхронизированными методами представленного класса. Фактический тип результата - Class<? extends |X|> где |X| заменяется статическим типом выражения, для которого вызывается getClass. Например, в этом фрагменте кода не требуется приведение: Number n = 0; Class c = n.getClass(); Метод getClass() возвращает: Объект Class, представляющий класс времени исполнения (runtime class) этого объекта. Метод hashCode public int hashCode() Возвращает значение хэш-кода для объекта. Этот метод поддерживается для использования хэш-таблиц, таких как те, что предоставляются HashMap. Основной контракт метода hashCo...
Далее...

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

Изображение
Если вы являетесь Java-разработчиком или администратором Java приложения, вам поможет в работе знание того, что означают опции JVM, а также их важность и как они влияют на ваше приложение. Обзор параметров JVM Если говорить о параметрах JVM, то есть три типа параметров, которые вы можете включить в JVM: стандартные, нестандартные и расширенные параметры. Если вы используете расширенную опцию, вы всегда используете опцию с -XX. Точно так же, если вы применяете нестандартную опцию, вы используете -X. Стандартные опции ничего не добавляют к опции. Какие параметры JVM используются вашим приложением? Если приложение работает в Linux, вы можете использовать ps -ef | grep java для идентификации процесса Java и просмотра параметров JVM, напечатанных как аргументы процесса. Если в системе выполняется более одного Java-процесса, вам может потребоваться использовать ключевое слово, уникальное для вашего Java-приложения. Если ваш аргумент слишком длинный, попробуйте использовать ps...
Далее...