SpringBoot實現(xiàn)項目健康檢查與監(jiān)控
Spring Boot 最主要的特性就是AutoConfig(自動配置),而對于我們這些使用者來說也就是各種starter,
Spring Boot-Actuator 也提供了starter,為我們自動配置,在使用上我們只需要添加starter到我們的依賴中,然后啟動項目即可。
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency>
常用Endpoint
Spring Boot-actuator,提供了許多有用的EndPoint,對Spring Boot應(yīng)用提供各種監(jiān)控,下面說一下我常用的EndPoint:
/health 應(yīng)用的健康狀態(tài)
/configprops 獲取應(yīng)用的配置信息,因為Spring Boot 可能發(fā)布時是單獨的Jar包,配置文件可能包含其中, 當(dāng)我們需要檢查配置文件時可以使用 ConfigpropsEndPoint 進行查看一些配置是否正確。
/trace 最近幾次的http請求信息
HealthEndPoint
當(dāng)我們訪問 http://localhost:8088/health 時,可以看到 HealthEndPoint 給我們提供默認(rèn)的監(jiān)控結(jié)果,包含 磁盤檢測和數(shù)據(jù)庫檢測。
{
"status": "UP",
"diskSpace": {
"status": "UP",
"total": 398458875904,
"free": 315106918400,
"threshold": 10485760
},
"db": {
"status": "UP",
"database": "MySQL",
"hello": 1
}
}
其實看 Spring Boot-actuator 源碼,你會發(fā)現(xiàn) HealthEndPoint 提供的信息不僅限于此,org.springframework.boot.actuate.health 包下 你會發(fā)現(xiàn) ElasticsearchHealthIndicator、RedisHealthIndicator、RabbitHealthIndicator 等
也就是 HealthEndPoint 也提供 ES, Redis 等組件的健康信息。
自定義Indicator 擴展 HealthEndPoint
看源碼 其實 磁盤和數(shù)據(jù)庫健康信息就是 DiskSpaceHealthIndicator、DataSourceHealthIndicator 來實現(xiàn)的,當(dāng)我們對一些我們自定義的組件進行監(jiān)控時, 我們也可以實現(xiàn)個Indicator :
@Component
public class User implements HealthIndicator {
/**
* user監(jiān)控 訪問: http://localhost:8088/health
*
* @return 自定義Health監(jiān)控
*/
@Override
public Health health() {
return new Health.Builder().withDetail("usercount", 10) //自定義監(jiān)控內(nèi)容
.withDetail("userstatus", "up").up().build();
}
}
這時我們再次訪問: http://localhost:8088/health 這時返回的結(jié)果如下,包含了我們自定義的 User 健康信息。
{
"status": "UP",
"user": {
"status": "UP",
"usercount": 10,
"userstatus": "up"
},
"diskSpace": {
"status": "UP",
"total": 398458875904,
"free": 315097989120,
"threshold": 10485760
},
"db": {
"status": "UP",
"database": "MySQL",
"hello": 1
}
}
自定義EndPoint
其實除了擴展 HealthEndPoint 來添加一些健康檢查, 我們也可以自定定義一些EndPoint 來提供程序運行時一些信息的展示:
@Configuration
public class EndPointAutoConfig {
@Bean
public Endpoint<Map<String, Object>> customEndPoint() {
return new SystemEndPoint();
}
}
@ConfigurationProperties(prefix="endpoints.customsystem")
public class SystemEndPoint extends AbstractEndpoint<Map<String, Object>> {
public SystemEndPoint(){
super("customsystem");
}
@Override
public Map<String, Object> invoke() {
Map<String,Object> result= new HashMap<>();
Map<String, String> map = System.getenv();
result.put("username",map.get("USERNAME"));
result.put("computername",map.get("COMPUTERNAME"));
result.put("userdomain",map.get("USERDOMAIN"));
return result;
}
}
訪問 http://localhost:8088/customsystem 來查看我們自定義的EndPoint ,返回結(jié)果如下:
{
"username": "xxx",
"userdomain": "DESKTOP-6EAN1H4",
"computername": "DESKTOP-6EAN1H4"
}
我們在為Spring Boot應(yīng)用添加actuator后,期望的health接口返回結(jié)果應(yīng)該是類似下面的結(jié)果:
{
status: "UP",
diskSpace:
{
status: "UP",
total: 250182889472,
free: 31169568768,
threshold: 10485760
},
db:
{
status: "UP",
database: "H2",
hello: 1
}
}
如果只是返回了status
{
status: "UP"
}
則需要為應(yīng)用新增配置,以yml配置文件為例,需要添加如下配置:
management: security: enabled: false endpoints: health: sensitive: false
management.endpoint.health.show-details=always
總結(jié)
以上所述是小編給大家介紹的SpringBoot實現(xiàn)項目健康檢查與監(jiān)控,希望對大家有所幫助,如果大家有任何疑問請給我留言,小編會及時回復(fù)大家的。在此也非常感謝大家對腳本之家網(wǎng)站的支持!
相關(guān)文章
PowerJob的OmsLogHandler工作流程源碼解析
這篇文章主要為大家介紹了PowerJob的OmsLogHandler工作流程源碼解析,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-12-12
Java畢業(yè)設(shè)計實戰(zhàn)之平行志愿管理系統(tǒng)的實現(xiàn)
這是一個使用了java+Springboot+Maven+mybatis+Vue+Mysql開發(fā)的圖片平行志愿管理系統(tǒng),是一個畢業(yè)設(shè)計的實戰(zhàn)練習(xí),具有志愿管理該有的所有功能,感興趣的朋友快來看看吧2022-02-02
Java Web Filter 過濾器學(xué)習(xí)教程(推薦)
Filter也稱之為過濾器,它是Servlet技術(shù)中最激動人心的技術(shù).這篇文章主要介紹了Java Web Filter 過濾器學(xué)習(xí)教程的相關(guān)資料,需要的朋友可以參考下2016-05-05
SpringBoot自定義全局異常處理器的問題總結(jié)
Springboot框架提供兩個注解幫助我們十分方便實現(xiàn)全局異常處理器以及自定義異常,處理器會優(yōu)先處理更具體的異常類型,如果沒有找到匹配的處理器,那么它會尋找處理更一般異常類型的處理器,本文介紹SpringBoot自定義全局異常處理器的問題,一起看看吧2024-01-01
VSCode+Gradle搭建Java開發(fā)環(huán)境實現(xiàn)
這篇文章主要介紹了VSCode+Gradle搭建Java開發(fā)環(huán)境實現(xiàn),文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-07-07

