文章詳情頁(yè)

Spring Boot Actuator監(jiān)控的簡(jiǎn)單使用方法示例代碼詳解

瀏覽：148日期：2023-09-01 13:53:00

Spring Boot Actuator幫助我們實(shí)現(xiàn)了許多中間件比如mysql、es、redis、mq等中間件的健康指示器。通過(guò) Spring Boot 的自動(dòng)配置，這些指示器會(huì)自動(dòng)生效。當(dāng)這些組件有問(wèn)題的時(shí)候，HealthIndicator 會(huì)返回 DOWN 或 OUT_OF_SERVICE 狀態(tài)，health 端點(diǎn) HTTP 響應(yīng)狀態(tài)碼也會(huì)變?yōu)?503，我們可以以此來(lái)配置程序健康狀態(tài)監(jiān)控報(bào)警。使用步驟也非常簡(jiǎn)單，這里演示的是線程池的監(jiān)控。模擬線程池滿了狀態(tài)下將HealthInicator指示器變?yōu)镈own的狀態(tài)。

pom中引入jar

<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId></dependency>

引入properties配置

spring.application.name=boot# server.servlet.context-path=/boot# management.server.servlet.context-path=/boot# JVM (Micrometer)要求給應(yīng)用設(shè)置commonTagmanagement.metrics.tags.application=${spring.application.name}#去掉重復(fù)的metricsspring.metrics.servo.enabled=falsemanagement.endpoint.metrics.enabled=truemanagement.endpoint.metrics.sensitive=false#顯式配置不需要權(quán)限驗(yàn)證對(duì)外開(kāi)放的端點(diǎn)management.endpoints.web.exposure.include=*management.endpoints.jmx.exposure.include=*management.endpoint.health.show-details=always#Actuator 的 Web 訪問(wèn)方式的根地址為 /actuator，可以通過(guò) management.endpoints.web.base-path 參數(shù)進(jìn)行修改management.endpoints.web.base-path=/actuatormanagement.metrics.export.prometheus.enabled=true

代碼

/** * @Author jeffSmile * @Date 下午 6:10 2020/5/24 0024 * @Description 定義一個(gè)接口，來(lái)把耗時(shí)很長(zhǎng)的任務(wù)提交到這個(gè) demoThreadPool 線程池，以模擬線程池隊(duì)列滿的情況 **/ @GetMapping('slowTask') public void slowTask() { ThreadPoolProvider.getDemoThreadPool().execute(() -> { try { TimeUnit.HOURS.sleep(1); } catch (InterruptedException e) { } }); }

package com.mongo.boot.service;import jodd.util.concurrent.ThreadFactoryBuilder;import java.util.concurrent.ArrayBlockingQueue;import java.util.concurrent.ThreadPoolExecutor;import java.util.concurrent.TimeUnit;public class ThreadPoolProvider { //一個(gè)工作線程的線程池，隊(duì)列長(zhǎng)度10 private static ThreadPoolExecutor demoThreadPool = new ThreadPoolExecutor( 1, 1, 2, TimeUnit.SECONDS, new ArrayBlockingQueue<>(10), new ThreadFactoryBuilder().setNameFormat('demo-threadpool-%d').get()); //核心線程數(shù)10，最大線程數(shù)50的線程池，隊(duì)列長(zhǎng)度50 private static ThreadPoolExecutor ioThreadPool = new ThreadPoolExecutor( 10, 50, 2, TimeUnit.SECONDS, new ArrayBlockingQueue<>(100), new ThreadFactoryBuilder().setNameFormat('io-threadpool-%d').get()); public static ThreadPoolExecutor getDemoThreadPool() { return demoThreadPool; } public static ThreadPoolExecutor getIOThreadPool() { return ioThreadPool; }}

package com.mongo.boot.service;import org.springframework.boot.actuate.health.Health;import org.springframework.boot.actuate.health.HealthIndicator;import java.util.HashMap;import java.util.Map;import java.util.concurrent.ThreadPoolExecutor;/** * @Author jeffSmile * @Date 下午 6:12 2020/5/24 0024 * @Description 自定義的 HealthIndicator 類，用于單一線程池的健康狀態(tài) **/public class ThreadPoolHealthIndicator implements HealthIndicator { private ThreadPoolExecutor threadPool; public ThreadPoolHealthIndicator(ThreadPoolExecutor threadPool) { this.threadPool = threadPool; } @Override public Health health() { //補(bǔ)充信息 Map<String, Integer> detail = new HashMap<>(); //隊(duì)列當(dāng)前元素個(gè)數(shù) detail.put('queue_size', threadPool.getQueue().size()); //隊(duì)列剩余容量 detail.put('queue_remaining', threadPool.getQueue().remainingCapacity()); //如果還有剩余量則返回UP，否則返回DOWN if (threadPool.getQueue().remainingCapacity() > 0) { return Health.up().withDetails(detail).build(); } else { return Health.down().withDetails(detail).build(); } }}

package com.mongo.boot.service;import org.springframework.boot.actuate.health.CompositeHealthContributor;import org.springframework.boot.actuate.health.HealthContributor;import org.springframework.boot.actuate.health.NamedContributor;import org.springframework.stereotype.Component;import java.util.HashMap;import java.util.Iterator;import java.util.Map;/*** * @Author jeffSmile * @Date 下午 6:13 2020/5/24 0024 * @Description 定義一個(gè) CompositeHealthContributor，來(lái)聚合兩個(gè) ThreadPoolHealthIndicator 的實(shí)例， * 分別對(duì)應(yīng) ThreadPoolProvider 中定義的兩個(gè)線程池 **/@Componentpublic class ThreadPoolsHealthContributor implements CompositeHealthContributor { //保存所有的子HealthContributor private Map<String, HealthContributor> contributors = new HashMap<>(); ThreadPoolsHealthContributor() { //對(duì)應(yīng)ThreadPoolProvider中定義的兩個(gè)線程池 this.contributors.put('demoThreadPool', new ThreadPoolHealthIndicator(ThreadPoolProvider.getDemoThreadPool())); this.contributors.put('ioThreadPool', new ThreadPoolHealthIndicator(ThreadPoolProvider.getIOThreadPool())); } @Override public HealthContributor getContributor(String name) { //根據(jù)name找到某一個(gè)HealthContributor return contributors.get(name); } @Override public Iterator<NamedContributor<HealthContributor>> iterator() { //返回NamedContributor的迭代器，NamedContributor也就是Contributor實(shí)例+一個(gè)命名 return contributors.entrySet().stream() .map((entry) -> NamedContributor.of(entry.getKey(), entry.getValue())).iterator(); }}

啟動(dòng)springboot驗(yàn)證

這里我訪問(wèn):http://localhost:8080/slowTask