SpringBoot Actuator監(jiān)控的項目實踐
微服務的特點決定了功能模塊的部署是分布式的，大部分功能模塊都是運行在不同的機器上，彼此通過服務調用進行交互，前后臺的業(yè)務流會經過很多個微服務的處理和傳遞，出現了異常如何快速定位是哪個環(huán)節(jié)出現了問題？
在這種框架下，微服務的監(jiān)控顯得尤為重要。本文主要結合 Spring Boot Actuator，跟大家一起分享微服務Spring Boot Actuator 的常見用法，方便我們在日常中對我們的微服務進行監(jiān)控治理。
1、Actuator 監(jiān)控
Spring Boot 使用“習慣優(yōu)于配置的理念”，采用包掃描和自動化配置的機制來加載依賴 Jar 中的 Spring bean，不需要任何 Xml 配置，就可以實現 Spring 的所有配置。雖然這樣做能讓我們的代碼變得非常簡潔，但是整個應用的實例創(chuàng)建和依賴關系等信息都被離散到了各個配置類的注解上，這使得我們分析整個應用中資源和實例的各種關系變得非常的困難。
Actuator 是 Spring Boot 提供的對應用系統(tǒng)的自省和監(jiān)控的集成功能，可以查看應用配置的詳細信息，例如自動化配置信息、創(chuàng)建的 Spring beans 以及一些環(huán)境屬性等。
為了保證 actuator 暴露的監(jiān)控接口的安全性，需要添加安全控制的依賴spring-boot-start-security依賴，訪問應用監(jiān)控端點時，都需要輸入驗證信息。Security 依賴，可以選擇不加，不進行安全管理，但不建議這么做。
2、Actuator 的 REST 接口
Actuator 監(jiān)控分成兩類：原生端點和用戶自定義端點；自定義端點主要是指擴展性，用戶可以根據自己的實際應用，定義一些比較關心的指標，在運行期進行監(jiān)控。
原生端點是在應用程序里提供眾多 Web 接口，通過它們了解應用程序運行時的內部狀況。原生端點又可以分成三類：
應用配置類：可以查看應用在運行期的靜態(tài)信息：例如自動配置信息、加載的 springbean 信息、yml 文件配置信息、環(huán)境信息、請求映射信息；
度量指標類：主要是運行期的動態(tài)信息，例如堆棧、請求連、一些健康指標、metrics 信息等；
操作控制類：主要是指 shutdown,用戶可以發(fā)送一個請求將應用的監(jiān)控功能關閉。
Actuator 提供了 13 個接口，具體如下表所示。
| HTTP 方法 | 路徑 | 描述 |
|---|---|---|
| GET | /auditevents | 顯示應用暴露的審計事件 (比如認證進入、訂單失敗) |
| GET | /beans | 描述應用程序上下文里全部的 Bean，以及它們的關系 |
| GET | /conditions | 就是 1.0 的 /autoconfig ，提供一份自動配置生效的條件情況，記錄哪些自動配置條件通過了，哪些沒通過 |
| GET | /configprops | 描述配置屬性(包含默認值)如何注入Bean |
| GET | /env | 獲取全部環(huán)境屬性 |
| GET | /env/{name} | 根據名稱獲取特定的環(huán)境屬性值 |
| GET | /flyway | 提供一份 Flyway 數據庫遷移信息 |
| GET | /liquidbase | 顯示Liquibase 數據庫遷移的纖細信息 |
| GET | /health | 報告應用程序的健康指標，這些值由 HealthIndicator 的實現類提供 |
| GET | /heapdump | dump 一份應用的 JVM 堆信息 |
| GET | /httptrace | 顯示HTTP足跡，最近100個HTTP request/repsponse |
| GET | /info | 獲取應用程序的定制信息，這些信息由info打頭的屬性提供 |
| GET | /logfile | 返回log file中的內容(如果 logging.file 或者 logging.path 被設置) |
| GET | /loggers | 顯示和修改配置的loggers |
| GET | /metrics | 報告各種應用程序度量信息，比如內存用量和HTTP請求計數 |
| GET | /metrics/{name} | 報告指定名稱的應用程序度量值 |
| GET | /scheduledtasks | 展示應用中的定時任務信息 |
| GET | /sessions | 如果我們使用了 Spring Session 展示應用中的 HTTP sessions 信息 |
| POST | /shutdown | 關閉應用程序，要求endpoints.shutdown.enabled設置為true |
| GET | /mappings | 描述全部的 URI路徑，以及它們和控制器(包含Actuator端點)的映射關系 |
| GET | /threaddump | 獲取線程活動的快照 |
3、快速上手
3.1 pom依賴
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.6.RELEASE</version>
<relativePath/>
</parent>
<groupId>com.example</groupId>
<artifactId>spring-boot-actuator</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>spring-boot-actuator</name>
<description>spring-boot-actuator</description>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<fork>true</fork>
</configuration>
</plugin>
</plugins>
</build>
</project>
3.2 配置文件
info.app.name=spring-boot-actuator info.app.version=1.0.0 info.app.test=test management.endpoints.web.exposure.include=* management.endpoint.health.show-details=always # management.endpoints.web.base-path=/manage management.endpoint.shutdown.enabled=true
management.endpoints.web.base-path=/manage代表啟用單獨的url地址來監(jiān)控 Spring Boot 應用，為了安全一般都啟用獨立的端口來訪問后端的監(jiān)控信息。management.endpoint.shutdown.enabled=true啟用接口關閉 Spring Boot
3.3 控制器
package com.example.controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class HelloController {
@RequestMapping("/hello")
public String index() {
return "Hello World";
}
}
3.4 啟動類
package com.example;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
配置完成之后，啟動項目就可以繼續(xù)驗證各個監(jiān)控功能了。
4、命令詳解
在 Spring Boot 2.x 中為了安全期間，Actuator 只開放了兩個端點 /actuator/health 和 /actuator/info?？梢栽谂渲梦募性O置打開。
可以打開所有的監(jiān)控點
management.endpoints.web.exposure.include=*
也可以選擇打開部分
management.endpoints.web.exposure.exclude=beans,trace
Actuator 默認所有的監(jiān)控點路徑都在/actuator/*，當然如果有需要這個路徑也支持定制。
management.endpoints.web.base-path=/manage
設置完重啟后，再次訪問地址就會變成/manage/*
Actuator 幾乎監(jiān)控了應用涉及的方方面面，我們重點講述一些經常在項目中常用的命令。
4.1 health
health 主要用來檢查應用的運行狀態(tài)，這是我們使用最高頻的一個監(jiān)控點。通常使用此接口提醒我們應用實例的運行狀態(tài)，以及應用不”健康“的原因，比如數據庫連接、磁盤空間不夠等。
默認情況下 health 的狀態(tài)是開放的，添加依賴后啟動項目，訪問：http://localhost:8080/actuator/health
即可看到應用的狀態(tài)。
{
"status": "UP",
"details": {
"diskSpace": {
"status": "UP",
"details": {
"total": 22175952896,
"free": 2316570624,
"threshold": 10485760
}
}
}
}
默認情況下，最終的 Spring Boot 應用的狀態(tài)是由 HealthAggregator 匯總而成的，匯總的算法是：
1 設置狀態(tài)碼順序：
setStatusOrder(Status.DOWN, Status.OUT_OF_SERVICE, Status.UP, Status.UNKNOWN);。2 過濾掉不能識別的狀態(tài)碼。
3 如果無任何狀態(tài)碼，整個 Spring Boot 應用的狀態(tài)是 UNKNOWN。
4 將所有收集到的狀態(tài)碼按照 1 中的順序排序。
5 返回有序狀態(tài)碼序列中的第一個狀態(tài)碼，作為整個 Spring Boot 應用的狀態(tài)。
health 通過合并幾個健康指數檢查應用的健康情況。Spring Boot Actuator 有幾個預定義的健康指標比如DataSourceHealthIndicator, DiskSpaceHealthIndicator, MongoHealthIndicator,RedisHealthIndicator等，它使用這些健康指標作為健康檢查的一部分。
舉個例子，如果你的應用使用 Redis，RedisHealthindicator 將被當作檢查的一部分；如果使用 MongoDB，
那么MongoHealthIndicator 將被當作檢查的一部分。
可以在配置文件中關閉特定的健康檢查指標，比如關閉 redis 的健康檢查：
management.health.redise.enabled=false
默認，所有的這些健康指標被當作健康檢查的一部分。
4.2 info
info 就是我們自己配置在配置文件中以 info 開頭的配置信息，比如我們在示例項目中的配置是：
info.app.name=spring-boot-actuator info.app.version= 1.0.0 info.app.test= test
啟動示例項目，訪問：http://localhost:8080/actuator/info返回部分信息如下：
{
"app": {
"name": "spring-boot-actuator",
"version": "1.0.0",
"test": "test"
}
}
4.3 beans
根據示例就可以看出，展示了 bean 的別名、類型、是否單例、類的地址、依賴等信息。
啟動示例項目，訪問：http://localhost:8080/actuator/beans返回部分信息如下：
[
{
"context": "application:8080:management",
"parent": "application:8080",
"beans": [
{
"bean": "embeddedServletContainerFactory",
"aliases": [
],
"scope": "singleton",
"type": "org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainerFactory",
"resource": "null",
"dependencies": [
]
},
{
"bean": "endpointWebMvcChildContextConfiguration",
"aliases": [
],
"scope": "singleton",
"type": "org.springframework.boot.actuate.autoconfigure.EndpointWebMvcChildContextConfiguration$$EnhancerBySpringCGLIB$$a4a10f9d",
"resource": "null",
"dependencies": [
]
}
}
]
4.4 conditions
Spring Boot 的自動配置功能非常便利，但有時候也意味著出問題比較難找出具體的原因。使用 conditions 可以在應用運行時查看代碼了某個配置在什么條件下生效，或者某個自動配置為什么沒有生效。
啟動示例項目，訪問：http://localhost:8080/actuator/conditions返回部分信息如下：
{
"positiveMatches": {
"DevToolsDataSourceAutoConfiguration": {
"notMatched": [
{
"condition": "DevToolsDataSourceAutoConfiguration.DevToolsDataSourceCondition",
"message": "DevTools DataSource Condition did not find a single DataSource bean"
}
],
"matched": [ ]
},
"RemoteDevToolsAutoConfiguration": {
"notMatched": [
{
"condition": "OnPropertyCondition",
"message": "@ConditionalOnProperty (spring.devtools.remote.secret) did not find property 'secret'"
}
],
"matched": [
{
"condition": "OnClassCondition",
"message": "@ConditionalOnClass found required classes 'javax.servlet.Filter', 'org.springframework.http.server.ServerHttpRequest'; @ConditionalOnMissingClass did not find unwanted class"
}
]
}
}
}
4.5 heapdump
返回一個 GZip 壓縮的 JVM 堆 dump
啟動示例項目，訪問：http://localhost:8080/actuator/heapdump會自動生成一個 Jvm 的堆文件heapdump，我們可以使用 JDK 自帶的 Jvm 監(jiān)控工具 VisualVM 打開此文件查看內存快照。
類似如下圖：
4.6 shutdown
開啟接口優(yōu)雅關閉 Spring Boot 應用，要使用這個功能首先需要在配置文件中開啟：
management.endpoint.shutdown.enabled=true
配置完成之后，啟動示例項目，使用 curl 模擬 post 請求訪問 shutdown 接口。
shutdown 接口默認只支持 post 請求。
curl -X POST "http://localhost:8080/actuator/shutdown"
{
"message": "Shutting down, bye..."
}
此時你會發(fā)現應用已經被關閉。
4.7 mappings
描述全部的 URI 路徑，以及它們和控制器的映射關系
啟動示例項目，訪問：http://localhost:8080/actuator/mappings返回部分信息如下：
{
"/**/favicon.ico": {
"bean": "faviconHandlerMapping"
},
"{[/hello]}": {
"bean": "requestMappingHandlerMapping",
"method": "public java.lang.String com.neo.controller.HelloController.index()"
},
"{[/error]}": {
"bean": "requestMappingHandlerMapping",
"method": "public org.springframework.http.ResponseEntity<java.util.Map<java.lang.String, java.lang.Object>> org.springframework.boot.autoconfigure.web.BasicErrorController.error(javax.servlet.http.HttpServletRequest)"
}
}
4.8 threaddump
/threaddump 接口會生成當前線程活動的快照。這個功能非常好，方便我們在日常定位問題的時候查看線程的情況。 主要展示了線程名、線程ID、線程的狀態(tài)、是否等待鎖資源等信息。
啟動示例項目，訪問：http://localhost:8080/actuator/threaddump返回部分信息如下：
[
{
"threadName": "http-nio-8088-exec-6",
"threadId": 49,
"blockedTime": -1,
"blockedCount": 0,
"waitedTime": -1,
"waitedCount": 2,
"lockName": "java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject@1630a501",
"lockOwnerId": -1,
"lockOwnerName": null,
"inNative": false,
"suspended": false,
"threadState": "WAITING",
"stackTrace": [
{
"methodName": "park",
"fileName": "Unsafe.java",
"lineNumber": -2,
"className": "sun.misc.Unsafe",
"nativeMethod": true
},
...
{
"methodName": "run",
"fileName": "TaskThread.java",
"lineNumber": 61,
"className": "org.apache.tomcat.util.threads.TaskThread$WrappingRunnable",
"nativeMethod": false
}
...
],
"lockInfo": {
"className": "java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject",
"identityHashCode": 372286721
}
}
...
]
生產出現問題的時候，可以通過應用的線程快照來檢測應用正在執(zhí)行的任務。
到此這篇關于SpringBoot Actuator監(jiān)控的項目實踐的文章就介紹到這了,更多相關SpringBoot Actuator監(jiān)控內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
這篇文章主要介紹了java使用servlet實現驗證碼，簡單實用，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-01-01
詳解關于Windows10 Java環(huán)境變量配置問題的解決辦法
這篇文章主要介紹了關于Windows10 Java環(huán)境變量配置問題的解決辦法，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2019-03-03
這篇文章主要介紹了簡單了解Spring Bean常用注解的裝配,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2019-11-11
本文介紹了一個java解析sina視頻地址的例子，從這個例子中可以學習到java使用sax解析xml的方法，大家可以參考修改成其它功能2014-01-01
下面小編就為大家?guī)硪黄P于Java變量的聲明、內存分配及初始化詳解。小編覺得挺不錯的，現在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-03-03
這篇文章主要為大家詳細介紹了SpringBoot JPA實現查詢多值，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2018-08-08
mybatis-plus 通用字段自動化(如邏輯刪除和更新時間等)
這篇文章主要介紹了mybatis-plus 通用字段自動化(如邏輯刪除和更新時間等)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2021-01-01
Java中的反射（Reflection）和使用new關鍵字創(chuàng)建對象是兩種不同的對象創(chuàng)建方式,各有優(yōu)缺點和適用場景,本文小編給大家詳細介紹了Java中的反射與new創(chuàng)建對象,感興趣的小伙伴跟著小編一起來看看吧2024-07-07
下面小編就為大家?guī)硪黄仙Ｕ凧ava虛擬機垃圾回收機制(必看篇)。小編覺得挺不錯的，現在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-08-08
最近工作中有用到工作流的開發(fā)，引入了flowable工作流框架，在此記錄一下springboot整合flowable工作流框架的過程，感興趣的朋友一起看看吧2022-04-04