1. 引言
Spring Boot Actuator 是一個功能強大的監控工具,能夠幫助開發者監控和管理應用的運行狀態。通過 Actuator,我們可以輕松獲取應用的健康狀況、配置信息、性能指標等。本文將一步步引導你如何配置和使用 Actuator,以及如何通過它來監控你的 Spring Boot 應用。
2. 安裝和配置 Actuator
2.1 添加依賴
首先,我們需要在項目的 pom.xml
文件中添加 Actuator 的依賴:
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
2.2 啟用 Actuator 端點
默認情況下,Actuator 的一些敏感端點是禁用的。我們需要在配置文件中啟用它們。在 application.properties
或 application.yml
中添加以下配置:
management:endpoints:web:exposure:include: "*"
這樣,所有的 Actuator 端點都會被啟用。你也可以選擇性地啟用部分端點,例如:
management:endpoints:web:exposure:include: health, info, metrics
2.3 訪問 Actuator 端點
配置完成后,啟動你的 Spring Boot 應用。默認情況下,Actuator 端點的訪問路徑是 /actuator
。你可以通過瀏覽器或工具(如 Postman)訪問以下路徑:
http://localhost:8080/actuator
:列出所有可用的端點。http://localhost:8080/actuator/health
:檢查應用的健康狀態。http://localhost:8080/actuator/info
:查看應用的配置信息。
3. 探索常用 Actuator 端點
3.1 Health 端點
/actuator/health
端點用于檢查應用的健康狀態。默認情況下,它返回一個簡單的狀態,例如:
{"status": "UP"
}
為了查看更詳細的健康信息,可以在配置文件中添加:
management:endpoint:health:show-details: always
重啟應用后,再次訪問 /actuator/health
,你將看到更詳細的健康指標,包括磁盤空間、數據庫連接等。
3.2 Info 端點
/actuator/info
端點顯示應用的配置信息。你可以在 application.yml
中添加自定義的信息:
info:app:name: MySpringBootApplicationversion: 1.0.0
訪問 /actuator/info
將返回這些配置信息:
{"app": {"name": "MySpringBootApplication","version": "1.0.0"}
}
3.3 Beans 端點
/actuator/beans
端點展示了應用中所有 Spring Bean 的信息,包括它們的類型、作用域和依賴關系。這對于調試和理解應用的依賴關系非常有幫助。
3.4 Metrics 端點
/actuator/metrics
端點提供了應用的性能指標,包括 JVM 內存使用情況、線程信息、HTTP 請求統計等。你可以通過這個端點監控應用的實時性能。
3.5 Threaddump 端點
/actuator/threaddump
端點生成當前線程的快照,幫助你分析線程的狀態和堆棧信息。這對于排查線程相關的問題非常有用。
3.6 Shutdown 端點
/actuator/shutdown
端點允許你通過發送一個 POST 請求來優雅地關閉應用。在配置文件中啟用它:
management:endpoint:shutdown:enabled: true
然后,使用工具發送 POST 請求到 http://localhost:8080/actuator/shutdown
即可關閉應用。
4. 自定義 Actuator 端點
4.1 創建自定義 Endpoint
有時候,你可能需要監控一些特定的業務邏輯。這時,可以創建自定義的 Actuator 端點。例如,創建一個名為 myEndpoint
的端點:
import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
import org.springframework.stereotype.Component;@Component
@Endpoint(id = "myEndpoint")
public class MyEndpoint {@ReadOperationpublic String getInfo() {return "Custom endpoint information";}
}
4.2 注冊 Endpoint
確保你的自定義 Endpoint 被 Spring 容器注冊。通常,使用 @Component
注解即可。
4.3 訪問自定義端點
啟動應用后,訪問 http://localhost:8080/actuator/myEndpoint
,你將看到自定義的信息。
5. 保護 Actuator 端點
5.1 使用 Filter 保護端點
為了防止未經授權的訪問,可以為 Actuator 端點添加過濾器。例如,創建一個過濾器類:
import org.springframework.stereotype.Component;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;@WebFilter(urlPatterns = "/actuator/*")
@Component
public class ActuatorFilter implements Filter {@Overridepublic void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)throws IOException, ServletException {HttpServletRequest httpRequest = (HttpServletRequest) request;HttpServletResponse httpResponse = (HttpServletResponse) response;// 檢查用戶是否認證if (!isAuthenticated(httpRequest)) {httpResponse.setStatus(HttpServletResponse.SC_UNAUTHORIZED);httpResponse.getWriter().write("Unauthorized access");return;}chain.doFilter(request, response);}private boolean isAuthenticated(HttpServletRequest request) {// 實現認證邏輯,例如檢查是否有有效的令牌return request.getHeader("Authorization") != null;}
}
5.2 配置過濾器
確保過濾器類被 Spring 容器掃描到。通常,將其放在 src/main/java
目錄下的適當包中即可。
6. 使用 Spring Boot Monitor 可視化監控
6.1 引入依賴
在 pom.xml
中添加 Spring Boot Monitor 的依賴:
<dependency><groupId>cn.pomit</groupId><artifactId>spring-boot-monitor</artifactId><version>0.0.1</version>
</dependency>
6.2 訪問監控頁面
啟動應用后,訪問 http://localhost:8080/monitor
,你將看到一個類似 Spring Boot Admin 的監控界面,展示應用的各項指標和健康狀態。
7. 總結
通過本文的教程,你已經掌握了如何配置和使用 Spring Boot Actuator 來監控和管理你的應用。從啟用默認端點到創建自定義端點,再到保護端點的安全性,Actuator 提供了豐富的功能來滿足不同的監控需求。希望這篇教程能幫助你更好地理解和應用 Actuator,提升應用的監控和管理能力。