如何為你的Spring Boot應用裝上一個功能強大的監控儀表盤

在現代微服務架構中，系統監控已成為保障應用穩定性的關鍵環節。通過有效的監控，我們可以實時了解應用的運行狀態，及時發現并解決性能問題。本文將介紹如何使用Micrometer及其注冊表（Registry）在Spring Boot環境中實現全面系統參數監控。

1 Micrometer簡介

Micrometer是一款供應商中立的應用程序指標門面（Facade），類似于SLF4J在日志領域的作用，它為不同監控系統提供了統一的度量采集API。它可以與多種監控系統（如Prometheus、Datadog、New Relic、InfluxDB等）無縫集成，讓你無需修改代碼即可切換監控后端。

Micrometer的架構圍繞三個核心概念構建：

• Meter：表示具體的度量指標，如計數器(Counter)、計時器(Timer)等

• MeterRegistry：負責創建和存儲Meter的核心接口

• Binder：將框架內部指標（如JVM指標）自動綁定到注冊表

2 Spring Boot集成Micrometer

2.1 添加依賴

首先，在您的pom.xml中添加以下依賴：

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency><groupId>io.micrometer</groupId><artifactId>micrometer-core</artifactId>
</dependency>
<!-- 使用Prometheus作為監控系統 -->
<dependency><groupId>io.micrometer</groupId><artifactId>micrometer-registry-prometheus</artifactId>
</dependency>

如果使用Gradle，可以在build.gradle中添加：

implementation 'org.springframework.boot:spring-boot-starter-actuator'
implementation 'io.micrometer:micrometer-core'
implementation 'io.micrometer:micrometer-registry-prometheus'

2.2 配置監控端點

在application.yml或application.properties中進行配置：

management:endpoints:web:exposure:include: health,info,metrics,prometheusmetrics:tags:application: ${spring.application.name}region: northexport:prometheus:enabled: true

此配置開啟了Actuator的監控端點，并設置了全局標簽（application和region），這些標簽會附加到所有監控指標上

2.3 選擇監控系統

Micrometer支持多種監控系統，以下是常見選擇：

3 使用MeterRegistry記錄指標

Spring Boot會自動配置一個MeterRegistry實例，可以直接在代碼中使用它來記錄各種指標。

3.1 計數器（Counter）

計數器用于記錄單調遞增的指標，如請求總數、訂單創建數量等。

import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.MeterRegistry;
import org.springframework.stereotype.Service;@Service
public class OrderService {private final Counter orderCounter;public OrderService(MeterRegistry meterRegistry) {this.orderCounter = meterRegistry.counter("orders.total", "type", "created");}public void createOrder() {// 業務邏輯orderCounter.increment();}
}

3.2 計量儀（Gauge）

Gauge用于測量瞬時值，如內存使用量、緩存大小等。

import io.micrometer.core.instrument.Gauge;
import io.micrometer.core.instrument.MeterRegistry;
import org.springframework.stereotype.Component;import javax.annotation.PostConstruct;
import java.util.concurrent.atomic.AtomicInteger;@Component
public class MyGaugeComponent {private AtomicInteger myValue = new AtomicInteger(0);private final MeterRegistry meterRegistry;public MyGaugeComponent(MeterRegistry meterRegistry) {this.meterRegistry = meterRegistry;}@PostConstructpublic void init() {Gauge.builder("my_custom_gauge", myValue, AtomicInteger::get).description("A custom gauge example").tags("component", "gauge").register(meterRegistry);}public void updateValue(int newValue) {myValue.set(newValue);}@Beanpublic CommandLineRunner bindThreadPoolToMetrics(MeterRegistry registry,@Qualifier("asyncExecutorService") ThreadPoolTaskExecutor executor,SystemStatusService systemStatusService) {Gauge.builder("system.status.code", systemStatusService::getStatusCode).description("當前系統狀態碼").register(registry);return args -> {registry.gauge("asyncExecutorService.threadpool.core.size", executor, ThreadPoolTaskExecutor::getCorePoolSize);registry.gauge("asyncExecutorService.threadpool.max.size", executor, ThreadPoolTaskExecutor::getMaxPoolSize);registry.gauge("asyncExecutorService.threadpool.pool.size", executor, ThreadPoolTaskExecutor::getPoolSize);registry.gauge("asyncExecutorService.threadpool.active.count", executor, ThreadPoolTaskExecutor::getActiveCount);registry.gauge("asyncExecutorService.threadpool.queue.size", executor,new ToDoubleFunction<ThreadPoolTaskExecutor>() {@Overridepublic double applyAsDouble(ThreadPoolTaskExecutor value) {return value.getThreadPoolExecutor().getQueue().size();}});//registry.gauge("system.status.code", systemStatusService, SystemStatusService::getStatusCode);};}@Bean(name = "threadPoolTaskScheduler")public ThreadPoolTaskScheduler threadPoolTaskScheduler() {ThreadPoolTaskScheduler executor = new ThreadPoolTaskScheduler();executor.setPoolSize(2);executor.setThreadNamePrefix("TST-SCHEDULER");executor.setWaitForTasksToCompleteOnShutdown(true);executor.setAwaitTerminationSeconds(10);return executor;}
}

3.3 計時器（Timer）

計時器用于測量短時任務的持續時間，內置百分位計算。

import io.micrometer.core.instrument.Timer;
import io.micrometer.core.instrument.MeterRegistry;
import org.springframework.stereotype.Service;@Service
public class ApiService {private final Timer apiTimer;public ApiService(MeterRegistry meterRegistry) {this.apiTimer = meterRegistry.timer("api.requests", "api_type", "external");}public String callExternalApi() {return apiTimer.record(() -> {// 模擬API調用try {Thread.sleep(100);} catch (InterruptedException e) {Thread.currentThread().interrupt();}return "API response";});}
}

3.4 分布摘要（DistributionSummary）

分布摘要用于記錄值的分布情況，適用于不涉及時間的測量，如響應體大小。

import io.micrometer.core.instrument.DistributionSummary;
import io.micrometer.core.instrument.MeterRegistry;
import org.springframework.stereotype.Service;@Service
public class ResponseService {private final DistributionSummary responseSizeSummary;public ResponseService(MeterRegistry meterRegistry) {this.responseSizeSummary = DistributionSummary.builder("response.size").description("Response size distribution").baseUnit("bytes").register(meterRegistry);}public void processResponse(String response) {// 記錄響應大小responseSizeSummary.record(response.getBytes().length);}
}

4 監控HTTP請求

Spring Boot會自動監控HTTP請求，并提供一些默認的Metrics，如請求數量、響應時間等。您可以通過以下配置自定義這些指標：

management:metrics:web:server:request:autotime:enabled: truemetric:name: http.server.requests

還可以通過自定義過濾器來增強HTTP監控：

import io.micrometer.core.instrument.MeterRegistry;
import org.springframework.stereotype.Component;
import org.springframework.web.filter.OncePerRequestFilter;import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;@Component
public class MetricFilter extends OncePerRequestFilter {private final MeterRegistry meterRegistry;public MetricFilter(MeterRegistry meterRegistry) {this.meterRegistry = meterRegistry;}@Overrideprotected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {String path = request.getRequestURI();String method = request.getMethod();meterRegistry.counter("http.requests.total", "method", method, "path", path).increment();long start = System.currentTimeMillis();try {filterChain.doFilter(request, response);} finally {long duration = System.currentTimeMillis() - start;meterRegistry.timer("http.requests.duration","method", method,"path", path,"status", String.valueOf(response.getStatus())).record(duration, TimeUnit.MILLISECONDS);}}
}

5 自定義MeterFilter

MeterFilter允許您修改或過濾Metrics。例如，可以重命名Metrics，或刪除一些不必要的Metrics。

import io.micrometer.core.instrument.Meter;
import io.micrometer.core.instrument.config.MeterFilter;
import io.micrometer.core.instrument.config.MeterFilterReply;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;@Configuration
public class MicrometerConfig {@Beanpublic MeterFilter renameFilter() {return MeterFilter.renameTag("http.server.requests", "method", "http_method");}@Beanpublic MeterFilter ignoreTagFilter() {return MeterFilter.ignoreTag("uri");}@Beanpublic MeterFilter denyFilter() {return MeterFilter.deny(id -> {String meterName = id.getName();// 拒絕以"temp"開頭的指標return meterName != null && meterName.startsWith("temp");});}
}

6 查看監控數據

啟動Spring Boot應用后，您可以訪問/actuator/prometheus端點查看Prometheus格式的監控數據。

示例輸出：

# HELP jvm_memory_used_bytes The amount of used memory
# TYPE jvm_memory_used_bytes gauge
jvm_memory_used_bytes{application="my-app",area="heap",id="Eden Space",} 1.2632928E7

7 常見問題與解決方案

1. Metric名稱沖突
   如果應用中使用了多個庫，它們都使用了相同的Metric名稱，可能會導致沖突。解決這個問題的方法是使用不同的標簽來區分這些Metrics。

2. 性能問題
   如果應用需要記錄大量的Metrics，可能會導致性能問題。解決這個問題的方法是減少Metrics的數量，或者使用更高效的監控系統。

3. 數據丟失
   如果監控系統出現故障，可能會導致數據丟失。解決這個問題的方法是使用高可用的監控系統，并定期備份數據。

4. 指標基數爆炸
   避免使用高基數的標簽（如用戶ID），這會導致指標數量急劇增加，影響監控系統性能。

8 最佳實踐

1. 標簽設計：使用有限且一致的標簽值集合，避免高基數標簽。

2. 命名規范：使用"."分隔小寫單詞字符，Micrometer會自動轉換為各監控系統適應的格式。

3. 監控策略：只監控關鍵指標，避免過度監控導致系統負載過重。

4. 異常處理：確保指標記錄不會影響主要業務邏輯，妥善處理異常。

5. 文檔化：為自定義指標提供清晰的文檔說明，包括指標名稱、標簽含義和預期值范圍。

9 總結

通過Spring Boot集成Micrometer，我們可以為應用快速添加一個功能強大的"監控儀表盤"，實時了解應用的各項指標，如CPU使用率、內存占用、請求響應時間等。Micrometer作為監控門面，讓我們能夠靈活選擇監控后端，而無需修改代碼。

關鍵要點：

• Micrometer提供與供應商無關的監控指標接口

• Spring Boot自動配置簡化了集成過程

• 合理使用標簽和命名規范避免常見問題

• 結合Grafana等可視化工具可以更好地展示監控數據

通過本文介紹的方法，我們可以快速為Spring Boot應用添加監控功能，及時發現并解決性能問題，確保應用的穩定性和可靠性。

彩蛋

監控參數使用prometheus+grafana展示出來，如下圖所示：