Spring Boot Actuator: конечные точки (endpoints)

Конечные точки actuator'а позволяют вам контролировать и взаимодействовать с вашим приложением. Spring Boot включает в себя ряд встроенных конечных точек и позволяет добавлять свои собственные. Например, конечная точка health предоставляет базовую информацию о работоспособности приложений.

Каждая отдельная конечная точка может быть включена или отключена. Это контролирует, создана ли конечная точка и существует ли ее компонент в контексте приложения. Чтобы быть доступной удаленно, конечная точка также должна быть доступна через JMX или HTTP. Большинство приложений выбирают HTTP, где идентификатор конечной точки вместе с префиксом /actuator сопоставляется с URL-адресом. Например, по умолчанию конечная точка health сопоставлена ​​с /actuator/health.

Доступны следующие независимые от технологии конечные точки:

ID Описание
auditevents Предоставляет информацию о событиях аудита для текущего приложения. Требуется компонент AuditEventRepository.
beans Отображает полный список всех компонентов Spring в вашем приложении.
caches Показывает доступные кэши.
conditions Показывает условия, которые были оценены для классов конфигурации и автоконфигурации, и причины, по которым они соответствовали или не совпадали.
configprops Отображает сопоставленный список всех @ConfigurationProperties.
env Показывает свойства из Spring ConfigurableEnvironment.
flyway Показывает любые миграции базы данных Flyway, которые были применены. Требуется один или несколько компонентов Flyway.
health Показывает информацию о работоспособности приложения.
httptrace Отображает информацию трассировки HTTP (по умолчанию последние 100 обменов запрос-ответ HTTP). Требуется компонент HttpTraceRepository.
info Отображает произвольную информацию о приложении.
integrationgraph
Показывает граф интеграции Spring. Требуется зависимость spring-integration-core.
loggers Показывает и изменяет конфигурацию регистраторов в приложении.
liquibase Показывает любые миграции базы данных Liquibase, которые были применены. Требуется один или несколько компонентов Liquibase.
metrics Показывает информацию о метриках для текущего приложения.
mappings Отображает объединенный список всех путей @RequestMapping.
scheduledtasks Отображает запланированные задачи в вашем приложении.
sessions Позволяет извлекать и удалять пользовательские сессии из хранилища сессий, поддерживаемых Spring Session. Требуется веб-приложение на основе сервлетов, использующее Spring Session.
shutdown Позволяет приложению корректно завершить работу. По умолчанию отключено.
threaddump Выполняет дамп потока.

Если ваше приложение является веб-приложением (Spring MVC, Spring WebFlux или Jersey), вы можете использовать следующие дополнительные конечные точки:

ID Описание
heapdump Возвращает hprof файл дампа кучи.
jolokia Предоставляет компоненты JMX через HTTP (когда Jolokia находится на пути к классам, недоступно для WebFlux). Требуется зависимость от jolokia-core.
logfile Возвращает содержимое файла журнала (если были установлены свойства logging.file.name или logging.file.path). Поддерживает использование заголовка HTTP Range для получения части содержимого файла журнала.
prometheus
Предоставляет метрики в формате, который может быть обработан сервером Prometheus. Требуется зависимость micrometer-registry-prometheus.

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


Комментарии

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

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

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

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