SpringBoot Actuator埋點(diǎn)和監(jiān)控及簡(jiǎn)單使用

更新時(shí)間：2021年11月17日 14:51:17 作者：Howl

最近做的項(xiàng)目涉及到埋點(diǎn)監(jiān)控、報(bào)表、日志分析的相關(guān)知識(shí)，于是搗鼓的一番，下面把涉及的知識(shí)點(diǎn)及SpringBoot Actuator埋點(diǎn)和監(jiān)控的簡(jiǎn)單用法，給大家分享下，感興趣的朋友一起看看吧

項(xiàng)目中看到了有埋點(diǎn)監(jiān)控、報(bào)表、日志分析，有點(diǎn)興趣想慢慢搗鼓一下

1. 數(shù)據(jù)埋點(diǎn)

監(jiān)控機(jī)器環(huán)境的性能和業(yè)務(wù)流程或邏輯等各項(xiàng)數(shù)據(jù)，并根據(jù)這些數(shù)據(jù)生成對(duì)應(yīng)的指標(biāo)，那么我們就稱為數(shù)據(jù)埋點(diǎn)。比如我們想知道某個(gè)接口調(diào)用的 TPS、機(jī)器 CPU 的使用率，這些都可以用到數(shù)據(jù)埋點(diǎn)

2. Micrometer

Micrometer 為流行的各種監(jiān)控系統(tǒng)提供了一個(gè)簡(jiǎn)單的門(mén)面（類(lèi)似于日志門(mén)面） —— 提供了與供應(yīng)商無(wú)關(guān)的接口（counters，timers，gauges等），這些接口稱為 meter 接口，其由 MeterRegistry 創(chuàng)建并保存，可理解為 MeterRegistry 是個(gè)集合里面存儲(chǔ)了各種 meter 的度量數(shù)據(jù)，下面展示最簡(jiǎn)單的 counter 接口的使用

2.1 簡(jiǎn)單使用

其還有 timers、gauges 等接口，自行查閱

// 創(chuàng)建一個(gè) meter 注冊(cè)中心
MeterRegistry registry = new SimpleMeterRegistry(); 

// 創(chuàng)建一個(gè)名為 test 度量
Counter counter = meterRegistry.counter("test");

// 讓這個(gè)度量的計(jì)數(shù)加 1
counter.increment();

就是如此簡(jiǎn)單，比如在調(diào)用指定接口的時(shí)候，可以使用 counter 接口來(lái)度量調(diào)用的次數(shù)，頻率等等

2.2 命名規(guī)范

Micrometer 命名用 . 分隔小寫(xiě)單詞字符，在接入其他監(jiān)控系統(tǒng)時(shí)會(huì)自動(dòng)將命名轉(zhuǎn)成其適應(yīng)的格式（或者可重寫(xiě)一個(gè) NamingConvention 轉(zhuǎn)換器來(lái)覆蓋默認(rèn)命名轉(zhuǎn)換）。而且還支持多標(biāo)簽來(lái)量化，即有了多維度的度量，使統(tǒng)計(jì)更加豐富。下面簡(jiǎn)單地舉例命名規(guī)范：

# 表示 http 請(qǐng)求
Counter counter = meterRegistry.counter("http.server.requests");

# 表示 http 請(qǐng)求中，請(qǐng)求 user 模塊
Counter counter = meterRegistry.counter("http.server.requests", "user");

# 表示 http 請(qǐng)求中，請(qǐng)求 user 模塊中，請(qǐng)求 login 登錄方法
Counter counter = meterRegistry.counter("http.server.requests", "user", "login");

3. SpringBoot Actuator

SpringBoot Actuator 其底層使用了 Mircometer ，可度量 SpringBoot 應(yīng)用和獲取它的各項(xiàng)指標(biāo)，可通過(guò) HTTP 或 JMX 來(lái)調(diào)用 Actuator 暴露的各種端點(diǎn)，然后就可以獲取一個(gè)正在運(yùn)行中的應(yīng)用的內(nèi)部狀態(tài)

當(dāng)然內(nèi)部指標(biāo)并不是所有都可以向外暴露的，所以我們得有選擇的開(kāi)放，或者加入權(quán)限校驗(yàn)之后才能獲取如下內(nèi)容：

有那些可配置的屬性
各依賴包的日志級(jí)別
占用了多少內(nèi)存
HTTP 埋點(diǎn)被請(qǐng)求了多少次
應(yīng)用本身以及協(xié)作的外部服務(wù)的健康狀態(tài)
......

3.1 添加依賴

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

3.2 基礎(chǔ)配置

management:
  server:
    port: 9090							# 一般啟動(dòng)獨(dú)立端口（默認(rèn)和應(yīng)用端口一致），啟用后源端口不可查
  endpoints:
    web:
      base-path: /actuator				# 默認(rèn)前綴路徑，可修改
      exposure:
        include: health,info,metrics	# 向外暴露的端點(diǎn)，可用通配符（'*'，需要單引號(hào)）
        exclude: env,heapdump			# 排除暴露的端點(diǎn)

3.3 查看可消費(fèi)的端點(diǎn)

可先用 HTTP 訪問(wèn) localhost:9090/actuator 來(lái)獲取 HATEOAS（可簡(jiǎn)單理解為暴露的端點(diǎn)文檔），它是所有可暴露端點(diǎn)的地圖，可通過(guò)屬性對(duì)應(yīng)的地址來(lái)獲取的指標(biāo)，內(nèi)容如下：

{
  "_links": {
    "self": {
      "href": "http://localhost:9090/actuator",
      "templated": false
    },
    "health-path": {
      "href": "http://localhost:9090/actuator/health/{*path}",
      "templated": true
    },
    "health": {
      "href": "http://localhost:9090/actuator/health",
      "templated": false
    },
    "info": {
      "href": "http://localhost:9090/actuator/info",
      "templated": false
    }
  }
}

3.4 獲取應(yīng)用的基本信息

消費(fèi)對(duì)應(yīng)的指標(biāo)，就在地址后面加上名字即可。應(yīng)用的基本信息是需要自己配置的，沒(méi)有默認(rèn)值，所以首次訪問(wèn) 可訪問(wèn) localhost:9090/actuator/info 是一個(gè)空 json。

可配置 info 開(kāi)頭的屬性，比如聯(lián)系方式，應(yīng)用的作用等等，其配置和消費(fèi)結(jié)果如下：

info:
  contact:
    email: support@howl.com
    phone: 123456789
  description: actuator test application
  
  
# 消費(fèi)結(jié)果
{
  "contact": {
    "email": "support@howl.com",
    "phone": 123456789
  },
  "description": "actuator test application"
}

3.5 健康指標(biāo)

首先嘗試訪問(wèn) localhost:9090/actuator/health，就可以獲取指標(biāo)內(nèi)容了

{
  "status": "UP"
}

這里顯示的是一個(gè)或多個(gè)健康指示器的聚合狀態(tài)，即當(dāng)前應(yīng)用和與之交互的外部系統(tǒng)（數(shù)據(jù)庫(kù)，消息隊(duì)列，Eureka等等）的健康狀態(tài)的聚合狀態(tài)。我們可以添加如下配置來(lái)獲取健康指示器的內(nèi)聚狀態(tài)

management:
  endpoint:
    health:
      show-details: always
      
      
# 消費(fèi)結(jié)果
{
  "status": "UP",
  "components": {
    "diskSpace": {
      "status": "UP",
      "details": {
        "total": 493516484608,
        "free": 436332154880,
        "threshold": 10485760,
        "exists": true
      }
    },
    "ping": {
      "status": "UP"
    }
  }
}

SpringBoot 的自動(dòng)配置功能可以確保只有與應(yīng)用交互的組件才會(huì)顯示到 health 里面

3.6 指標(biāo)端點(diǎn) metrics

可訪問(wèn)如下地址來(lái)獲取 Actuator 提供的開(kāi)箱即用的指標(biāo)分類(lèi)，包括了內(nèi)存、處理器、垃圾收集、HTTP請(qǐng)求等指標(biāo)

http://localhost:9090/actuator/metrics

# 消費(fèi)結(jié)果
{
  "names": [
    "http.server.requests",
    "jvm.buffer.count",
    "jvm.buffer.memory.used",
    "jvm.buffer.total.capacity",
    "jvm.classes.loaded",
    "jvm.classes.unloaded",
    "jvm.gc.live.data.size",
    "jvm.gc.max.data.size",
    "jvm.gc.memory.allocated",
    "jvm.gc.memory.promoted",
    "jvm.gc.pause",
    "jvm.memory.committed",
    "jvm.memory.max",
    "jvm.memory.used",
    "jvm.threads.daemon",
    "jvm.threads.live",
    "jvm.threads.peak",
    "jvm.threads.states",
    "logback.events",
    "process.cpu.usage",
    "process.start.time",
    "process.uptime",
    "system.cpu.count",
    "system.cpu.usage",
    "tomcat.sessions.active.current",
    "tomcat.sessions.active.max",
    "tomcat.sessions.alive.max",
    "tomcat.sessions.created",
    "tomcat.sessions.expired",
    "tomcat.sessions.rejected"
  ]
}

# 可用標(biāo)準(zhǔn)地址 + 指標(biāo)端點(diǎn)名字 來(lái)消費(fèi)某個(gè)指標(biāo)端點(diǎn)
http://localhost:9090/actuator/metrics/http.server.requests

4. 實(shí)例

統(tǒng)計(jì) /user/login 接口被調(diào)用的次數(shù)，meterRegistry 注冊(cè)中心在自動(dòng)配置中加入容器可直接使用

4.1 測(cè)試接口

啟動(dòng)應(yīng)用，然后多次訪問(wèn)這個(gè)接口

@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    SimpleMeterRegistry meterRegistry;

    @GetMapping("/login")
    public String userLogin() {
        Counter counter = meterRegistry.counter("http.server.requests", "uri", "/user/login");
        counter.increment();
        return "登錄成功";
    }
}

4.2 消費(fèi)指標(biāo)端點(diǎn)

訪問(wèn)如下地址即可消費(fèi)端點(diǎn)

http://localhost:9090/actuator/metrics/http.server.requests?tag=uri:/user/login

# 消費(fèi)結(jié)果
# 可以看到這個(gè)接口度量（COUNT）了 18次 訪問(wèn)（數(shù)據(jù)做了部分清除）
{
  "name": "http.server.requests",
  "baseUnit": "seconds",
  "measurements": [
    {
      "statistic": "COUNT",
      "value": 18.0
    }
  ],
  "availableTags": [
    {
      "tag": "method",
      "values": [
        "GET"
      ]
    }
  ]
}

5. SpringBoot Admin

使用上面的地址訪問(wèn)指標(biāo)很不友好，不可能看一堆這樣的數(shù)據(jù)，得使用一些美化的 UI 界面，SpringBoot Admin 就提供了這樣的框架

SpringBoot Admin 作為簡(jiǎn)單的監(jiān)控，分為服務(wù)器端和客戶端

5.1 Admin 服務(wù)器端

作為監(jiān)控的服務(wù)端一般是在另外一臺(tái)服務(wù)器上部署的，然后這臺(tái)服務(wù)器會(huì)定時(shí)去配置好的地址里面拉取監(jiān)控的指標(biāo)數(shù)據(jù)

5.1.1 啟用功能、添加依賴

在初始化應(yīng)用的時(shí)候在 Spring Initializr 也可以選擇

@EnableAdminServer
@SpringBootApplication
public class AdminApplication {
    public static void main(String[] args) {
        SpringApplication.run(AdminApplication.class, args);
    }
}
<dependency>
     <groupId>de.codecentric</groupId>
     <artifactId>spring-boot-admin-starter-server</artifactId>
     <version>2.4.3</version>
</dependency>

5.1.2 選擇一個(gè)端口

server:
  port: 10000

5.1.3 訪問(wèn)

直接訪問(wèn) 10000 端口即可，當(dāng)然現(xiàn)在沒(méi)有東西可以監(jiān)控，主頁(yè)面是空白沒(méi)應(yīng)用的

5.2 Client 客戶端

5.2.1 添加依賴

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

<!--  admin-client  -->
<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-starter-client</artifactId>
    <version>2.4.3</version>
</dependency>

5.2.2添加配置

# 服務(wù)端用客戶端的主機(jī)名來(lái)通信，但在虛擬機(jī)上客戶端主機(jī)名會(huì)解析不正確，導(dǎo)致實(shí)例一直下線狀態(tài)
# 此時(shí)需要如下配置

spring:
  application:
    name: actuatorApplicaton
  boot:
    admin:
      client:
        url: http://admin-serve-ip:10000						# 向服務(wù)端定時(shí)發(fā)送請(qǐng)求
        instance:
          service-url: http://admin-client-ip:8080				# 主頁(yè)
          management-base-url: http://admin-client-ip:9090		# 各類(lèi)指標(biāo)的基礎(chǔ)地址

5.2.3 訪問(wèn) admin-serve

訪問(wèn)即可發(fā)現(xiàn)有個(gè)應(yīng)用的指標(biāo)被獲取了，然后里面可以看各種已經(jīng)暴露的端點(diǎn)指標(biāo)

5.3 Eureka 服務(wù)器發(fā)現(xiàn)

上面每啟動(dòng)一個(gè)客戶端都要手動(dòng)進(jìn)行配置監(jiān)控的 IP 地址很是麻煩，既然微服務(wù)架構(gòu)有服務(wù)發(fā)現(xiàn)機(jī)制的，那么我們可以在監(jiān)控的服務(wù)端上配置 Eureka 的地址，那么 Admin-Server 就會(huì)去注冊(cè)中心獲取地址再去拉取指標(biāo)

5.3.1 加依賴

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    <version>2.4.3</version>
</dependency>

5.3.2 添加配置

eureka:
  client:
    service-url:
      defaultZone: http://xxx.xxx.xxx.xxx:xxx/eureka/

6 缺點(diǎn)

筆者個(gè)人覺(jué)得個(gè)人小型項(xiàng)目用這個(gè)組合來(lái)監(jiān)控埋點(diǎn)已經(jīng)足夠了，加上警告處理都是很不錯(cuò)的選擇，但是 SpringBoot Admin 只能監(jiān)控短時(shí)間內(nèi)的應(yīng)用信息，如果需要各時(shí)間段的監(jiān)控那么就需要有時(shí)序數(shù)據(jù)庫(kù)的支持（比如查看這個(gè)月內(nèi)的統(tǒng)計(jì)信息），這些就顯得無(wú)能為力了。

當(dāng)然還是有代替方案的：

Actuator：埋點(diǎn)操作
Promethus：定期去 actuator 拉取數(shù)據(jù)并以時(shí)序的形式存儲(chǔ)（內(nèi)部有時(shí)序數(shù)據(jù)庫(kù)）
Granfan：用戶友好的 UI 數(shù)據(jù)展示，展示 Promethus 的數(shù)據(jù)

到此這篇關(guān)于SpringBoot Actuator埋點(diǎn)和監(jiān)控的文章就介紹到這了,更多相關(guān)SpringBoot Actuator監(jiān)控內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

到此這篇關(guān)于SpringBoot Actuator埋點(diǎn)和監(jiān)控及簡(jiǎn)單使用的文章就介紹到這了,更多相關(guān)SpringBoot Actuator監(jiān)控內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: