Spring Boot Admin Client
The Spring Boot Admin Client is a Spring Boot Starter that registers itself with the Spring Boot Admin Server to enable monitoring and management. By including the Spring Boot Admin Client Starter dependency in your application, the Spring Boot Admin Server can access health, metrics, and other management endpoints, depending on which Actuator endpoints are accessible.
Properties
| Property | Description |
|---|---|
vcap.application.uris |
|
spring.boot.admin.client.url | The admin server urls to register at
|
spring.boot.admin.client.period | Time interval the registration is repeated
|
vcap.application.application-id |
|
vcap.application.instance-index |
|
spring.boot.admin.client.enabled | Enable Spring Admin Client.
|
spring.boot.admin.client.api-path | The admin rest-apis path.
|
spring.boot.admin.client.password | Password for basic authentication on admin server
|
spring.boot.admin.client.username | Username for basic authentication on admin server
|
spring.boot.admin.client.read-timeout | Read timeout (in ms) for the registration.
|
spring.boot.admin.client.instance.name | Name to register with. Defaults to ${spring.application.name}
|
spring.boot.admin.client.register-once | Enable registration against one or all admin servers
|
spring.boot.admin.client.connect-timeout | Connect timeout for the registration.
|
spring.boot.admin.client.auto-registration | Enable automatic registration when the application is ready.
|
spring.boot.admin.client.instance.metadata | Metadata that should be associated with this application
|
spring.boot.admin.client.instance.prefer-ip | Should the registered urls be built with server.address or with hostname. @deprecated Use serviceHostType instead.
|
spring.boot.admin.client.auto-deregistration | Enable automatic deregistration on shutdown If not set it defaults to true if an active {@link CloudPlatform} is present;
|
spring.boot.admin.client.instance.health-url | Client-health-URL to register with. Inferred at runtime, can be overridden in case the reachable URL is different (e.g. Docker). Must be unique all services registry.
|
spring.boot.admin.client.instance.service-url | Client-service-URL register with. Inferred at runtime, can be overridden in case the reachable URL is different (e.g. Docker).
|
spring.boot.admin.client.instance.service-path | Path for computing the service-url to register with. If not specified, defaults to "/"
|
spring.boot.admin.client.instance.management-url | Management-url to register with. Inferred at runtime, can be overridden in case the reachable URL is different (e.g. Docker).
|
spring.boot.admin.client.instance.service-base-url | Base url for computing the service-url to register with. The path is inferred at runtime, and appended to the base url.
|
spring.boot.admin.client.instance.service-host-type | Should the registered urls be built with server.address or with hostname.
|
spring.boot.admin.client.instance.management-base-url | Base url for computing the management-url to register with. The path is inferred at runtime, and appended to the base url.
|