Spring Boot Admin的使用

上一篇文章中瞭解了Spring Boot提供的監控接口，例如：/health、/info等等，實際上除了以前提到的信息，還有其餘信息業須要監控：當前處於活躍狀態的會話數量、當前應用的併發數、延遲以及其餘度量信息。此次咱們瞭解如何利用Spring-boot-admin對應用信息進行可視化，如何添加度量信息。

準備

spring-boot-admin的Github地址在：https://github.com/codecentric/spring-boot-admin，它在Spring Boot Actuator的基礎上提供簡潔的可視化WEB UI。

1. 首先在start.spring.io中建立簡單的admin應用，主要步驟以下：

• Group: org.sample.admin
• Artifact: spring-boot-admin-web
• Name: Spring Boot Admin Web
• Description: Spring Boot Admin Web Application
• Package Name: org.sample.admin
• **Type: ** Maven Project
• Packaging: Jar
• Java Version: 1.8
• Language: Java
• Spring Boot Version: 1.3.1

1. 在Ops組選項中選擇Actuator
2. 選擇Generate Project下載應用
3. 使用IDEA打開工程，在pom.xml文件中添加下列依賴

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

1. 在SpringBootAdminWebApplication.java文件中添加@EnableAdminServer註解

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

1. 在application.properties文件中添加以下配置

server.port = 8090
spring.application.name=Spring Boot Admin Web
spring.boot.admin.url=http://localhost:${server.port}
spring.jackson.serialization.indent_output=true
endpoints.health.sensitive=false

1. 啓動應用程序，在後臺給定以下提示：

   
   
   spring-boot-admin應用啓動日誌

2. 在瀏覽器中訪問上圖中提示的地址，能夠看到下圖的信息

   
   
   spring-boot-admin應用

How Do

1. 啓動Admin Web應用後，如今能夠添加針對BookPub應用的度量信息了。在文章Spring Boot應用的健康監控中，咱們曾定製本身的Health Indicator，用來監控四個數據庫接口的健康狀態，此次我將利用spring-boot-admin對這些信息進行可視化管理。
2. 在db-count-starter模塊下添加代碼，首先在db-count-starter/src/main/java/com/test/bookpubstarter/dbcount目錄下添加DbCountMetrics類：

public class DbCountMetrics implements PublicMetrics {
    private Collection<CrudRepository> repositories;
    public DbCountMetrics(Collection<CrudRepository> repositories) {
        this.repositories = repositories;
    }
    @Override
    public Collection<Metric<?>> metrics() {
        List<Metric<?>> metrics = new LinkedList<>();
        for (CrudRepository repository: repositories) {
            String name =
 DbCountRunner.getRepositoryName(repository.getClass());
            String metricName = "counter.datasource." + name;
            metrics.add(new Metric(metricName, repository.count()));
        }
        return metrics;
    }
}

1. 在DbCountAutoConfiguration定義對應的Bean，由Spring Boot完成自動註冊

@Bean
public PublicMetrics dbCountMetrics(Collection<CrudRepository> repositories) {
    return new DbCountMetrics(repositories);
}

1. 啓動BookPub應用，訪問http://localhost:8080/metrics，能夠看到DbCountMetrics已經添加到metrics列表中了。
   
   新添加的DbCountMetrics
2. 在db-count-starter模塊下的pom文件中添加spring-boot-admin-starter-client依賴，

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

1. 在BookPub應用下的application.properties中配置下列屬性值

spring.application.name=@project.description@
server.port=8080
spring.boot.admin.url=http://localhost:8090

1. 啓動BookPub應用，而後在瀏覽器中訪問http://localhost:8090
   
   監控BookPub應用

2. 點擊右側的「Details」，能夠看到該應用的詳細信息

   
   
   BookPub應用的詳細信息

分析

Spring Boot Admin就是將Spring Boot Actuator中提供的endpoint信息可視化表示，在BookPub應用（被監控）的這一端，只須要進行一點配置便可。

• spring-boot-admin-starter-client，做爲客戶端，用於與Spring Boot Admin Web的服務器溝通；
• spring.boot.admin.url=http:localhost:8090用於將當前應用註冊到Spring Boot Admin。

若是但願經過Web控制系統的日誌級別，則須要在應用中添加Jolokia JMX庫（org.jolokia:jolokia-core），同時在項目資源目錄下添加logback.xml文件，內容以下：

<configuration>
    <include resource="org/springframework/boot/logging/logback/base.xml"/>
    <jmxConfigurator/>
</configuration>

而後再次啓動BookPub應用，而後在Spring Boot Admin的頁面中查看LOGGING，則能夠看到以下頁面：

經過Spring Boot Admin修改日誌級別

Spring Boot提供的度量工具功能強大且具有良好的擴展性，除了咱們配置的DbCountMetrics，還監控BookPub應用的其餘信息，例如內存消耗、線程數量、系統時間以及http會話數量。

gague和counter的定製

gague和counter度量經過GagueService和CountService實例提供，這些實例能夠導入到任何Spring管理的對象中，用於度量應用信息。例如，咱們能夠統計某個方法的調用次數，若是要統計全部RESTful接口的調用次數，則能夠經過AOP實現，在調用指定的接口以前，首先調用counterService.increment("objectName.methodName.invoked");，某個方法被調用以後，則對它的統計值+1。具體的實驗步驟以下：

1. 在pom文件中添加AOP依賴

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

1. 在BookPub應用中添加Aspect組件，表示在每一個Controller的方法調用以前，首先增長調用次數。

@Aspect
@Component
public class ServiceMonitor {
    @Autowired
    private CounterService counterService;
    @Before("execution(* com.test.bookpub.controller.*.*(..))")
    public void countServiceInvoke(JoinPoint joinPoint) {
        counterService.increment(joinPoint.getSignature() + "");
    }
}

1. 在application.properties中設置打開AOP功能：spring.aop.auto=true
   而後啓動BookPub應用，經過瀏覽器訪問http://localhost:8080/books/9876-5432-1111，而後再去Spring Boot Admin後臺查看對應信息，發現該方法的調用次數已經被統計好了
   
   統計接口的調用次數

若是但願統計每一個接口的調用時長，則須要藉助GagueService來實現，一樣使用AOP實現，則須要環繞通知：在接口調用以前，利用long start = System.currentTimeMillis();，在接口調用以後，計算耗費的時間，單位是ms，而後使用gugeService.submit(latency)更新該接口的調用延時。

1. 在ServiceMonitor類中添加對應的監控代碼

@Autowired
private GaugeService gaugeService;
@Around("execution(* com.test.bookpub.controller.*.*(..))")
public void latencyService(ProceedingJoinPoint pjp) throws Throwable {
    long start = System.currentTimeMillis();
    pjp.proceed();
    long end = System.currentTimeMillis();
    gaugeService.submit(pjp.getSignature().toString(), end - start);
}

1. 而後在Spring Boot Admin後臺能夠看到對應接口的調用延遲

   
   
   統計接口的調用延時

這兩個service能夠應付大多數應用需求，若是須要監控其餘的度量信息，則能夠定製咱們本身的Metrics，例如在以前的例子中咱們要統計四個數據庫接口的調用狀態，則咱們定義了DbCountMetrics，該類實現了PublishMetrics，在這個類中咱們統計每一個數據庫接口的記錄數量。

PublishMetrics這個接口只有一個方法：Collection<Metric<?>> metrics();，在該方法中定義具體的監控信息；該接口的實現類須要在配置文件中經過@Bean註解，讓Spring Boot在啓動過程當中初始化，並自動註冊到MetricsEndpoint處理器中，這樣每次有訪問/metrics的請求到來時，就會執行對應的metrics方法。

參考資料

1. Chapter 6. 使用Spring進行面向切面編程（AOP）