Spring Boot Actuator: открытие конечных точек
Поскольку конечные точки могут содержать конфиденциальную информацию, необходимо тщательно продумать, когда их следует раскрывать. В следующей таблице показано открытие по умолчанию для встроенных конечных точек:
ID | JMX | Web |
---|---|---|
auditevents | Да | Нет |
beans | Да | Нет |
caches | Да | Нет |
conditions | Да | Нет |
configprops | Да | Нет |
env | Да | Нет |
flyway | Да | Нет |
health | Да | Да |
heapdump | Не применимо | Нет |
httptrace | Да | Нет |
info | Да | Да |
integrationgraph | Да | Нет |
jolokia | Не применимо | Нет |
logfile | Не применимо | Нет |
loggers | Да | Нет |
liquibase | Да | Нет |
metrics | Да | Нет |
mappings | Да | Нет |
prometheus | Не применимо | Нет |
scheduledtasks | Да | Нет |
sessions | Да | Нет |
shutdown | Да | Нет |
threaddump | Да | Нет |
Чтобы изменить конечные точки, используйте следующие специальные свойства include и exclude:
Свойство | Значение по умолчанию |
---|---|
management.endpoints.jmx.exposure.exclude |
|
management.endpoints.jmx.exposure.include |
* |
management.endpoints.web.exposure.exclude |
|
management.endpoints.web.exposure.include |
info, health |
Свойство include содержит идентификаторы конечных точек, которые отображаются. Свойство exclude содержит список идентификаторов конечных точек, которые не должны отображаться. Свойство exclude имеет приоритет над свойством include. Свойства include и exclude можно настроить с помощью списка идентификаторов конечных точек.
Например, чтобы прекратить показывать все конечные точки через JMX и предоставлять только конечные точки health и info, используйте следующее свойство:
management.endpoints.jmx.exposure.include=health,info
* можно использовать для выбора всех конечных точек. Например, чтобы представить все через HTTP, кроме конечных точек env и beans, используйте следующие свойства:
management.endpoints.web.exposure.include=*
management.endpoints.web.exposure.exclude=env,beans
* имеет специальное значение в YAML, поэтому обязательно добавляйте кавычки, если вы хотите включить (или исключить) все конечные точки, как показано в следующем примере:
management:
endpoints:
web:
exposure:
include: "*"
Если ваше приложение открыто для публичного доступа, рекомендуется также защитить свои конечные точки.
Если вы хотите реализовать свою собственную стратегию для отображения конечных точек, вы можете зарегистрировать компонент EndpointFilter.
Читайте также:
- Spring Boot Actuator: функции готовности к производственной работе
- Spring Boot Actuator: конечные точки (endpoints)
- Spring Boot Actuator: включение конечных точек
Комментарии
Отправить комментарий