Spring Boot Actuator監(jiān)控的簡單使用方法示例代碼詳解
Spring Boot Actuator幫助我們實(shí)現(xiàn)了許多中間件比如mysql、es、redis、mq等中間件的健康指示器。
通過 Spring Boot 的自動配置,這些指示器會自動生效。當(dāng)這些組件有問題的時(shí)候,HealthIndicator 會返回 DOWN 或 OUT_OF_SERVICE 狀態(tài),health 端點(diǎn) HTTP 響應(yīng)狀態(tài)碼也會變?yōu)?503,我們可以以此來配置程序健康狀態(tài)監(jiān)控報(bào)警。
使用步驟也非常簡單,這里演示的是線程池的監(jiān)控。模擬線程池滿了狀態(tài)下將HealthInicator指示器變?yōu)镈own的狀態(tài)。
pom中引入jar
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency>
引入properties配置
spring.application.name=boot
# server.servlet.context-path=/boot
# management.server.servlet.context-path=/boot
# JVM (Micrometer)要求給應(yīng)用設(shè)置commonTag
management.metrics.tags.application=${spring.application.name}
#去掉重復(fù)的metrics
spring.metrics.servo.enabled=false
management.endpoint.metrics.enabled=true
management.endpoint.metrics.sensitive=false
#顯式配置不需要權(quán)限驗(yàn)證對外開放的端點(diǎn)
management.endpoints.web.exposure.include=*
management.endpoints.jmx.exposure.include=*
management.endpoint.health.show-details=always
#Actuator 的 Web 訪問方式的根地址為 /actuator,可以通過 management.endpoints.web.base-path 參數(shù)進(jìn)行修改
management.endpoints.web.base-path=/actuator
management.metrics.export.prometheus.enabled=true
代碼
/**
* @Author jeffSmile
* @Date 下午 6:10 2020/5/24 0024
* @Description 定義一個(gè)接口,來把耗時(shí)很長的任務(wù)提交到這個(gè) demoThreadPool 線程池,以模擬線程池隊(duì)列滿的情況
**/
@GetMapping("slowTask")
public void slowTask() {
ThreadPoolProvider.getDemoThreadPool().execute(() -> {
try {
TimeUnit.HOURS.sleep(1);
} catch (InterruptedException e) {
}
});
}
package com.mongo.boot.service;
import jodd.util.concurrent.ThreadFactoryBuilder;
import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
public class ThreadPoolProvider {
//一個(gè)工作線程的線程池,隊(duì)列長度10
private static ThreadPoolExecutor demoThreadPool = new ThreadPoolExecutor(
1, 1,
2, TimeUnit.SECONDS,
new ArrayBlockingQueue<>(10),
new ThreadFactoryBuilder().setNameFormat("demo-threadpool-%d").get());
//核心線程數(shù)10,最大線程數(shù)50的線程池,隊(duì)列長度50
private static ThreadPoolExecutor ioThreadPool = new ThreadPoolExecutor(
10, 50,
2, TimeUnit.SECONDS,
new ArrayBlockingQueue<>(100),
new ThreadFactoryBuilder().setNameFormat("io-threadpool-%d").get());
public static ThreadPoolExecutor getDemoThreadPool() {
return demoThreadPool;
}
public static ThreadPoolExecutor getIOThreadPool() {
return ioThreadPool;
}
}
package com.mongo.boot.service;
import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.HealthIndicator;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.ThreadPoolExecutor;
/**
* @Author jeffSmile
* @Date 下午 6:12 2020/5/24 0024
* @Description 自定義的 HealthIndicator 類,用于單一線程池的健康狀態(tài)
**/
public class ThreadPoolHealthIndicator implements HealthIndicator {
private ThreadPoolExecutor threadPool;
public ThreadPoolHealthIndicator(ThreadPoolExecutor threadPool) {
this.threadPool = threadPool;
}
@Override
public Health health() {
//補(bǔ)充信息
Map<String, Integer> detail = new HashMap<>();
//隊(duì)列當(dāng)前元素個(gè)數(shù)
detail.put("queue_size", threadPool.getQueue().size());
//隊(duì)列剩余容量
detail.put("queue_remaining", threadPool.getQueue().remainingCapacity());
//如果還有剩余量則返回UP,否則返回DOWN
if (threadPool.getQueue().remainingCapacity() > 0) {
return Health.up().withDetails(detail).build();
} else {
return Health.down().withDetails(detail).build();
}
}
}
package com.mongo.boot.service;
import org.springframework.boot.actuate.health.CompositeHealthContributor;
import org.springframework.boot.actuate.health.HealthContributor;
import org.springframework.boot.actuate.health.NamedContributor;
import org.springframework.stereotype.Component;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
/***
* @Author jeffSmile
* @Date 下午 6:13 2020/5/24 0024
* @Description 定義一個(gè) CompositeHealthContributor,來聚合兩個(gè) ThreadPoolHealthIndicator 的實(shí)例,
* 分別對應(yīng) ThreadPoolProvider 中定義的兩個(gè)線程池
**/
@Component
public class ThreadPoolsHealthContributor implements CompositeHealthContributor {
//保存所有的子HealthContributor
private Map<String, HealthContributor> contributors = new HashMap<>();
ThreadPoolsHealthContributor() {
//對應(yīng)ThreadPoolProvider中定義的兩個(gè)線程池
this.contributors.put("demoThreadPool", new ThreadPoolHealthIndicator(ThreadPoolProvider.getDemoThreadPool()));
this.contributors.put("ioThreadPool", new ThreadPoolHealthIndicator(ThreadPoolProvider.getIOThreadPool()));
}
@Override
public HealthContributor getContributor(String name) {
//根據(jù)name找到某一個(gè)HealthContributor
return contributors.get(name);
}
@Override
public Iterator<NamedContributor<HealthContributor>> iterator() {
//返回NamedContributor的迭代器,NamedContributor也就是Contributor實(shí)例+一個(gè)命名
return contributors.entrySet().stream()
.map((entry) -> NamedContributor.of(entry.getKey(), entry.getValue())).iterator();
}
}
啟動springboot驗(yàn)證
這里我訪問:http://localhost:8080/slowTask

每次訪問都向demo線程池中提交一個(gè)耗時(shí)1小時(shí)的任務(wù),而demo線程池的核心和最大線程數(shù)都是1,隊(duì)列長度為10,那么當(dāng)訪問11次之后,任務(wù)將被直接拒絕掉!


此時(shí)訪問:http://localhost:8080/actuator/health

demo線程池隊(duì)列已經(jīng)滿了,狀態(tài)變?yōu)镈OWN。

監(jiān)控內(nèi)部重要組件的狀態(tài)數(shù)據(jù)
通過 Actuator 的 InfoContributor 功能,對外暴露程序內(nèi)部重要組件的狀態(tài)數(shù)據(jù)!
實(shí)現(xiàn)一個(gè) ThreadPoolInfoContributor 來展現(xiàn)線程池的信息:
package com.mongo.boot.config;
import com.mongo.boot.service.ThreadPoolProvider;
import org.springframework.boot.actuate.info.Info;
import org.springframework.boot.actuate.info.InfoContributor;
import org.springframework.stereotype.Component;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.ThreadPoolExecutor;
/**
* @Author jeffSmile
* @Date 下午 6:37 2020/5/24 0024
* @Description 通過 Actuator 的 InfoContributor 功能,對外暴露程序內(nèi)部重要組件的狀態(tài)數(shù)據(jù)
**/
@Component
public class ThreadPoolInfoContributor implements InfoContributor {
private static Map threadPoolInfo(ThreadPoolExecutor threadPool) {
Map<String, Object> info = new HashMap<>();
info.put("poolSize", threadPool.getPoolSize());//當(dāng)前池大小
info.put("corePoolSize", threadPool.getCorePoolSize());//設(shè)置的核心池大小
info.put("largestPoolSize", threadPool.getLargestPoolSize());//最大達(dá)到過的池大小
info.put("maximumPoolSize", threadPool.getMaximumPoolSize());//設(shè)置的最大池大小
info.put("completedTaskCount", threadPool.getCompletedTaskCount());//總完成任務(wù)數(shù)
return info;
}
@Override
public void contribute(Info.Builder builder) {
builder.withDetail("demoThreadPool", threadPoolInfo(ThreadPoolProvider.getDemoThreadPool()));
builder.withDetail("ioThreadPool", threadPoolInfo(ThreadPoolProvider.getIOThreadPool()));
}
}
直接訪問http://localhost:8080/actuator/info

如果開啟jmx,還可以使用jconsole來查看線程池的狀態(tài)信息:
#開啟 JMX spring.jmx.enabled=true
打開jconcole界面之后,進(jìn)入MBean這個(gè)tab,可以在EndPoint下的Info操作這里看到我們的Bean信息。

不過,除了jconsole之外,我們可以把JMX協(xié)議轉(zhuǎn)為http協(xié)議,這里引入jolokia:
<dependency> <groupId>org.jolokia</groupId> <artifactId>jolokia-core</artifactId> </dependency>
重啟后訪問:http://localhost:8080/actuator/jolokia/exec/org.springframework.boot:type=Endpoint,name=Info/info

監(jiān)控延伸
通過Micrometer+promethues+grafana的組合也可以進(jìn)行一些生產(chǎn)級別的實(shí)踐。
到此這篇關(guān)于Spring Boot Actuator監(jiān)控的簡單使用的文章就介紹到這了,更多相關(guān)Spring Boot Actuator監(jiān)控內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
SpringBoot自動配置@EnableAutoConfiguration過程示例
這篇文章主要為大家介紹了SpringBoot自動配置@EnableAutoConfiguration的過程示例,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-10-10
基于java實(shí)現(xiàn)簡單發(fā)紅包功能
這篇文章主要為大家詳細(xì)介紹了基于java實(shí)現(xiàn)簡單發(fā)紅包功能,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2020-11-11
SpringBoot實(shí)現(xiàn)異步事件Event詳解
這篇文章主要介紹了SpringBoot實(shí)現(xiàn)異步事件Event詳解,異步事件的模式,通常將一些非主要的業(yè)務(wù)放在監(jiān)聽器中執(zhí)行,因?yàn)楸O(jiān)聽器中存在失敗的風(fēng)險(xiǎn),所以使用的時(shí)候需要注意,需要的朋友可以參考下2023-11-11

