Spring Boot Admin Reference Guide

1. What is Spring Boot Admin?

codecentric’s Spring Boot Admin is a community project to manage and monitor your Spring Boot ^® applications. The applications register with our Spring Boot Admin Client (via HTTP) or are discovered using Spring Cloud ^® (e.g. Eureka, Consul). The UI is just an AngularJs application on top of the Spring Boot Actuator endpoints.

2. Getting started

2.1. Setting up Spring Boot Admin Server

First you need to setup your server. To do this just setup a simple boot project (using start.spring.io).

Add Spring Boot Admin Server starter to your dependencies:

pom.xml

<dependencies>
    <dependency>
        <groupId>de.codecentric</groupId>
        <artifactId>spring-boot-admin-starter-server</artifactId>
        <version>1.5.7</version>
    </dependency>
</dependencies>

Pull in the Spring Boot Admin Server configuration via adding @EnableAdminServer to your configuration:

@Configuration
@EnableAutoConfiguration
@EnableAdminServer
public class SpringBootAdminApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringBootAdminApplication.class, args);
    }
}

If you want to setup the Spring Boot Admin Server via war-deployment in a servlet-container, please have a look at the spring-boot-admin-sample-war.

See also the spring-boot-admin-sample project, which also adds security.

2.2. Registering client applications

To register your application at the SBA Server you can either include the SBA Client or use Spring Cloud Discovery (e.g. Eureka, Consul, …). There is also a simple option using a static configuration on the SBA Server side.

2.2.1. Spring Boot Admin Client

Each application that wants to register has to include the Spring Boot Admin Client.

Add spring-boot-admin-starter-client to your dependencies:

pom.xml

<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-starter-client</artifactId>
    <version>1.5.7</version>
</dependency>

Enable the SBA Client by configuring the URL of the Spring Boot Admin Server:

application.yml

spring.boot.admin.url: http://localhost:8080  (1)
management.security.enabled: false  (2)

1	The URL of the Spring Boot Admin Server to register at.
2	Since Spring Boot 1.5.x all endpoints are secured by default. For the sake of brevity we’re disabling the security for now. Have a look at the security section on how to deal with secured endpoints.

2.2.2. Spring Cloud Discovery

If you already use Spring Cloud Discovery for your applications you don’t need the SBA Client. Just make the Spring Boot Admin Server a DiscoveryClient, the rest is done by our AutoConfiguration.

The following steps are for using Eureka, but other Spring Cloud Discovery implementations are supported as well. There are examples using Consul and Zookeeper.

Also have a look at the Spring Cloud documentation.

Add spring-cloud-starter-eureka to you dependencies:

pom.xml

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-eureka</artifactId>
</dependency>

Enable discovery by adding @EnableDiscoveryClient to your configuration:

@Configuration
@EnableAutoConfiguration
@EnableDiscoveryClient
@EnableAdminServer
public class SpringBootAdminApplication {
  public static void main(String[] args) {
    SpringApplication.run(SpringBootAdminApplication.class, args);
  }
}

Tell the Eureka client where to find the service registry:

application.yml

eureka:  (1)
  instance:
    leaseRenewalIntervalInSeconds: 10
  client:
    registryFetchIntervalSeconds: 5
    serviceUrl:
      defaultZone: ${EUREKA_SERVICE_URL:http://localhost:8761}/eureka/

management.security.enabled: false  (2)

1	Configuration section for the Eureka client
2	Since Spring Boot 1.5.x all endpoints are secured by default. For the sake of brevity we’re disabling the security for now. Have a look at the security section on how to deal with secured endpoints.

You can include the Spring Boot Admin Server to your Eureka server. Setup everything as described above and set spring.boot.admin.context-path to something different than "/" so that the Spring Boot Admin Server UI won’t clash with Eureka’s one.

3. Client applications

3.1. Show version in application list

To have the version show up in the application list you can use the build-info goal from the spring-boot-maven-plugin, which generates the META-INF/build-info.properties. See also the Spring Boot Reference Guide.

pom.xml

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <executions>
                <execution>
                    <goals>
                        <goal>build-info</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

3.2. JMX-bean management

To interact with JMX-beans in the admin UI you have to include Jolokia in your application. In case you are using the spring-boot-admin-starter-client it will be pulled in for you, if not add Jolokia to your dependencies:

pom.xml

<dependency>
    <groupId>org.jolokia</groupId>
    <artifactId>jolokia-core</artifactId>
</dependency>

3.3. Loglevel management

For applications using Spring Boot 1.5.x (or later) you can manage loglevels out-of-the-box. For applications using older versions of Spring Boot the loglevel management is only available for Logback. It is accessed via JMX so include Jolokia in your application. In addition you have configure Logback’s JMXConfigurator:

logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
  <include resource="org/springframework/boot/logging/logback/base.xml"/>
  <jmxConfigurator/>
</configuration>

In case you are deploying multiple applications to the same JVM and multiple Logback-JMX-beans are present, the UI will select the JMXConfigurator with the context-name equals to your applications name. In this case you need to set the contextName in your logback-configuration.

3.4. Spring Boot Admin Client

The Spring Boot Admin Client registers the application at the admin server. This is done by periodically doing a HTTP post request to the SBA Server providing information about the application. It also adds Jolokia to your application, so that JMX-beans are accessible via HTTP.

There are plenty of properties to influence the way how the SBA Client registers your application. In case that doesn’t fit your needs, you can provide your own AppliationFactory implementation.

Table 1. Spring Boot Admin Client configuration options
Property name	Description	Default value
spring.boot.admin.client.enabled	Enables the Spring Boot Admin Client.	`true`
spring.boot.admin.url	Comma separated ordered list of URLs of the Spring Boot Admin server to register at. This triggers the AutoConfiguration. Mandatory.
spring.boot.admin.api-path	Http-path of registration endpoint at your admin server.	`"api/applications"`
spring.boot.admin.username spring.boot.admin.password	Username and password in case the SBA Server api is protected with HTTP Basic authentication.
spring.boot.admin.period	Interval for repeating the registration (in ms).	`10,000`
spring.boot.admin.connect-timeout	Connect timeout for the registration (in ms).	`5,000`
spring.boot.admin.read-timeout	Read timeout for the registration (in ms).	`5,000`
spring.boot.admin.auto-registration	If set to true the periodic task to register the application is automatically scheduled after the application is ready.	`true`
spring.boot.admin.auto-deregistration	Switch to enable auto-deregistration at Spring Boot Admin server when context is closed.	`false`
spring.boot.admin.register-once	If set to true the client will only register against one admin server (in order defined by `spring.boot.admin.url`); if that admin server goes down, will automatically register against the next admin server. If false, will register against all admin servers.	`true`
spring.boot.admin.client.health-url	Client-health-url to register with. Can be overridden in case the reachable URL is different (e.g. Docker). Must be unique in registry.	Guessed based on management-url and `endpoints.health.id`.
spring.boot.admin.client.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.	Guessed based on `management.port`, service-url and `server.servlet-path`.
spring.boot.admin.client.management-url	Management-url to register with. Can be overridden in case the reachable url is different (e.g. Docker).	Guessed based on management-base-url and `management.context-path`.
spring.boot.admin.client.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.	Guessed based on hostname, `server.port`.
spring.boot.admin.client.service-url	Client-service-url to register with. Can be overridden in case the reachable url is different (e.g. Docker).	Guessed based on service-base-url and `server.context-path`.
spring.boot.admin.client.name	Name to register with.	`${spring.application.name}` if set, `"spring-boot-application"` otherwise.
spring.boot.admin.client.prefer-ip	Use the ip-address rather then the hostname in the guessed urls. If `server.address` / `management.address` is set, it get used. Otherwise the IP address returned from `InetAddress.getLocalHost()` gets used.	`false`
spring.boot.admin.client.metadata.*	Metadata key-value-pairs to be associated with this instance.

Table 2. Instance metadata options
Key	Value	Default value
user.name user.password	Credentials being used to access the endpoints.

4. Spring Boot Admin Server

Table 3. 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	Time interval in ms to update the status of applications with expired status-information.	10,000
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.	10,000
spring.boot.admin.monitor.connect-timeout	Connect timeout in ms when querying the applications' status and info.	2,000
spring.boot.admin.monitor.read-timeout	Read timeout in ms when querying the applications' status and info.	5,000
spring.boot.admin.routes.endpoints	The enpoints which will be available via spring boot admin zuul proxy. If you write ui modules using other endpoints you need to add them.	`"env", "metrics", "trace", "dump", "jolokia", "info", "configprops", "activiti", "logfile", "refresh", "flyway", "liquibase", "loggers"`
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$"`

4.1. Spring Cloud Discovery

The Spring Boot Admin Server can use Spring Clouds DiscoveryClient to discover applications. The advantage is that the clients don’t have to include the spring-boot-admin-starter-client. You just have to add a DiscoveryClient implementation to your admin server - everything else is done by AutoConfiguration.

4.1.1. SimpleDiscoveryClient configuration

Spring Boot Admin ships with the SimpleDiscoveryClient included. This allows you to specify client applications via configuration, without adding the SBA Client or a DiscoveryClient implementation to your monitored applications:

application.yml

spring:
  cloud:
    discovery:
      client:
        simple:
          instances:
            test:
              - uri: http://instance1.intern:8080
                metadata:
                  management.context-path: /actuator
              - uri: http://instance2.intern:8080
                metadata:
                  management.context-path: /actuator

4.1.2. Other DiscoveryClient implementations (Eureka, Zookeeper, Consul, …)

Spring Boot Admin supports all other implementation of Spring Cloud’s DiscoveryClient. You need to add it to the Spring Boot Admin Server and configure it properly. An example setup using Eureka is shown above.

4.1.3. Converting ServiceInstances into monitored applications

The information from the service registry are converted by the ServiceInstanceConverter. Spring Boot Admin ships with a default and Eureka converter implementation. The correct one is selected by AutoConfiguration.

You can modify how the information from the registry is used to register the application by using SBA Server configuration options and instance metadata. The values from the metadata takes precedence over the server config. If the plenty of options don’t fit your needs you can provide your own ServiceInstanceConverter.

When using Eureka, the healthCheckUrl known to Eureka is used for health-checking, which can be set on your client using eureka.instance.healthCheckUrl.

Table 4. Instance metadata options
Key	Value	Default value
user.name user.password	Credentials being used to access the endpoints.
management.port	The port is substituted in the service URL and will be used for accessing the actuator endpoints.
management.context-path	The path is appended to the service URL and will be used for accessing the actuator endpoints.	`${spring.boot.admin.discovery.converter.mangement-context-path}`
health.path	The path is appended to the service URL and will be used for the health-checking. Ignored by the `EurekaServiceInstanceConverter`.	`${spring.boot.admin.discovery.converter.health-endpoint}`

Table 5. Discovery configuration options
Property name	Description	Default value
spring.boot.admin.discovery.enabled	Enables the DiscoveryClient-support for the admin server.	`true`
spring.boot.admin.discovery.converter.management-context-path	Will be appended to the service-url of the discovered service when the management-url is converted by the `DefaultServiceInstanceConverter`.
spring.boot.admin.discovery.converter.health-endpoint-path	Will be appended to the management-url of the discovered service when the health-url is converted by the `DefaultServiceInstanceConverter`.	`"health"`
spring.boot.admin.discovery.ignored-services	This services will be ignored when using discovery and not registered as application. Supports simple patterns (e.g. "foo", "bar", "foobar**").
spring.boot.admin.discovery.services	This services will be included when using discovery and registered as application. Supports simple patterns (e.g. "foo", "bar", "foobar**").	`"*"`

4.2. Clustering

Spring Boot Admin Server supports cluster replication via Hazelcast. It is automatically enabled when a HazelcastConfig- or HazelcastInstance-Bean is present. You can also configure the Hazelcast instance to be persistent, to keep the status over restarts. Also have a look at the Spring Boot support for Hazelcast.

Add Hazelcast to your dependencies:

pom.xml

<dependency>
    <groupId>com.hazelcast</groupId>
    <artifactId>hazelcast</artifactId>
</dependency>

Instantiate a HazelcastConfig:

@Configuration
@EnableAutoConfiguration
@EnableAdminServer
public class SpringBootAdminApplication {
  @Bean
  public Config hazelcastConfig() {
    return new Config().setProperty("hazelcast.jmx", "true")
        .addMapConfig(new MapConfig("spring-boot-admin-application-store").setBackupCount(1)
            .setEvictionPolicy(EvictionPolicy.NONE))
        .addListConfig(new ListConfig("spring-boot-admin-event-store").setBackupCount(1)
            .setMaxSize(1000));
  }

  public static void main(String[] args) {
    SpringApplication.run(SpringBootAdminApplication.class, args);
  }
}

Table 6. Hazelcast configuration options
Property name	Description	Default value
spring.boot.admin.hazelcast.enabled	Enables the Hazelcast support	`true`
spring.boot.admin.hazelcast.application-store	Name of the Hazelcast-map to store the applications	`"spring-boot-admin-application-store"`
spring.boot.admin.hazelcast.event-store	Name of the Hazelcast-list to store the events	`"spring-boot-admin-event-store"`

4.3. Notifications

Reminder notifications

The RemindingNotifier sends reminders for down/offline applications, it delegates the sending of notifications to another notifier.

By default a reminder is triggered when a registered application changes to DOWN or OFFLINE. You can alter this behaviour via setReminderStatuses(). The reminder ends when either the status changes to a non-triggering status or the regarding application gets deregistered.

By default the reminders are sent every 10 minutes, to change this use setReminderPeriod(). The RemindingNotifier itself doesn’t start the background thread to send the reminders, you need to take care of this as shown in the given example below;

How to configure reminders

@Configuration
@EnableScheduling
public class NotifierConfiguration {
    @Autowired
    private Notifier notifier;

    @Bean
    @Primary
    public RemindingNotifier remindingNotifier() {
        RemindingNotifier remindingNotifier = new RemindingNotifier(notifier);
        remindingNotifier.setReminderPeriod(TimeUnit.MINUTES.toMillis(5)); (1)
        return remindingNotifier;
    }

    @Scheduled(fixedRate = 60_000L) (2)
    public void remind() {
        remindingNotifier().sendReminders();
    }
}

1	The reminders will be sent every 5 minutes.
2	Schedules sending of due reminders every 60 seconds.

4.3.1. Filtering notifications

The FilteringNotifier allows you to filter certain notification based on rules you can add/remove at runtime. It delegates the sending of notifications to another notifier.

If you add a FilteringNotifier to your ApplicationContext a RESTful interface on api/notifications/filter gets available. When this happens the ui shows options to manage the filters.

This notifier is useful if you don’t want recieve notifications when deploying your applications. Before stopping the application you can add an (expiring) filter either via a POST request or the ui.

How to configure filtering

@Configuration
@EnableScheduling
public class NotifierConfiguration {
  @Autowired
  private Notifier delegate;

  @Bean
  public FilteringNotifier filteringNotifier() { (1)
    return new FilteringNotifier(delegate);
  }

  @Bean
  @Primary
  public RemindingNotifier remindingNotifier() { (2)
    RemindingNotifier notifier = new RemindingNotifier(filteringNotifier());
    notifier.setReminderPeriod(TimeUnit.SECONDS.toMillis(10));
    return notifier;
  }

  @Scheduled(fixedRate = 1_000L)
  public void remind() {
    remindingNotifier().sendReminders();
  }
}

1	Add the `FilteringNotifier` bean using a delegate (e.g. `MailNotifier` when configured)
2	Add the `RemindingNotifier` as primary bean using the `FilteringNotifier` as delegate.

This example combines the reminding and filtering notifiers. This allows you to get notifications after the deployed application hasn’t restarted in a certain amount of time (until the filter expires).

4.3.2. Mail notifications

Configure a JavaMailSender using spring-boot-starter-mail and set a recipient.

pom.xml

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-mail</artifactId>
</dependency>

application.properties

spring.mail.host=smtp.example.com
spring.boot.admin.notify.mail.to=admin@example.com

Table 7. Mail notifications configuration options
Property name	Description	Default value
spring.boot.admin.notify.mail.enabled	Enable mail notifications	`true`
spring.boot.admin.notify.mail.ignore-changes	Comma-delimited list of status changes to be ignored. Format: "<from-status>:<to-status>". Wildcards allowed.	`"UNKNOWN:UP"`
spring.boot.admin.notify.mail.to	Comma-delimited list of mail recipients	`"root@localhost"`
spring.boot.admin.notify.mail.cc	Comma-delimited list of carbon-copy recipients
spring.boot.admin.notify.mail.from	Mail sender
spring.boot.admin.notify.mail.subject	Mail subject. SpEL-expressions are supported	`"#{application.name} (#{application.id}) is #{to.status}"`
spring.boot.admin.notify.mail.text	Mail body. SpEL-expressions are supported	`"#{application.name} (#{application.id})\nstatus changed from #{from.status} to #{to.status}\n\n#{application.healthUrl}"`

4.3.3. PagerDuty notifications

To enable PagerDuty notifications you just have to add a generic service to your PagerDuty-account and set spring.boot.admin.notify.pagerduty.service-key to the service-key you received.

Table 8. PagerDuty notifications configuration options
Property name	Description	Default value
spring.boot.admin.notify.pagerduty.enabled	Enable mail notifications	`true`
spring.boot.admin.notify.pagerduty.ignore-changes	Comma-delimited list of status changes to be ignored. Format: "<from-status>:<to-status>". Wildcards allowed.	`"UNKNOWN:UP"`
spring.boot.admin.notify.pagerduty.service-key	Service-key to use for PagerDuty
spring.boot.admin.notify.pagerduty.url	The Pagerduty-rest-api url	`"https://events.pagerduty.com/generic/2010-04-15/create_event.json"`
spring.boot.admin.notify.pagerduty.description	Description to use in the event. SpEL-expressions are supported	`"#{application.name}/#{application.id} is #{to.status}"`
spring.boot.admin.notify.pagerduty.client	Client-name to use in the event
spring.boot.admin.notify.pagerduty.client-url	Client-url to use in the event

4.3.4. OpsGenie notifications

To enable OpsGenie notifications you just have to add a new JSON Rest API integration to your OpsGenie account and set spring.boot.admin.notify.opsgenie.api-key to the apiKey you received.

Table 9. OpsGenie notifications configuration options
Property name	Description	Default value
spring.boot.admin.notify.opsgenie.enabled	Enable OpsGenie notifications	`true`
spring.boot.admin.notify.opsgenie.ignore-changes	Comma-delimited list of status changes to be ignored. Format: "<from-status>:<to-status>". Wildcards allowed.	`"UNKNOWN:UP"`
spring.boot.admin.notify.opsgenie.api-key	apiKey you received when creating the integration
spring.boot.admin.notify.opsgenie.url	OpsGenie Alert API url	`"https://api.opsgenie.com/v1/json/alert"`
spring.boot.admin.notify.opsgenie.description	Description to use in the event. SpEL-expressions are supported	`"#{application.name}/#{application.id} is #{to.status}"`
spring.boot.admin.notify.opsgenie.recipients	User, group, schedule or escalation names to calculate which users will receive the notifications of the alert.
spring.boot.admin.notify.opsgenie.actions	Comma separated list of actions that can be executed.
spring.boot.admin.notify.opsgenie.source	Field to specify source of alert. By default, it will be assigned to IP address of incoming request.
spring.boot.admin.notify.opsgenie.tags	Comma separated list of labels attached to the alert.
spring.boot.admin.notify.opsgenie.entity	The entity the alert is related to.
spring.boot.admin.notify.opsgenie.user	Default owner of the execution. If user is not specified, the system becomes owner of the execution.

Hipchat notifications

To enable Hipchat notifications you need to create an API token from you Hipchat account and set the appropriate configuration properties.

Table 10. Hipchat notifications configuration options
Property name	Description	Default value
spring.boot.admin.notify.hipchat.enabled	Enable Hipchat notifications	`true`
spring.boot.admin.notify.hipchat.ignore-changes	Comma-delimited list of status changes to be ignored. Format: "<from-status>:<to-status>". Wildcards allowed.	`"UNKNOWN:UP"`
spring.boot.admin.notify.hipchat.url	The HipChat REST API (V2) URL
spring.boot.admin.notify.hipchat.auth-token	The API token with access to the notification room
spring.boot.admin.notify.hipchat.room-id	The ID or url-encoded name of the room to send notifications to
spring.boot.admin.notify.hipchat.notify	Whether the message should trigger a user notification	`false`
spring.boot.admin.notify.hipchat.description	Description to use in the event. SpEL-expressions are supported	`"<strong>#{application.name}</strong>/#{application.id} is <strong>#{to.status}</strong>"`

Slack notifications

To enable Slack notifications you need to add a incoming Webhook under custom integrations on your Slack account and configure it appropriately.

Table 11. Slack notifications configuration options
Property name	Description	Default value
spring.boot.admin.notify.slack.enabled	Enable Slack notifications	`true`
spring.boot.admin.notify.slack.ignore-changes	Comma-delimited list of status changes to be ignored. Format: "<from-status>:<to-status>". Wildcards allowed.	`"UNKNOWN:UP"`
spring.boot.admin.notify.slack.webhook-url	The Slack Webhook URL to send notifications
spring.boot.admin.notify.slack.channel	Optional channel name (without # at the beginning). If different than channel in Slack Webhooks settings
spring.boot.admin.notify.slack.icon	Optional icon name (without surrounding colons). If different than icon in Slack Webhooks settings
spring.boot.admin.notify.slack.username	Optional username to send notification if different than in Slack Webhooks settings	`Spring Boot Admin`
spring.boot.admin.notify.slack.message	Message to use in the event. SpEL-expressions and Slack markups are supported	`"#{application.name} (#{application.id}) is #{to.status}"`

Let’s Chat notifications

To enable Let’s Chat notifications you need to add the host url and add the API token and username from Let’s Chat

Table 12. Let’s Chat notifications configuration options
Property name	Description	Default value
spring.boot.admin.notify.letschat.enabled	Enable let´s Chat notifications	`true`
spring.boot.admin.notify.letschat.ignore-changes	Comma-delimited list of status changes to be ignored. Format: "<from-status>:<to-status>". Wildcards allowed.	`"UNKNOWN:UP"`
spring.boot.admin.notify.letschat.url	The let´s Chat Host URL to send notifications
spring.boot.admin.notify.letschat.room	the room where to send the messages
spring.boot.admin.notify.letschat.token	the token to access the let´s Chat API
spring.boot.admin.notify.letschat.username	The username for which the token was created	`Spring Boot Admin`
spring.boot.admin.notify.letschat.message	Message to use in the event. SpEL-expressions are supported	`"#{application.name} (#{application.id}) is #{to.status}"`

Microsoft Teams notifications

To enable Microsoft Teams notifications you need to setup a connector webhook url and set the appropriate configuration property.

Table 13. Microsoft Teams notifications configuration options
Property name	Description	Default value
spring.boot.admin.notify.ms-teams.enabled	Enable Microsoft Teams notifications	`true`
spring.boot.admin.notify.ms-teams.webhook-url	The Microsoft Teams webhook url to send the notifications to.
spring.boot.admin.notify.ms-teams.*	There are several options to customize the message title and color

Telegram notifications

To enable Telegram notifications you need to create and authorize a telegram bot and set the appropriate configuration properties for auth-token and chat-id.

Table 14. Microsoft Teams notifications configuration options
Property name	Description	Default value
spring.boot.admin.notify.telegram.enabled	Enable Microsoft Teams notifications	`true`
spring.boot.admin.notify.telegram.auth-token	The token identifiying und authorizing your Telegram bot (e.g. `123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11`).
spring.boot.admin.notify.telegram.chat-id	Unique identifier for the target chat or username of the target channel
spring.boot.admin.notify.telegram.disable-notify	If true users will receive a notification with no sound.	`false`
spring.boot.admin.notify.telegram.parse_mode	The parsing mode for the sent message. Currently `HTML' and `'Markdown'` are supported.	`'HTML'`
spring.boot.admin.notify.telegram.message	Text to send. SpEL-expressions are supported.	`"#{application.name}/#{application.id} is #{to.status}"`

4.4. UI Modules

Additional to the core UI there are following modules which can be included by adding the jar-file to the classpath:

spring-boot-admin-server-ui-activiti
spring-boot-admin-server-ui-hystrix
spring-boot-admin-server-ui-turbine

4.4.1. Hystrix UI Module

The Hystrix module uses the hystrix-dashboard to display the metrics from Hystrix streams.

Add the ui module to your classpath:

pom.xml

<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-server-ui-hystrix</artifactId>
    <version>1.5.7</version>
</dependency>

Add the /hystrix.stream to the proxified endpoints:

application.yml

spring.boot.admin.routes.endpoints: env,metrics,dump,jolokia,info,configprops,trace,logfile,refresh,flyway,liquibase,heapdump,loggers,auditevents,hystrix.stream

4.4.2. Turbine UI Module

The Turbine module uses the hystrix-dashboard to display the metrics from a Turbine stream. The UI module does not configure Turbine for you. Either you run Turbine as a separate application or integrate it into your Spring Boot Admin application. Please see Spring Cloud Reference on setting up Turbine.

Add the ui module to your classpath:

pom.xml

<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-server-ui-turbine</artifactId>
    <version>1.5.7</version>
</dependency>

Configure the Turbine server and clusters
application.yml
```
spring.boot.admin.turbine:
  clusters: default
  location: turbine  (1)
```
1 Configures the service with id turbine as Turbine server. URLs are also allowed.

Table 15. Turbine UI Module configuration options
Property name	Description	Default value
spring.boot.admin.turbine.enabled	Enable the Spring Boot Admin backend configuration for Turbine.	`true`
spring.boot.admin.turbine.location	ServiceId or URL (without the `/turbine.stream` path) for the Turbine server. Must be reachable from admin server.	`"turbine"`
spring.boot.admin.turbine.clusters	List of available Turbine clusters.	`"default"`

4.4.3. Activiti UI Module

The Activiti module shows information from the /activiti endpoint.

Add the ui module to your classpath:

pom.xml

<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-server-ui-activiti</artifactId>
    <version>1.5.7</version>
</dependency>

Add the /activiti to the proxified endpoints:

application.yml

spring.boot.admin.routes.endpoints: env,metrics,dump,jolokia,info,configprops,trace,logfile,refresh,flyway,liquibase,heapdump,activiti

4.4.4. Login UI Module

The Login module just provides you a login page and a logout button.

Add the ui module to your classpath:

pom.xml

<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-server-ui-login</artifactId>
    <version>1.5.7</version>
</dependency>

5. Security

5.1. Securing Spring Boot Admin Server

Since there are several approaches on solving authentication and authorization in distributed web applications Spring Boot Admin doesn’t ship a default one. If you include the spring-boot-admin-server-ui-login in your dependencies it will provide a login page and a logout button.

A Spring Security configuration could look like this:

  @Configuration
  public static class SecurityConfig extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
      // Page with login form is served as /login.html and does a POST on /login
      http.formLogin().loginPage("/login.html").loginProcessingUrl("/login").permitAll();
      // The UI does a POST on /logout on logout
      http.logout().logoutUrl("/logout");
      // The ui currently doesn't support csrf
      http.csrf().disable();

      // Requests for the login page and the static assets are allowed
      http.authorizeRequests()
          .antMatchers("/login.html", "/**/*.css", "/img/**", "/third-party/**")
          .permitAll();
      // ... and any other request needs to be authorized
      http.authorizeRequests().antMatchers("/**").authenticated();

      // Enable so that the clients can authenticate via HTTP basic for registering
      http.httpBasic();
    }
  }

For a complete sample look at spring-boot-admin-sample.

If you protect the /api/applications endpoint don’t forget to configure the username and password on your SBA-Client using spring.boot.admin.username and spring.boot.admin.password.

There are more samples (e.g. using OAuth2) in joshiste/spring-boot-admin-samples.

5.2. Securing Client Actuator Endpoints

When the actuator endpoints are secured using HTTP Basic authentication the SBA Server needs credentials to access them. You can submit the credentials in the metadata when registering the application. The BasicAuthHttpHeaderProvider then uses this metadata to add the Authorization header to access your application’s actuator endpoints. You can provide your own HttpHeadersProvider to alter the behaviour (e.g. add some decryption) or add extra headers.

Submitting the credentials using SBA Client:

application.yml

spring.boot.admin:
  url: http://localhost:8080
  client:
    metadata:
      user.name: ${security.user.name}
      user.password: ${security.user.password}

Submitting the credentials using Eureka:

application.yml

eureka:
  instance:
    metadata-map:
      user.name: ${security.user.name}
      user.password: ${security.user.password}

The SBA Server masks certain metadata in the HTTP interface to prevent leaking of sensitive information.

You should configure HTTPS for your SBA Server or (service registry) when submitting credentials via the metadata.

When using Spring Cloud Discovery, you must be aware that anybody who can query your service registry can obtain the credentials.

When using this approach the SBA Server decides whether or not the user can access the registered applications. There are more complex solutions possible (using OAuth2) to let the clients decide if the user can access the endpoints. For that please have a look at the samples in joshiste/spring-boot-admin-samples.

6. FAQs

Can I include spring-boot-admin into my business application?: tl;dr You can, but you shouldn’t.
You can set spring.boot.admin.context-path to alter the path where the UI and REST-API is served, but depending on the complexity of your application you might get in trouble. On the other hand in my opinion it makes no sense for an application to monitor itself. In case your application goes down your monitoring tool also does.
How do I customize the UI?: You can only customize the UI by copying and modifying the source of spring-boot-admin-ui and adding your own module to your classpath.