Spring Boot Admin

https://docs.spring-boot-admin.com/3.5.6/docs/
Admin
Spring Boot Admin is a web application that provides a user interface to manage and monitor Spring...
Tokens:31,491
Snippets:365
Trust Score:5.5
Update:5 days ago
Show doc for...
Tokens:
Raw
### Install pyctuator package

Source: https://docs.spring-boot-admin.com/3.5.6/docs/third-party/pyctuator

Install the required pyctuator package using pip.

```bash
pip install pyctuator
```

--------------------------------

### GET /instances/events

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/Events

Returns all instance events as a JSON array. Use this to retrieve the complete event history for all registered instances on UI startup.

```APIDOC
## GET /instances/events

### Description
Returns all instance events as a JSON array. Use this to retrieve the complete event history for all registered instances on UI startup.

### Method
GET

### Endpoint
/instances/events

### Response
#### Success Response (200)
Returns a JSON array of instance events.

```

--------------------------------

### GET /instances/events (SSE)

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/Events

Returns a continuous stream of instance events using Server-Sent Events (SSE). Useful for real-time monitoring and UI updates.

```APIDOC
## GET /instances/events (SSE)

### Description
Returns a continuous stream of instance events using Server-Sent Events (SSE). Useful for real-time monitoring and UI updates.

### Method
GET

### Endpoint
/instances/events

### Headers
- **Accept** (string) - Required - Must be `text/event-stream`

### Response
#### Success Response (200)
Returns a continuous stream of instance events using Server-Sent Events (SSE).

```

--------------------------------

### GET /instances/{id} (SSE)

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/Events

Streams events for a single instance, identified by its ID. Useful for real-time monitoring of a specific instance.

```APIDOC
## GET /instances/{id} (SSE)

### Description
Streams events for a single instance, identified by its ID.

### Method
GET

### Endpoint
/instances/{id}

### Headers
- **Accept** (string) - Required - Must be `text/event-stream`

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the instance.

### Response
#### Success Response (200)
Returns a continuous stream of instance events for the specified instance.

```

--------------------------------

### GET notifications/filter

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/notifications

Returns a list of all registered notification filters. Each filter contains attributes id, applicationName, expiry, and expired.

```APIDOC
## GET notifications/filter

### Description
Returns a list of all registered notification filters. Each filter contains attributes id, applicationName, expiry, and expired.

### Method
GET

### Endpoint
notifications/filter

### Response
#### Success Response (200)
- **id** (string) - The filter identifier.
- **applicationName** (string) - The application name associated with the filter.
- **expiry** (string) - The expiration time of the filter.
- **expired** (boolean) - Indicates whether the filter has expired.

#### Response Example
[
  {
    "id": "string",
    "applicationName": "string",
    "expiry": "string",
    "expired": true
  }
]
```

--------------------------------

### Add Spring Cloud Starter dependency

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/server

Include the spring-cloud-starter dependency in your pom.xml to enable DiscoveryClient support.

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

--------------------------------

### Configure SimpleDiscoveryClient instances

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/server

Define static client application instances in application.yml using the SimpleDiscoveryClient configuration.

```yaml
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
```

--------------------------------

### Configure routes.txt

Source: https://docs.spring-boot-admin.com/3.5.6/docs/customize/extend_ui

Defines the routes for the custom views in the routes.txt configuration file.

```text
/custom/**  
/customSub/**
```

--------------------------------

### SBA Server Instance Authentication Configuration

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/security

Configure default and service-specific credentials in the SBA Server using application.yml.

```yaml
spring.boot.admin:  
  instance-auth:  
    enabled: true  
    default-user-name: "${some.user.name.from.secret}"  
    default-password: "${some.user.password.from.secret}"  
    service-map:  
      my-first-service-to-monitor:  
        user-name: "${some.user.name.from.secret}"  
        user-password: "${some.user.password.from.secret}"  
      my-second-service-to-monitor:  
        user-name: "${some.user.name.from.secret}"  
        user-password: "${some.user.password.from.secret}"  
```

--------------------------------

### Configure instance tags

Source: https://docs.spring-boot-admin.com/3.5.6/docs/client/client-features

Add tags to instances via metadata or the info endpoint in application.properties to display visual markers in the admin UI.

```properties
#using the metadata  
spring.boot.admin.client.instance.metadata.tags.environment=test  
  
#using the info endpoint  
info.tags.environment=test  
```

--------------------------------

### Add spring-boot-starter-mail dependency

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/notifications/notifier-mail

Include the spring-boot-starter-mail dependency in your project to enable mail functionality.

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

--------------------------------

### Configure Admin Client Properties

Source: https://docs.spring-boot-admin.com/3.5.6/docs/installation-and-setup

Set the server URL and expose necessary actuator endpoints in your application.properties file.

```properties
spring.boot.admin.client.url=http://localhost:8080  #1  
management.endpoints.web.exposure.include=*  #2  
management.info.env.enabled=true #3
```

--------------------------------

### Add Spring Boot Admin Client Dependencies

Source: https://docs.spring-boot-admin.com/3.5.6/docs/installation-and-setup

Include the spring-boot-admin-starter-client and spring-boot-starter-security dependencies in your pom.xml to enable client-side registration.

```xml
<project>  
    <dependency>  
        <groupId>de.codecentric</groupId>  
        <artifactId>spring-boot-admin-starter-client</artifactId>  
        <version>3.5.6</version>  
    </dependency>  
    <dependency>  
        <groupId>org.springframework.boot</groupId>  
        <artifactId>spring-boot-starter-security</artifactId>  
    </dependency>  
</project>
```

--------------------------------

### Register a custom view with SBA.use

Source: https://docs.spring-boot-admin.com/3.5.6/docs/customize/extend_ui

Use the SBA.use function to register a new view, define its path and component, and merge i18n locale messages for labels.

```javascript
SBA.use({  
  install({ viewRegistry, i18n }) {  
    viewRegistry.addView({  
      name: "custom", //(1)  
      path: "/custom", //(2)  
      component: custom, //(3)  
      group: "custom", //(4)  
      handle, //(5)  
      order: 1000, //(6)  
    });  
    i18n.mergeLocaleMessage("en", {  
      custom: {  
        label: "My Extensions", //(7)  
      },  
    });  
    i18n.mergeLocaleMessage("de", {  
      custom: {  
        label: "Meine Erweiterung",  
      },  
    });  
  },  
});
```

--------------------------------

### Configure build-info in pom.xml

Source: https://docs.spring-boot-admin.com/3.5.6/docs/client/client-features

Add the spring-boot-maven-plugin with the build-info goal to your pom.xml to display the application version in the admin list.

```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>  
```

--------------------------------

### Add Eureka Client Dependency

Source: https://docs.spring-boot-admin.com/3.5.6/docs/installation-and-setup

Include the spring-cloud-starter-netflix-eureka-client dependency in your pom.xml to use Eureka for service discovery.

```xml
<dependency>  
    <groupId>org.springframework.cloud</groupId>  
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>  
</dependency>
```

--------------------------------

### Add dependencies to pom.xml

Source: https://docs.spring-boot-admin.com/3.5.6/docs/installation-and-setup

Include the spring-boot-admin-starter-server and spring-boot-starter-web dependencies in your Maven project configuration.

```xml
<project>  
    <dependency>  
        <groupId>de.codecentric</groupId>  
        <artifactId>spring-boot-admin-starter-server</artifactId>  
        <version>3.5.6</version>  
    </dependency>  
    <dependency>  
        <groupId>org.springframework.boot</groupId>  
        <artifactId>spring-boot-starter-web</artifactId>  
    </dependency>  
</project>
```

--------------------------------

### SBA Client Metadata Configuration

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/security

Configure the SBA Client to send credentials via metadata in application.yml.

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

--------------------------------

### Register an Instance View

Source: https://docs.spring-boot-admin.com/3.5.6/docs/customize/extend_ui

Registers a view specifically for an instance. The parent must be 'instances', and the isEnabled callback determines if the view should be shown.

```javascript
SBA.viewRegistry.addView({  
  name: "instances/custom",  
  parent: "instances", // (1)  
  path: "custom",  
  component: customEndpoint,  
  label: "Custom",  
  group: "custom", // (2)  
  order: 1000,  
  isEnabled: ({ instance }) => {  
    return instance.hasEndpoint("custom");  
  }, // (3)  
});
```

--------------------------------

### Configure Custom Color Theme in application.yml

Source: https://docs.spring-boot-admin.com/3.5.6/docs/customize/customize_ui

Define a custom color theme and palette for the application UI using YAML configuration.

```yaml
spring:  
  boot:  
    admin:  
      ui:  
        theme:  
          color: "#4A1420"  
          palette:  
            50: "#F8EBE4"  
            100: "#F2D7CC"  
            200: "#E5AC9C"  
            300: "#D87B6C"  
            400: "#CB463B"  
            500: "#9F2A2A"  
            600: "#83232A"  
            700: "#661B26"  
            800: "#4A1420"  
            900: "#2E0C16"
```

--------------------------------

### Configure build-info in build.gradle

Source: https://docs.spring-boot-admin.com/3.5.6/docs/client/client-features

Add the buildInfo() method to the springBoot configuration block in your build.gradle file.

```groovy
springBoot {  
    buildInfo()  
}  
```

--------------------------------

### Enable Discovery Client

Source: https://docs.spring-boot-admin.com/3.5.6/docs/installation-and-setup

Annotate your main application class with @EnableDiscoveryClient to enable service discovery features.

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

--------------------------------

### Configure a dropdown menu for external links

Source: https://docs.spring-boot-admin.com/3.5.6/docs/customize/extend_ui

Aggregate multiple links under a single dropdown element in the navbar by defining a children list within the external-views configuration.

```yaml
spring:  
  boot:  
    admin:  
      ui:  
        external-views:  
          - label: Link w/o children  
            children:  
              - label: "📖 Docs"  
                url: https://codecentric.github.io/spring-boot-admin/current/  
              - label: "📦 Maven"  
                url: https://search.maven.org/search?q=g:de.codecentric%20AND%20a:spring-boot-admin-starter-server  
              - label: "🐙 GitHub"  
                url: https://github.com/codecentric/spring-boot-admin
```

--------------------------------

### Configure logfile endpoint and ANSI colors

Source: https://docs.spring-boot-admin.com/3.5.6/docs/client/client-features

Set the logfile path and a custom pattern with ANSI colors in application.properties to enable the logfile viewer.

```properties
logging.file.name=/var/log/sample-boot-application.log (1)  
logging.pattern.file=%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(%5p) %clr(${PID}){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n%wEx (2)  
```

--------------------------------

### Create a Top-Level View Component

Source: https://docs.spring-boot-admin.com/3.5.6/docs/customize/extend_ui

A Vue component that lists all registered applications using the SBA application store.

```vue
<template>  
  <div class="m-4">  
    <template v-for="application in applications" :key="application.name">  
      <sba-panel :title="application.name">  
        This application has the following instances:  
  
        <ul>  
          <template v-for="instance in application.instances">  
            <li>  
              <span class="mx-1" v-text="instance.registration.name"></span>  
  
              <!-- SBA components are registered globally and can be used without importing them! -->  
              <!-- They are defined in spring-boot-admin-server-ui -->  
              <sba-status :status="instance.statusInfo.status" class="mx-1" />  
              <sba-tag :value="instance.id" class="mx-1" label="id" />  
            </li>  
          </template>  
        </ul>  
      </sba-panel>  
    </template>  
    <pre v-text="applications"></pre>  
  </div>  
</template>  
  
<script>  
/* global SBA */  
import "./custom.css";  
  
export default {  
  setup() {  
    const { applications } = SBA.useApplicationStore(); //(1)  
    return {  
      applications,  
    };  
  },  
  methods: {  
    stringify: JSON.stringify,  
  },  
};  
</script>
```

--------------------------------

### Spring Security Configuration for Admin Server

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/security

A sample SecuritySecureConfig.java class demonstrating how to configure the SecurityFilterChain, CSRF protection, and user details for the Spring Boot Admin server.

```java
@Configuration(proxyBeanMethods = false)  
public class SecuritySecureConfig {  
  
    private final AdminServerProperties adminServer;  
  
    private final SecurityProperties security;  
  
    public SecuritySecureConfig(AdminServerProperties adminServer, SecurityProperties security) {  
        this.adminServer = adminServer;  
        this.security = security;  
    }  
  
    @Bean  
    protected SecurityFilterChain filterChain(HttpSecurity http) throws Exception {  
        SavedRequestAwareAuthenticationSuccessHandler successHandler = new SavedRequestAwareAuthenticationSuccessHandler();  
        successHandler.setTargetUrlParameter("redirectTo");  
        successHandler.setDefaultTargetUrl(this.adminServer.path("/"));  
  
        http.authorizeHttpRequests((authorizeRequests) -> authorizeRequests //  
            .requestMatchers(new AntPathRequestMatcher(this.adminServer.path("/assets/**")))  
            .permitAll() // (1)  
            .requestMatchers(new AntPathRequestMatcher(this.adminServer.path("/actuator/info")))  
            .permitAll()  
            .requestMatchers(new AntPathRequestMatcher(adminServer.path("/actuator/health")))  
            .permitAll()  
            .requestMatchers(new AntPathRequestMatcher(this.adminServer.path("/login")))  
            .permitAll()  
            .dispatcherTypeMatchers(DispatcherType.ASYNC)  
            .permitAll() // https://github.com/spring-projects/spring-security/issues/11027  
            .anyRequest()  
            .authenticated()) // (2)  
            .formLogin(  
                    (formLogin) -> formLogin.loginPage(this.adminServer.path("/login")).successHandler(successHandler)) // (3)  
            .logout((logout) -> logout.logoutUrl(this.adminServer.path("/logout")))  
            .httpBasic(Customizer.withDefaults()); // (4)  
  
        http.addFilterAfter(new CustomCsrfFilter(), BasicAuthenticationFilter.class) // (5)  
            .csrf((csrf) -> csrf.csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse())  
                .csrfTokenRequestHandler(new CsrfTokenRequestAttributeHandler())  
                .ignoringRequestMatchers(  
                        new AntPathRequestMatcher(this.adminServer.path("/instances"), POST.toString()), // (6)  
                        new AntPathRequestMatcher(this.adminServer.path("/instances/*"), DELETE.toString()), // (6)  
                        new AntPathRequestMatcher(this.adminServer.path("/actuator/**")) // (7)  
                ));  
  
        http.rememberMe((rememberMe) -> rememberMe.key(UUID.randomUUID().toString()).tokenValiditySeconds(1209600));  
  
        return http.build();  
  
    }  
  
    // Required to provide UserDetailsService for "remember functionality"  
    @Bean  
    public InMemoryUserDetailsManager userDetailsService(PasswordEncoder passwordEncoder) {  
        UserDetails user = User.withUsername("user").password(passwordEncoder.encode("password")).roles("USER").build();  
        return new InMemoryUserDetailsManager(user);  
    }  
  
    @Bean  
    public PasswordEncoder passwordEncoder() {  
        return new BCryptPasswordEncoder();  
    }  
  
}  
```

--------------------------------

### CloudFoundry Eureka metadata configuration in application.yml

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/server

Sample configuration for Eureka when deploying to CloudFoundry. Requires vcap.application.application_id and vcap.application.instance_index in the metadata-map for proper registration with Spring Boot Admin Server.

```yaml
eureka:  
  instance:  
    hostname: ${vcap.application.uris[0]}  
    nonSecurePort: 80  
    metadata-map:  
      applicationId: ${vcap.application.application_id}  
      instanceId: ${vcap.application.instance_index}  

```

--------------------------------

### Instantiate HazelcastConfig bean

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/Clustering

Define a HazelcastConfig bean to configure the event store and notification deduplication maps, as well as network settings.

```java
@Bean  
public Config hazelcastConfig() {  
    // This map is used to store the events.  
    // It should be configured to reliably hold all the data,  
    // Spring Boot Admin will compact the events, if there are too many  
    MapConfig eventStoreMap = new MapConfig(DEFAULT_NAME_EVENT_STORE_MAP).setInMemoryFormat(InMemoryFormat.OBJECT)  
            .setBackupCount(1)  
            .setMergePolicyConfig(new MergePolicyConfig(PutIfAbsentMergePolicy.class.getName(), 100));  
    // This map is used to deduplicate the notifications.  
    // If data in this map gets lost it should not be a big issue as it will atmost  
    // lead to  
    // the same notification to be sent by multiple instances  
    MapConfig sentNotificationsMap = new MapConfig(DEFAULT_NAME_SENT_NOTIFICATIONS_MAP)  
            .setInMemoryFormat(InMemoryFormat.OBJECT)  
            .setBackupCount(1)  
            .setEvictionConfig(  
                    new EvictionConfig().setEvictionPolicy(EvictionPolicy.LRU).setMaxSizePolicy(MaxSizePolicy.PER_NODE))  
            .setMergePolicyConfig(new MergePolicyConfig(PutIfAbsentMergePolicy.class.getName(), 100));  
  
    Config config = new Config();  
    config.addMapConfig(eventStoreMap);  
    config.addMapConfig(sentNotificationsMap);  
    config.setProperty("hazelcast.jmx", "true");  
  
    // network and join configuration (simple defaults good for local/dev)  
    NetworkConfig network = config.getNetworkConfig();  
    network.setPort(5701).setPortAutoIncrement(true);  
  
    JoinConfig join = network.getJoin();  
    join.getMulticastConfig().setEnabled(true);  
  
    return config;  
}  
```

--------------------------------

### Enable Admin Server in SpringBootApplication

Source: https://docs.spring-boot-admin.com/3.5.6/docs/installation-and-setup

Annotate your main application class with @EnableAdminServer to activate the Spring Boot Admin Server functionality.

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

--------------------------------

### Configure Maven repositories for snapshots in pom.xml

Source: https://docs.spring-boot-admin.com/3.5.6/docs/snapshots

Add these repository definitions to your pom.xml to enable access to Spring milestone, Spring snapshot, and Sonatype Nexus snapshot repositories.

```xml
<repositories>  
    <repository>  
        <id>spring-milestone</id>  
        <snapshots>  
            <enabled>false</enabled>  
        </snapshots>  
        <url>http://repo.spring.io/milestone</url>  
    </repository>  
    <repository>  
        <id>spring-snapshot</id>  
        <snapshots>  
            <enabled>true</enabled>  
        </snapshots>  
        <url>http://repo.spring.io/snapshot</url>  
    </repository>  
    <repository>  
        <id>sonatype-nexus-snapshots</id>  
        <name>Sonatype Nexus Snapshots</name>  
        <url>https://oss.sonatype.org/content/repositories/snapshots/</url>  
        <snapshots>  
            <enabled>true</enabled>  
        </snapshots>  
        <releases>  
            <enabled>false</enabled>  
        </releases>  
    </repository>  
</repositories>  
```

--------------------------------

### Configure mail properties in application.properties

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/notifications/notifier-mail

Set the SMTP host and the recipient address for mail notifications.

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

--------------------------------

### Configure Eureka Client

Source: https://docs.spring-boot-admin.com/3.5.6/docs/installation-and-setup

Define the Eureka service registry URL and management endpoints in your application.yml file.

```yaml
spring:  
  application:  
    name: spring-boot-admin-sample-eureka  
  profiles:  
    active:  
      - secure  
eureka:  
  instance:  
    leaseRenewalIntervalInSeconds: 10  
    health-check-url-path: /actuator/health  
    metadata-map:  
      startup: ${random.int}    # needed to trigger info and endpoint update after restart  
  client:  
    registryFetchIntervalSeconds: 5  
    serviceUrl:  
      defaultZone: http://localhost:8761/eureka/  
management:  
  endpoints:  
    web:  
      exposure:  
        include: "*"  
  endpoint:  
    health:  
      show-details: ALWAYS
```

--------------------------------

### Create a dropdown with a primary link and children

Source: https://docs.spring-boot-admin.com/3.5.6/docs/customize/extend_ui

Define a dropdown that acts as a link itself while also containing child links, and optionally enable iframe embedding for specific views.

```yaml
spring:  
  boot:  
    admin:  
      ui:  
        external-views:  
          - label: Link w children  
            url: https://codecentric.de  #(1)  
            children:  
              - label: "📖 Docs"  
                url: https://codecentric.github.io/spring-boot-admin/current/  
              - label: "📦 Maven"  
                url: https://search.maven.org/search?q=g:de.codecentric%20AND%20a:spring-boot-admin-starter-server  
              - label: "🐙 GitHub"  
                url: https://github.com/codecentric/spring-boot-admin  
          - label: "🎅 Is it christmas"  
            url: https://isitchristmas.com  
            iframe: true
```

--------------------------------

### Enable Pyctuator in Flask app.py

Source: https://docs.spring-boot-admin.com/3.5.6/docs/third-party/pyctuator

Initialize Pyctuator in your Flask application by providing the app instance, application name, URLs, and the Spring Boot Admin registration URL.

```python
import os    
from flask import Flask    
from pyctuator.pyctuator import Pyctuator    
app_name = "Flask App with Pyctuator"    
app = Flask(app_name)    
@app.route("/")    
def hello():    
    return "Hello World!"    
Pyctuator(    
    app,    
    app_name,    
    app_url="http://example-app.com",    
    pyctuator_endpoint_url="http://example-app.com/pyctuator",    
    registration_url=os.getenv("SPRING_BOOT_ADMIN_URL")    
)    
app.run()
```

--------------------------------

### Implement CustomNotifier.java

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/notifications

Create a custom notifier by extending AbstractEventNotifier. This implementation logs instance status changes and other events.

```java
public class CustomNotifier extends AbstractEventNotifier {  
  
    private static final Logger LOGGER = LoggerFactory.getLogger(CustomNotifier.class);  
  
    public CustomNotifier(InstanceRepository repository) {  
        super(repository);  
    }  
  
    @Override  
    protected Mono<Void> doNotify(InstanceEvent event, Instance instance) {  
        return Mono.fromRunnable(() -> {  
            if (event instanceof InstanceStatusChangedEvent statusChangedEvent) {  
                LOGGER.info("Instance {} ({}) is {}", instance.getRegistration().getName(), event.getInstance(),  
                        statusChangedEvent.getStatusInfo().getStatus());  
            }  
            else {  
                LOGGER.info("Instance {} ({}) {}", instance.getRegistration().getName(), event.getInstance(),  
                        event.getType());  
            }  
        });  
    }  
}  
```

--------------------------------

### Add a simple external link to the navbar

Source: https://docs.spring-boot-admin.com/3.5.6/docs/customize/extend_ui

Configure a single external link in the navbar using the spring.boot.admin.ui.external-views property in application.yml.

```yaml
spring:  
  boot:  
    admin:  
      ui:  
        external-views:  
          - label: "🚀" #(1)  
            url: "https://codecentric.de" #(2)  
            order: 2000 #(3)
```

--------------------------------

### Implement HttpHeadersProvider bean

Source: https://docs.spring-boot-admin.com/3.5.6/docs/customize/customize_http-headers

Define a custom HttpHeadersProvider bean to inject headers like X-CUSTOM into requests made to monitored application actuator endpoints.

```java
@Bean  
public HttpHeadersProvider customHttpHeadersProvider() {  
    return (instance) -> {  
        HttpHeaders httpHeaders = new HttpHeaders();  
        httpHeaders.add("X-CUSTOM", "My Custom Value");  
        return httpHeaders;  
    };  
}  
```

--------------------------------

### Configure RemindingNotifier in NotifierConfiguration.java

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/notifications

Configures the RemindingNotifier bean with a 10-minute reminder period and a 10-second check interval. The initMethod and destroyMethod ensure the background thread is managed correctly.

```java
@Configuration  
public class NotifierConfiguration {  
    @Autowired  
    private Notifier notifier;  
  
    @Primary  
    @Bean(initMethod = "start", destroyMethod = "stop")  
    public RemindingNotifier remindingNotifier() {  
        RemindingNotifier notifier = new RemindingNotifier(notifier, repository);  
        notifier.setReminderPeriod(Duration.ofMinutes(10)); // (1)  
        notifier.setCheckReminderInverval(Duration.ofSeconds(10)); //(2)  
        return notifier;  
    }  
}  
```

--------------------------------

### Consul Metadata Configuration

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/security

Configure credentials in Consul metadata within application.yml. Note that Consul requires dashes instead of dots in metadata keys.

```yaml
spring.cloud.consul:  
  discovery:  
    metadata:  
        user-name: ${spring.security.user.name}  
        user-password: ${spring.security.user.password}  
```

--------------------------------

### Register a Top-Level View

Source: https://docs.spring-boot-admin.com/3.5.6/docs/customize/extend_ui

Registers a new view in the SBA view registry. The parent property references the name of the parent view, and the path is used for navigation.

```javascript
SBA.viewRegistry.addView({  
  name: "customSub",  
  parent: "custom", // (1)  
  path: "/customSub", // (2)  
  component: customSubitem,  
  label: "Custom Sub",  
  order: 1000,  
});
```

--------------------------------

### POST notifications/filters

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/notifications

Posts a new notification filter for the application/instance of the given instanceId or applicationName. Either instanceId or applicationName must be set. The parameter ttl is optional and represents the expiration of the filter as an instant (the number of seconds from the epoch of 1970-01-01T00:00:00Z).

```APIDOC
## POST notifications/filters

### Description
Posts a new notification filter for the application/instance of the given instanceId or applicationName. Either instanceId or applicationName must be set. The parameter ttl is optional and represents the expiration of the filter as an instant (the number of seconds from the epoch of 1970-01-01T00:00:00Z).

### Method
POST

### Endpoint
notifications/filters

### Parameters
#### Query Parameters
- **instanceId** (string) - Optional - The instance ID to filter.
- **applicationName** (string) - Optional - The application name to filter.
- **ttl** (string) - Optional - The expiration of the filter as an instant (seconds from epoch).
```

--------------------------------

### Configure FilteringNotifier and RemindingNotifier in NotifierConfig.java

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/notifications

Combines FilteringNotifier and RemindingNotifier to allow for filtered notifications during deployments. The FilteringNotifier acts as a delegate for the RemindingNotifier.

```java
@Configuration(proxyBeanMethods = false)  
public class NotifierConfig {  
  
    private final InstanceRepository repository;  
  
    private final ObjectProvider<List<Notifier>> otherNotifiers;  
  
    public NotifierConfig(InstanceRepository repository, ObjectProvider<List<Notifier>> otherNotifiers) {  
        this.repository = repository;  
        this.otherNotifiers = otherNotifiers;  
    }  
  
    @Bean  
    public FilteringNotifier filteringNotifier() { // (1)  
        CompositeNotifier delegate = new CompositeNotifier(this.otherNotifiers.getIfAvailable(Collections::emptyList));  
        return new FilteringNotifier(delegate, this.repository);  
    }  
  
    @Primary  
    @Bean(initMethod = "start", destroyMethod = "stop")  
    public RemindingNotifier remindingNotifier() { // (2)  
        RemindingNotifier notifier = new RemindingNotifier(filteringNotifier(), this.repository);  
        notifier.setReminderPeriod(Duration.ofMinutes(10));  
        notifier.setCheckReminderInverval(Duration.ofSeconds(10));  
        return notifier;  
    }  
  
}  
```

--------------------------------

### Eureka Metadata Configuration

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/security

Configure credentials in Eureka metadata-map within application.yml.

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

--------------------------------

### Add Hazelcast dependency to pom.xml

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/Clustering

Include the Hazelcast dependency in your project's pom.xml file to enable clustering support.

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

--------------------------------

### Spring Boot Admin Client Credentials Configuration

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/security

Configuration for the Spring Boot Admin Client to authenticate with the server using username and password.

```yaml
spring.boot.admin.client:  
   username: sba-client  
   password: s3cret  
```

--------------------------------

### Visualize a Custom Endpoint

Source: https://docs.spring-boot-admin.com/3.5.6/docs/customize/extend_ui

A Vue component that fetches data from a custom actuator endpoint using the instance's preconfigured axios instance.

```vue
<template>  
  <div class="custom">  
    <p>Instance: <span v-text="instance.id" /></p>  
    <p>Output: <span v-html="text" /></p>  
  </div>  
</template>  
  
<script>  
export default {  
  props: {  
    instance: {  
      //(1)  
      type: Object,  
      required: true,  
    },  
  },  
  data: () => ({  
    text: "",  
  }),  
  async created() {  
    console.log(this.instance);  
    const response = await this.instance.axios.get("actuator/custom"); //(2)  
    this.text = response.data;  
  },  
};  
</script>  
  
<style lang="css" scoped>  
.custom {  
  font-size: 20px;  
  width: 80%;  
}  
</style>
```

--------------------------------

### Add Jolokia dependency for Spring Boot 2

Source: https://docs.spring-boot-admin.com/3.5.6/docs/client/client-features

Include the jolokia-core dependency in your pom.xml for Spring Boot 2 applications to enable JMX-bean management.

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

--------------------------------

### Add Jolokia dependency for Spring Boot 3

Source: https://docs.spring-boot-admin.com/3.5.6/docs/client/client-features

Include the jolokia-support-spring dependency in your pom.xml for Spring Boot 3 applications to enable JMX-bean management.

```xml
<dependency>  
    <groupId>org.jolokia</groupId>  
    <artifactId>jolokia-support-spring</artifactId>  
    <version>2.1.0</version>  
</dependency>  
```

--------------------------------

### CustomHttpInterceptor.java - Audit Log Bean

Source: https://docs.spring-boot-admin.com/3.5.6/docs/customize/customize_interceptors

Defines a Spring bean that implements InstanceExchangeFilterFunction to log DELETE and POST requests to actuator endpoints. The log includes the HTTP method, instance ID, and request URL. Use this for auditing or extra security checks.

```java
@Bean  
public InstanceExchangeFilterFunction auditLog() {  
    return (instance, request, next) -> next.exchange(request).doOnSubscribe((s) -> {  
        if (HttpMethod.DELETE.equals(request.method()) || HttpMethod.POST.equals(request.method())) {  
            log.info("{} for {} on {}", request.method(), instance.getId(), request.url());  
        }  
    });  
}  

```

--------------------------------

### Configure Custom ClientHttpConnector for Mutual TLS in CustomHttpClientConfig.java

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/security

Defines a custom ClientHttpConnector bean to enable Mutual TLS. Spring Boot automatically uses this bean to configure the WebClient.Builder for Spring Boot Admin.

```java
@Bean  
public ClientHttpConnector customHttpClient() {  
    SslContextBuilder sslContext = SslContextBuilder.forClient();  
    //Your sslContext customizations go here  
    HttpClient httpClient = HttpClient.create().secure(  
        ssl -> ssl.sslContext(sslContext)  
    );  
    return new ReactorClientHttpConnector(httpClient);  
}  
```

--------------------------------

### Hide UI Views in application.yml

Source: https://docs.spring-boot-admin.com/3.5.6/docs/customize/customize_ui

Disable specific navigation views by setting the enabled property to false in the view-settings configuration.

```yaml
spring:  
  boot:  
    admin:  
      ui:  
        view-settings:  
          - name: "journal"  
            enabled: false
```

--------------------------------

### Override or set custom group icons

Source: https://docs.spring-boot-admin.com/3.5.6/docs/customize/extend_ui

Use SBA.viewRegistry.setGroupIcon to assign an SVG icon to a specific group name.

```javascript
SBA.viewRegistry.setGroupIcon(  
  "custom", //(1)  
  `<svg xmlns='http://www.w3.org/2000/svg'  
        class='h-5  mr-3'  
        viewBox='0 0 576 512'><path d='M512 80c8.8 0 16 7.2 16 16V416c0 8.8-7.2 16-16 16H64c-8.8 0-16-7.2-16-16V96c0-8.8 7.2-16 16-16H512zM64 32C28.7 32 0 60.7 0 96V416c0 35.3 28.7 64 64 64H512c35.3 0 64-28.7 64-64V96c0-35.3-28.7-64-64-64H64zM200 208c14.2 0 27 6.1 35.8 16c8.8 9.9 24 10.7 33.9 1.9s10.7-24 1.9-33.9c-17.5-19.6-43.1-32-71.5-32c-53 0-96 43-96 96s43 96 96 96c28.4 0 54-12.4 71.5-32c8.8-9.9 8-25-1.9-33.9s-25-8-33.9 1.9c-8.8 9.9-21.6 16-35.8 16c-26.5 0-48-21.5-48-48s21.5-48 48-48zm144 48c0-26.5 21.5-48 48-48c14.2 0 27 6.1 35.8 16c8.8 9.9 24 10.7 33.9 1.9s10.7-24 1.9-33.9c-17.5-19.6-43.1-32-71.5-32c-53 0-96 43-96 96s43 96 96 96c28.4 0 54-12.4 71.5-32c8.8-9.9 8-25-1.9-33.9s-25-8-33.9 1.9c-8.8 9.9-21.6 16-35.8 16c-26.5 0-48-21.5-48-48z'/>  
  </svg>` //(2)  
);
```

--------------------------------

### Ignore CSRF for Actuator Endpoints in SecuritySecureConfig.java

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/security

Configures Spring Security to ignore CSRF protection for actuator endpoints, which is required because the Spring Boot Admin Server currently lacks support for them.

```java
@Bean  
protected SecurityFilterChain filterChain(HttpSecurity http) {  
    return http.csrf(c -> c.ignoringRequestMatchers("/actuator/**")).build();  
}  
```

--------------------------------

### DELETE notifications/filters/{id}

Source: https://docs.spring-boot-admin.com/3.5.6/docs/server/notifications

Deletes the notification filter with the requested id from the filters.

```APIDOC
## DELETE notifications/filters/{id}

### Description
Deletes the notification filter with the requested id from the filters.

### Method
DELETE

### Endpoint
notifications/filters/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The identifier of the filter to delete.
```
Tokens:
Raw