Skip to main content

Properties

Property nameDescriptionDefault value
spring.boot.admin.server.enabledEnables the Spring Boot Admin Server.true
spring.boot.admin.context-pathThe context-path prefixes the path where the Admin Server’s statics assets and API should be served. Relative to the Dispatcher-Servlet.
spring.boot.admin.monitor.status-intervalTime interval to check the status of instances.10,000ms
spring.boot.admin.monitor.status-max-backoffThe maximal backoff for status check retries (retry after error has exponential backoff, minimum backoff is 1 second).60,000ms
spring.boot.admin.monitor.status-lifetimeLifetime of status. The status won’t be updated as long the last status isn’t expired.10,000ms
spring.boot.admin.monitor.info-intervalTime interval to check the info of instances.1m
spring.boot.admin.monitor.info-max-backoffThe maximal backoff for info check retries (retry after error has exponential backoff, minimum backoff is 1 second).10m
spring.boot.admin.monitor.info-lifetimeLifetime of info. The info won’t be updated as long the last info isn’t expired.1m
spring.boot.admin.monitor.default-timeoutDefault timeout when making requests. Individual values for specific endpoints can be overridden using spring.boot.admin.monitor.timeout.*. However, for interval based tasks like statusUpdate (i.e. HealthCheck) there are some limitations: the default-timeout cannot be longer than the interval. If so, the specified value of the interval is used as timeout.10,000
spring.boot.admin.monitor.timeout.*Key-Value-Pairs with the timeout per endpointId. Defaults to default-timeout.
spring.boot.admin.monitor.default-retriesDefault number of retries for failed requests. Modifying requests (PUT, POST, PATCH, DELETE) are never retried. Individual values for specific endpoints can be overridden using spring.boot.admin.monitor.retries.*.0
spring.boot.admin.monitor.retries.*Key-Value-Pairs with the number of retries per endpointId. Defaults to default-retries. Modifying requests (PUT, POST, PATCH, DELETE) are never retried.
spring.boot.admin.metadata-keys-to-sanitizeMetadata values for the keys matching these regex patterns will be sanitized in all json output. Starting from Spring Boot 3, all actuator values are masked by default. Take a look at the Spring Boot documentation in order to configure unsanitizing of values (Sanitize Sensitive Values).".password$", ".*secret$", ".*key$", ".*token$", ".*credentials.", ".*vcap_services$"
spring.boot.admin.probed-endpointsFor Spring Boot 1.x client applications SBA probes for the specified endpoints using an OPTIONS request. If the path differs from the id you can specify this as id:path (e.g. health:ping).."health", "env", "metrics", "httptrace:trace", "threaddump:dump", "jolokia", "info", "logfile", "refresh", "flyway", "liquibase", "heapdump", "loggers", "auditevents"
spring.boot.admin.instance-auth.enabledEnable pulling credentials from spring configuration propertiestrue
spring.boot.admin.instance-auth.default-user-nameA default user name used to authenticate to registered services. The spring.boot.admin.instance-auth.enabled property must be true.null
spring.boot.admin.instance-auth.default-passwordA default user password used to authenticate to registered services. The spring.boot.admin.instance-auth.enabled property must be true.null
spring.boot.admin.instance-auth.service-map.*.user-nameA user name used to authenticate to the registered service with the specified name. The spring.boot.admin.instance-auth.enabled property must be true.
spring.boot.admin.instance-auth.service-map.*.user-passwordA user password used to authenticate to the registered service with the specified name. The spring.boot.admin.instance-auth.enabled property must be true.
spring.boot.admin.instance-proxy.ignored-headersHeaders not to be forwarded when making requests to clients."Cookie", "Set-Cookie", "Authorization"
spring.boot.admin.ui.public-urlBase url to use to build the base href in the ui.If running behind a reverse proxy (using path rewriting) this can be used to make correct self references. If the host/port is omitted it will be inferred from the request.
spring.boot.admin.ui.brandBrand to be shown in the navbar."<img src="assets/img/icon-spring-boot-admin.svg"><span>Spring Boot Admin</span>"
spring.boot.admin.ui.titlePage-Title to be shown."Spring Boot Admin"
spring.boot.admin.ui.login-iconIcon used as image on login page."assets/img/icon-spring-boot-admin.svg"
spring.boot.admin.ui.faviconIcon used as default favicon and icon for desktop notifications."assets/img/favicon.png"
spring.boot.admin.ui.favicon-dangerIcon used as favicon when one or more service is down and for desktop notifications."assets/img/favicon-danger.png"
spring.boot.admin.ui.remember-me-enabledSwitch to show/hide the remember-me checkbox on the login page.true
spring.boot.admin.ui.poll-timer.cachePolling duration in ms to fetch new cache data.2500
spring.boot.admin.ui.poll-timer.datasourcePolling duration in ms to fetch new datasource data.2500
spring.boot.admin.ui.poll-timer.gcPolling duration in ms to fetch new gc data.2500
spring.boot.admin.ui.poll-timer.processPolling duration in ms to fetch new process data.2500
spring.boot.admin.ui.poll-timer.memoryPolling duration in ms to fetch new memory data.2500
spring.boot.admin.ui.poll-timer.threadsPolling duration in ms to fetch new threads data.2500
spring.boot.admin.ui.poll-timer.logfilePolling duration in ms to fetch new logfile data.1000
`Allows to enable toast notifications.false