server.adoc 2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
[[spring-boot-admin-server]]
== Spring Boot Admin Server ==

.Spring Boot Admin Server configuration options
|===
| Property name |Description |Default value

| spring.boot.admin.context-path
| The 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.period
13
| Time interval in ms to update the status of applications with expired status-information.
Johnny Lim committed
14
| 10,000
15 16 17

| spring.boot.admin.monitor.status-lifetime
| Lifetime of application statuses in ms. The applications /health-endpoint will not be queried until the lifetime has expired.
Johnny Lim committed
18
| 10,000
19

20
| spring.boot.admin.monitor.connect-timeout
Johnny Lim committed
21 22
| Connect timeout in ms when querying the applications' status and info.
| 2,000
23 24

| spring.boot.admin.monitor.read-timeout
Johnny Lim committed
25
| Read timeout in ms when querying the applications' status and info.
Johannes Edmeier committed
26
| 20,000
27 28 29 30 31

| spring.boot.admin.metadata-keys-to-sanitize
| Metadata values for the keys matching these regex patterns will be sanitized in all json output.
| `".*password$", ".*secret$", ".*key$", ".*$token$", ".*credentials.*", ".*vcap_services$"`

Johannes Edmeier committed
32 33 34 35 36 37 38 39 40
| spring.boot.admin.probed-endpoints
| For 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-proxy.ignored-headers
|  Headers not to be forwarded when making requests to clients.
| `"Cookie", "Set-Cookie", "Authorization"

41 42 43 44 45 46 47 48
| spring.boot.admin.ui.brand
| Brand to be shown in then navbar.
| `"<img src="assets/img/icon-spring-boot-admin.svg"><span>Spring Boot Admin</span>"`

| spring.boot.admin.ui.title
| Page-Title to be shown.
| `"Spring Boot Admin"`

49 50 51 52 53 54 55
|===

include::server-discovery.adoc[]

include::server-clustering.adoc[]

include::server-notifications.adoc[]