概述
在使用Spring Boot的時候我們經常使用actuator，健康檢查，bus中使用/refresh等。這里記錄如何使用注解的方式自定義Endpoint。可用于滿足一些服務狀態監控，或者優雅停機等。
準備
Spring Boot項目，pom中加入：
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency>
編寫自定義Endpoint
@Configuration
@Endpoint(id = "my-endpoint")
public class MyEndpoint {
@ReadOperation
public Map<String, Object> endpoint() {
Map<String, Object> map = new HashMap<>(16);
map.put("message", "this is my endpoint");
return map;
}
}
配置
management.endpoints.web.exposure.include=my-endpoint
啟動&測試
啟動后可以看到日志：
Mapped "{[/actuator/my-endpoint],methods=[GET],produces=[application/vnd.spring-boot.actuator.v2+json || application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.web.servlet.AbstractWebMvcEndpointHandlerMapping$OperationHandler.handle(javax.servlet.http.HttpServletRequest,java.util.Map<java.lang.String, java.lang.String>)
注意
- @EndPoint中的id不能使用駝峰法，需要以-分割
- @Spring Boot會去掃描@EndPoint注解下的@ReadOperation, @WriteOperation, @DeleteOperation注解，分別對應生成Get/Post/Delete的Mapping。注解中有個produces參數，可以指定media type, 如：application/json等。
Spring Boot 常用endpoint的使用
Actuator
目的
- 監控并管理應用程序
監控：讓我們去發現和了解程序的運行狀況各種指標
管理：比如說通過Actuator去做一個shutdown功能，通過訪問一個特定的url去操作，默認是不開啟的，另外 還可以在運行的過程中 對日志進行調整
訪問方式
- HTTP
- JMX
默認 會把更多的 Actuator 暴露在JMX上面
依賴
- spring-boot-starter-actuator
一些常用 Endpoint
只有health和info 默認是可以通過http 進行訪問的
-
shutdown是默認不開啟的一個 -
threaddump去看線程情況 -
Prometheus雖然是默認開啟 但是 必須在pom文件上加入相關依賴 才能提供支持
如何訪問 Actuator Endpoint
HTTP 訪問
- /actuator/<id >
端口與路徑
- management.server.address=
Actuator Endpoint 發布的地址
- management.server.port=
Actuator Endpoint 發布的端口號
- management.endpoints.web.base-path=/actuator
自定義端口
- management.endpoints.web.path-mapping.<id>=路徑
修改端點的訪問路徑(映射)，端點默認使用的是它的 值
開啟 Endpoint
- management.endpoint.<id>.enabled=true
開啟名為id的 Endpoint
- management.endpoints.enabled-by-default=false
端點啟用是選擇性加入而不是選擇性排除。表示禁用了所有端點
暴露 Endpoint
- management.endpoints.jmx.exposure.exclude=
jmx方式排除需要公開的端點
- management.endpoints.jmx.exposure.include=*
jmx方式包含需要公開的端點
- management.endpoints.web.exposure.exclude=
http方式排除需要公開的端點
- management.endpoints.web.exposure.include=info, health
以上為個人經驗，希望能給大家一個參考，也希望大家多多支持服務器之家。
原文鏈接：https://blog.csdn.net/LightOfMiracle/article/details/80594795
