開(kāi)發(fā)腳手架集成Spring?Boot?Actuator監(jiān)控的方法

今天小編給大家分享一下開(kāi)發(fā)腳手架集成Spring Boot Actuator監(jiān)控的方法的相關(guān)知識(shí)點(diǎn)，內(nèi)容詳細(xì)，邏輯清晰，相信大部分人都還太了解這方面的知識(shí)，所以分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后有所收獲，下面我們一起來(lái)了解一下吧。

集成

引入依賴(lài)

在項(xiàng)目的pom.xml中增加以下依賴(lài)

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

配置文件

在application.yml中

management:
   # 禁用執(zhí)行器端點(diǎn)的安全檢查
   security:
      enabled: false

訪(fǎng)問(wèn)驗(yàn)證

例如，輸入http://localhost:8080/actuator/health，我們可以查看應(yīng)用程序當(dāng)前狀態(tài)

{
    "status": "UP"
}

這個(gè)接口經(jīng)常用于服務(wù)探活或者健康檢查接口。

到這里就集成完成了哈。

端點(diǎn) Endpoints

Actuator默認(rèn)把所有訪(fǎng)問(wèn)點(diǎn)暴露給JMX，但處于安全原因，只有health和info會(huì)暴露給Web。

Actuator提供的所有訪(fǎng)問(wèn)點(diǎn)均在官方文檔列出，要暴露更多的訪(fǎng)問(wèn)點(diǎn)給Web，需要在application.yml中加上配置：

management:
  endpoints:
    web:
      exposure:
        # 包含所有端點(diǎn)使用 "*"，注意有引號(hào)
        include: info, health, beans, env, metrics

Actuator 提供了以下接口，具體如下表所示。

下面著重講下實(shí)際項(xiàng)目用到的。

Health

health 主要用來(lái)檢查應(yīng)用的運(yùn)行狀態(tài)，這是我們使用最高頻的一個(gè)監(jiān)控點(diǎn)。監(jiān)控實(shí)例的運(yùn)行狀態(tài)，以及應(yīng)用不”健康“的原因，比如數(shù)據(jù)庫(kù)連接、磁盤(pán)空間不夠等。

健康信息詳情是否公開(kāi)可以配置，例如：

management.endpoint.health.show-details=always

• never 從不顯示細(xì)節(jié)，默認(rèn)

• when-authorized 詳細(xì)信息僅向授權(quán)用戶(hù)顯示?？梢允褂?配置授權(quán)角色management.endpoint.health.roles。

• always 向所有用戶(hù)顯示詳細(xì)信息。

Spring Boot 會(huì)自動(dòng)配置HealthIndicators下表中列出的內(nèi)容。您也可以通過(guò)配置啟用或禁用選定的指標(biāo)management.health.key.enabled，key如下表所示：

可以在配置文件中關(guān)閉特定的健康檢查指標(biāo)，比如關(guān)閉 redis 的健康檢查：

management.health.redis.enabled=false

Info

info 就是我們自己配置在配置文件中以 info 開(kāi)頭的配置信息，您可以通過(guò)設(shè)置Spring 屬性來(lái)自定義info端點(diǎn)公開(kāi)的數(shù)據(jù)。info.*鍵下的所有Environment屬性都會(huì)自動(dòng)公開(kāi)。例如，您可以將以下設(shè)置添加到application.yaml文件中：

info:
  app:
    name: spring-boot-actuator
    version: 1.0.0
    test: test
    encoding: @project.build.sourceEncoding@
    source: @java.version@
    target: @java.version@

啟動(dòng)項(xiàng)目，訪(fǎng)問(wèn)：http://localhost:8080/actuator/info返回部分信息如下：

{
	"app": {
		"name": "spring-boot-actuator",
		"version": "1.0.0",
		"test": "test",
		"encoding": "UTF-8",
		"source": "1.8.0_102",
		"target": "1.8.0_102"
	}
}

安全

要特別注意暴露的URL的安全性，例如，/actuator/env可以獲取當(dāng)前機(jī)器的所有環(huán)境變量，不可暴露給公網(wǎng)。

為了保證 actuator 暴露的監(jiān)控接口的安全性，需要添加安全控制的依賴(lài)spring-boot-start-security依賴(lài)，訪(fǎng)問(wèn)應(yīng)用監(jiān)控端點(diǎn)時(shí)，都需要輸入驗(yàn)證信息。

則默認(rèn)情況下使用基于表單的HTTP身份驗(yàn)證來(lái)保護(hù)端點(diǎn)。

Security 依賴(lài)，可以選擇不加，不進(jìn)行安全管理，但不建議這么做。

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

代碼如下：

@Configuration
public class ActuatorSecurityConfig extends WebSecurityConfigurerAdapter {

    /*
     * version1:
     * 1. 限制 '/shutdown'端點(diǎn)的訪(fǎng)問(wèn)，只允許ACTUATOR_ADMIN訪(fǎng)問(wèn)
     * 2. 允許外部訪(fǎng)問(wèn)其他的端點(diǎn)
     * 3. 允許外部訪(fǎng)問(wèn)靜態(tài)資源
     * 4. 允許外部訪(fǎng)問(wèn) '/'
     * 5. 其他的訪(fǎng)問(wèn)需要被校驗(yàn)
     * version2:
     * 1. 限制所有端點(diǎn)的訪(fǎng)問(wèn)，只允許ACTUATOR_ADMIN訪(fǎng)問(wèn)
     * 2. 允許外部訪(fǎng)問(wèn)靜態(tài)資源
     * 3. 允許外部訪(fǎng)問(wèn) '/'
     * 4. 其他的訪(fǎng)問(wèn)需要被校驗(yàn)
     */

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        // version1
//        http
//                .authorizeRequests()
//                    .requestMatchers(EndpointRequest.to(ShutdownEndpoint.class))
//                        .hasRole("ACTUATOR_ADMIN")
//                .requestMatchers(EndpointRequest.toAnyEndpoint())
//                    .permitAll()
//                .requestMatchers(PathRequest.toStaticResources().atCommonLocations())
//                    .permitAll()
//                .antMatchers("/")
//                    .permitAll()
//                .antMatchers("/**")
//                    .authenticated()
//                .and()
//                .httpBasic();

        // version2
        http
                .authorizeRequests()
                .requestMatchers(EndpointRequest.toAnyEndpoint())
                    .hasRole("ACTUATOR_ADMIN")
                .requestMatchers(PathRequest.toStaticResources().atCommonLocations())
                    .permitAll()
                .antMatchers("/")
                    .permitAll()
                .antMatchers("/**")
                    .authenticated()
                .and()
                .httpBasic();
    }
}

application.properties的相關(guān)配置如下：

# Spring Security Default user name and password
spring.security.user.name=actuator
spring.security.user.password=actuator
spring.security.user.roles=ACTUATOR_ADMIN

高級(jí)

自定義健康檢查

要提供自定義健康信息，您可以注冊(cè)實(shí)現(xiàn)該HealthIndicator接口的 Spring bean。您需要提供該health()方法的實(shí)現(xiàn)并返回Health響應(yīng)。Health響應(yīng)應(yīng)包含狀態(tài)，并且可以選擇包含要顯示的其他詳細(xì)信息。以下代碼顯示了一個(gè)示例HealthIndicator實(shí)現(xiàn)：

@Component
public class EasyAdminHealthIndicator extends AbstractHealthIndicator {
    @Override
    public void doHealthCheck(Health.Builder builder) throws Exception {
        boolean checkHealth = check();
        if (checkHealth) {
            builder.up();
        } else {
            builder.down();
        }
        builder.withDetail("code", "200")
                .withDetail("msg", "i am ok");
    }
    private boolean check() {
        return true;
    }
}

啟動(dòng)項(xiàng)目，訪(fǎng)問(wèn)：http://localhost:8080/actuator/health返回信息如下：

{
	"status": "UP",
	"components": {
		"db": {
			"status": "UP",
			"details": {
				"database": "MySQL",
				"validationQuery": "isValid()"
			}
		},
		"diskSpace": {
			"status": "UP",
			"details": {
				"total": 332861009920,
				"free": 312464228352,
				"threshold": 10485760,
				"exists": true
			}
		},
		"easyAdmin": {         // do do do
			"status": "UP",
			"details": {
				"code": "200",
				"msg": "i am ok"
			}
		},
		"mail": {
			"status": "UP",
			"details": {
				"location": "smtp.qq.com:-1"
			}
		},
		"ping": {
			"status": "UP"
		}
	}
}

自定義metrics指標(biāo)

兩種常用指標(biāo)類(lèi)型(Metric Type)

gauge, counter, summary, timer

gauge: 可增可減計(jì)數(shù)器，反應(yīng)某值當(dāng)前一刻狀態(tài)。比如稱(chēng)重傳感器的當(dāng)前重量，溫度傳感器的當(dāng)前溫度。

方式一:

Gauge.builder("gn.temperature.gauge", new AtomicInteger(37), AtomicInteger::get)

方式二：

registry.gauge("gn.temperature.gauge", Tags.of("site", "SiteA", "cab", "cab01"), new AtomicInteger(37));

counter：只增不減計(jì)數(shù)器，是Gauge的一個(gè)特例。適用于只有服務(wù)器重啟時(shí)候才會(huì)重置的計(jì)數(shù)場(chǎng)景。比如"用戶(hù)訪(fǎng)問(wèn)次數(shù)"，某接口失敗次數(shù)"等等。API 使用方式類(lèi)似。

Counter counter = Counter.builder("gn.beat.counter")
  .tags("site", "SiteA", "function", "foo")
  .description("for request errors")
  .register(registry);
counter.increment();

融入到系統(tǒng)的方式

方式一: 業(yè)務(wù)系統(tǒng)埋點(diǎn)

@Component
public class SampleBean {
    private final Counter counter;
    private final List<String> list = new CopyOnWriteArrayList<>();;
    public SampleBean(MeterRegistry registry) {
        this.counter = registry.counter("laker.counter");
         registry.gauge("laker.size", Tags.empty(), this.list.size());
    }
    public void handleMessage(String message) {
        this.counter.increment();
        list.add(message);
    }
    public void handleRemoveMessage(String message) {
        list.remove(message);
    }
}

方式二：MeterBinder

SpringBoot中提供了MeterBinder接口用于申明與注冊(cè)meterRegistry。自定義Metrics只需要實(shí)現(xiàn)MeterBinder接口，Spring會(huì)自動(dòng)發(fā)現(xiàn)并完成后續(xù)的雜活。

@Bean
public class MyMetrics implements MeterBinder {
   @Override
   public void bindTo(MeterRegistry meterRegistry) {
    //此處添加相關(guān)指標(biāo)
    meterRegistry.gauge("laker.gauge", Tags.of("site", "SiteA"), new AtomicInteger(37));
   }
}

在瀏覽器訪(fǎng)問(wèn)http://localhost:8080/actuator/metrics/laker.counter

結(jié)果如下：

{
    "name": "laker.counter",
    "description": null,
    "baseUnit": null,
    "measurements": [
        {
            "statistic": "COUNT",
            "value": 9.0
        }
    ],
    "availableTags": []
}

其他使用情況可參考：MetricsAutoConfiguration.java

PID PORT過(guò)程監(jiān)控

• ApplicationPidFileWriter創(chuàng)建一個(gè)包含應(yīng)用程序 PID 的文件（默認(rèn)情況下，在應(yīng)用程序目錄中，文件名為application.pid）。

• WebServerPortFileWriter創(chuàng)建一個(gè)文件（或多個(gè)文件），其中包含正在運(yùn)行的 Web 服務(wù)器的端口（默認(rèn)情況下，在應(yīng)用程序目錄中，文件名為application.port）。

默認(rèn)情況下，這些編寫(xiě)器未激活：

@SpringBootApplication
public class LakerMapApplication {
    public static void main(String[] args) {
        SpringApplication springApplication = new SpringApplication(LakerMapApplication.class);
        springApplication.addListeners(new ApplicationPidFileWriter(), new WebServerPortFileWriter("./laker.port"));
        springApplication.run(args);
    }
}

配置文件：

spring: 
  pid:
    # 寫(xiě)入pid的文件
    file: ./laker.pid
    # 當(dāng)無(wú)法寫(xiě)入pid文件的時(shí)候，是否拋出異常
    fail-on-write-error: false

自定義管理端點(diǎn)路徑

management.endpoints.web.base-path=/manage

將端點(diǎn)從/actuator/{id}更改為/manage/{id}（例如，/manage/info）。

如果要將端點(diǎn)映射到不同的路徑，可以使用該management.endpoints.web.path-mapping屬性。

以下示例重新映射/actuator/health到/healthcheck：

management.endpoints.web.base-path=/
management.endpoints.web.path-mapping.health=healthcheck

自定義管理服務(wù)器端口

management.server.port=8081
management.server.address=127.0.0.1

暴露數(shù)據(jù)給Prometheus

因?yàn)楸┞秲?nèi)部信息的特性，Actuator 也可以和一些外部的應(yīng)用監(jiān)控系統(tǒng)整合（Prometheus, Graphite, DataDog, Influx, Wavefront, New Relic等）。這些監(jiān)控系統(tǒng)提供了出色的儀表板，圖形，分析和警報(bào)，可幫助你通過(guò)一個(gè)統(tǒng)一友好的界面，監(jiān)視和管理你的應(yīng)用程序。

添加依賴(lài)

為了讓Spring Boot 應(yīng)用和Prometheus 集成，你需要增加micrometer-registry-prometheus依賴(lài)。

<!-- Micrometer Prometheus registry  -->
<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-registry-prometheus</artifactId>
</dependency>

添加上述依賴(lài)項(xiàng)之后，Spring Boot 將會(huì)自動(dòng)配置 PrometheusMeterRegistry 和 CollectorRegistry來(lái)以Prometheus 可以抓取的格式收集和導(dǎo)出指標(biāo)數(shù)據(jù)。

所有的相關(guān)數(shù)據(jù)，都會(huì)在Actuator 的 /prometheus端點(diǎn)暴露出來(lái)。Prometheus 可以抓取該端點(diǎn)以定期獲取度量標(biāo)準(zhǔn)數(shù)據(jù)。

添加micrometer-registry-prometheus依賴(lài)后，我們?cè)L問(wèn)http://localhost:8080/actuator/prometheus地址。

以上就是“開(kāi)發(fā)腳手架集成Spring Boot Actuator監(jiān)控的方法”這篇文章的所有內(nèi)容，感謝各位的閱讀！相信大家閱讀完這篇文章都有很大的收獲，小編每天都會(huì)為大家更新不同的知識(shí)，如果還想學(xué)習(xí)更多的知識(shí)，請(qǐng)關(guān)注億速云行業(yè)資訊頻道。