SpringBoot Actuator監控應用

時間 2019-11-11

標籤 springboot actuator 監控應用欄目 Spring 简体版

原文原文鏈接

微服務的特色決定了功能模塊的部署是分佈式的，大部分功能模塊都是運行在不一樣的機器上，彼此經過服務調用進行交互，先後臺的業務流會通過不少個微服務的處理和傳遞，出現異常如何快速定位便成爲了一個問題，在這種框架下微服務的監控顯得尤其重要。html

Spring Boot 是一個自帶監控的開源框架，組件 Spring Boot Actuator 負責監控應用的各項靜態和動態的變量。項目結合 Spring Boot Actuator 的使用，即可輕鬆對 Spring Boot 應用監控治理，Spring Boot 的 Actuator 提供了不少生產級的特性，好比監控和度量 Spring Boot 應用程序，這些特性能夠經過衆多 REST 接口、遠程 Shell 和 JMX 得到。java

1、Actuator 監控

Spring Boot 使用「習慣優於配置的理念」，採用包掃描和自動化配置的機制來加載依賴 jar 中的 Spring Bean，不須要任何 XML 配置，就能夠實現 Spring 的全部配置。雖然這樣作能讓代碼變得很是簡潔，可是整個應用的實例建立和依賴關係等信息都被離散到了各個配置類的註解上，這使得咱們分析整個應用中資源和實例的各類關係變得很是的困難。web

只須要在項目中添加 spring-boot-starter-actuator，就自動啓用了監控功能。

<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>
</dependencies>

添加 spring-boot-starter-web 主要是爲了保持應用運行狀態。redis
Spring Boot Actuator 是 Spring Boot 提供的對應用系統的檢查和監控的集成功能，能夠查看應用配置的詳細信息，例如自動化配置信息、建立的 Spring beans 以及一些環境屬性等。算法

2、Actuator 的 REST 接口

Actuator 監控分紅兩類：原生端點和用戶自定義端點。自定義端點主要是指擴展性，用戶能夠根據本身的實際應用，定義一些比較關心的指標，在運行期進行監控。spring
原生端點是在應用程序裏提供衆多 Web 接口，經過它們瞭解應用程序運行時的內部情況，原生端點又能夠分紅三類：數據庫
- 應用配置類，能夠查看應用在運行期的靜態信息，例如自動配置信息、加載的 springbean 信息、yml 文件配置信息、環境信息、請求映射信息；
- 度量指標類，主要是運行期的動態信息，如堆棧、請求連、一些健康指標、metrics 信息等；
- 操做控制類，主要是指 shutdown，用戶能夠發送一個請求將應用的監控功能關閉。
Actuator 提供了 13 個接口，具體以下表所示。apache

3、命令詳解

在 Spring Boot 2.x 中爲了安全起見，Actuator 只開放了兩個端點 /actuator/health 和 /actuator/info，能夠在配置文件中設置打開。
能夠打開全部的監控點：

management.endpoints.web.exposure.include=*

也能夠選擇打開部分：

management.endpoints.web.exposure.exclude=beans,trace

Actuator 默認全部的監控點路徑都在 /actuator/*，固然若是有須要這個路徑也支持定製。

// 設置完重啓後，再次訪問地址就會變成 /manage/*
management.endpoints.web.base-path=/manage

Actuator 幾乎監控了應用涉及的方方面面，咱們重點講述一些常常在項目中經常使用的命令。

一、health

health 主要用來檢查應用的運行狀態，這是咱們使用最高頻的一個監控點，一般使用此接口提醒咱們應用實例的運行狀態，以及應用不「健康」的緣由，如數據庫鏈接、磁盤空間不夠等。tomcat
默認狀況下 health 的狀態是開放的，添加依賴後啓動項目，訪問：http://localhost:8080/actuator/health 便可看到應用的狀態。安全

{
    "status" : "UP"
}

默認狀況下，最終的 Spring Boot 應用的狀態是由 HealthAggregator 彙總而成的，彙總的算法是：
- 設置狀態碼順序爲 setStatusOrder(Status.DOWN, Status.OUTOFSERVICE, Status.UP, Status.UNKNOWN);
- 過濾掉不能識別的狀態碼
- 若是無任何狀態碼，整個 Spring Boot 應用的狀態是 UNKNOWN
- 將全部收集到的狀態碼按照 1 中的順序排序
- 返回有序狀態碼序列中的第一個狀態碼，做爲整個 Spring Boot 應用的狀態
health 經過合併幾個健康指數檢查應用的健康狀況。Spring Boot Actuator 有幾個預約義的健康指標好比 DataSourceHealthIndicator、DiskSpaceHealthIndicator、MongoHealthIndicator、RedisHealthIndicator 等，它使用這些健康指標做爲健康檢查的一部分。
舉個例子，若是你的應用使用 Redis，RedisHealthindicator 將被看成檢查的一部分；若是使用 MongoDB，那麼 MongoHealthIndicator 將被看成檢查的一部分。
能夠在配置文件中關閉特定的健康檢查指標，好比關閉 Redis 的健康檢查：

management.health.redise.enabled=false

默認全部的這些健康指標被看成健康檢查的一部分。
詳細的健康檢查信息
默認只是展現了簡單的 UP 和 DOWN 狀態，爲了查詢更詳細的監控指標信息，能夠在配置文件中添加如下信息：

management.endpoint.health.show-details=always

重啓後再次訪問網址 http://localhost:8080/actuator/health，返回信息以下：

{
  "status": "UP",
  "diskSpace": {
    "status": "UP",
    "total": 209715195904,
    "free": 183253909504,
    "threshold": 10485760
  }
}

能夠看到 HealthEndPoint 給咱們提供默認的監控結果，包含磁盤空間描述總磁盤空間，剩餘的磁盤空間和最小閾值。

其實看 Spring Boot-actuator 源碼，會發現 HealthEndPoint 提供的信息不只限於此，在 org.springframework.boot.actuate.health 包下會發現 ElasticsearchHealthIndicator、RedisHealthIndicator、RabbitHealthIndicator 等。

二、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"
  }
}

三、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": [

        ]
      }
  }
]

四、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"
                }
            ]
        }
    }
}

五、configprops

查看配置文件中設置的屬性內容以及一些配置屬性的默認值。
啓動示例項目，訪問網址 http://localhost:8080/actuator/configprops 返回部分信息以下：

{
  ...
  "environmentEndpoint": {
    "prefix": "endpoints.env",
    "properties": {
      "id": "env",
      "sensitive": true,
      "enabled": true
    }
  },
  "spring.http.multipart-org.springframework.boot.autoconfigure.web.MultipartProperties": {
    "prefix": "spring.http.multipart",
    "properties": {
      "maxRequestSize": "10MB",
      "fileSizeThreshold": "0",
      "location": null,
      "maxFileSize": "1MB",
      "enabled": true,
      "resolveLazily": false
    }
  },
  "infoEndpoint": {
    "prefix": "endpoints.info",
    "properties": {
      "id": "info",
      "sensitive": false,
      "enabled": true
    }
  }
  ...
}

六、env

展現了系統環境變量的配置信息，包括使用的環境變量、JVM 屬性、命令行參數、項目使用的 jar 包等信息。和 configprops 不一樣的是，configprops 關注於配置信息，env 關注運行環境信息。
啓動示例項目，訪問網址 http://localhost:8080/actuator/env 返回部分信息以下：

{
  "profiles": [

  ],
  "server.ports": {
    "local.management.port": 8088,
    "local.server.port": 8080
  },
  "servletContextInitParams": {

  },
  "systemProperties": {
    "com.sun.management.jmxremote.authenticate": "false",
    "java.runtime.name": "Java(TM) SE Runtime Environment",
    "spring.output.ansi.enabled": "always",
    "sun.boot.library.path": "C:\\Program Files\\Java\\jdk1.8.0_101\\jre\\bin",
    "java.vm.version": "25.101-b13",
    "java.vm.vendor": "Oracle Corporation",
    "java.vendor.url": "http://java.oracle.com/",
    "java.rmi.server.randomIDs": "true",
    "path.separator": ";",
    "java.vm.name": "Java HotSpot(TM) 64-Bit Server VM",
    "file.encoding.pkg": "sun.io",
    "user.country": "CN",
    "user.script": "",
    "sun.java.launcher": "SUN_STANDARD",
    "sun.os.patch.level": "",
    "PID": "5268",
    "com.sun.management.jmxremote.port": "60093",
    "java.vm.specification.name": "Java Virtual Machine Spe

爲了不敏感信息暴露到 /env 裏，全部名爲 password、secret、key（或者名字中最後一段是這些）的屬性在 /env 裏都會加上「*」。舉個例子，若是有一個屬性名字是 database.password，那麼它在 /env 中的顯示效果是這樣的：

"database.password":"******"

/env/{name} 用法

就是 env 的擴展能夠獲取指定配置信息，好比http://localhost:8080/actuator/env/java.vm.version，返回
{"java.vm.version":"25.101-b13"}

七、heapdump

返回一個 GZip 壓縮的 JVM 堆 dump。
啓動示例項目，訪問網址 http://localhost:8080/actuator/heapdump 會自動生成一個 JVM 的堆文件 heapdump，咱們可使用 JDK 自帶的 JVM 監控工具 VisualVM 打開此文件查看內存快照。相似以下圖：

八、httptrace

該端點用來返回基本的 HTTP 跟蹤信息。默認狀況下，跟蹤信息的存儲採用 org.springframework.boot.actuate.trace.InMemoryTraceRepository 實現的內存方式，始終保留最近的 100 條請求記錄。
啓動示例項目，訪問網址 http://localhost:8080/actuator/httptrace，返回信息以下：

{
    "traces": [
        {
            "timestamp": "2018-11-21T12:42:25.333Z", 
            "principal": null, 
            "session": null, 
            "request": {
                "method": "GET", 
                "uri": "http://localhost:8080/actuator/heapdump", 
                "headers": {
                    "cookie": [
                        "Hm_lvt_0fb30c642c5f6453f17d881f529a1141=1513076406,1514961720,1515649377; Hm_lvt_6d8e8bb59814010152d98507a18ad229=1515247964,1515296008,1515672972,1516086283; UM_distinctid=1647364371ef6-003ab9d0469ea5-b7a103e-100200-1647364371f104; CNZZDATA1260945749=232252692-1513233181-%7C1537492730"
                    ], 
                    "accept-language": [
                        "zh-CN,zh;q=0.9"
                    ], 
                    "upgrade-insecure-requests": [
                        "1"
                    ], 
                    "host": [
                        "localhost:8080"
                    ], 
                    "connection": [
                        "keep-alive"
                    ], 
                    "accept-encoding": [
                        "gzip, deflate, br"
                    ], 
                    "accept": [
                        "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8"
                    ], 
                    "user-agent": [
                        "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36"
                    ]
                }, 
                "remoteAddress": null
            }, 
            "response": {
                "status": 200, 
                "headers": {
                    "Accept-Ranges": [
                        "bytes"
                    ], 
                    "Content-Length": [
                        "39454385"
                    ], 
                    "Date": [
                        "Wed, 21 Nov 2018 12:42:25 GMT"
                    ], 
                    "Content-Type": [
                        "application/octet-stream"
                    ]
                }
            }, 
            "timeTaken": 1380
        }, 
        {
           ...
        }, 
          ...
    ]
}

記錄了請求的整個過程的詳細信息。

九、metrics

最重要的監控內容之一，主要監控了 JVM 內容使用、GC 狀況、類加載信息等。
啓動示例項目，訪問網址 http://localhost:8080/actuator/metrics 返回部分信息以下：

{
  "mem": 337132,
  "mem.free": 183380,
  "processors": 4,
  "instance.uptime": 254552,
  "uptime": 259702,
  "systemload.average": -1.0,
  "heap.committed": 292864,
  "heap.init": 129024,
  "heap.used": 109483,
  "heap": 1827840,
  "nonheap.committed": 45248,
  "nonheap.init": 2496,
  "nonheap.used": 44269,
  "nonheap": 0,
  "threads.peak": 63,
  "threads.daemon": 43,
  "threads.totalStarted": 83,
  "threads": 46,
  "classes": 6357,
  "classes.loaded": 6357,
  "classes.unloaded": 0,
  "gc.ps_scavenge.count": 8,
  "gc.ps_scavenge.time": 99,
  "gc.ps_marksweep.count": 1,
  "gc.ps_marksweep.time": 43,
  "httpsessions.max": -1,
  "httpsessions.active": 0
}

對 /metrics 接口提供的信息進行簡單分類以下表：
解釋說明
- 請注意，這裏的一些度量值，好比數據源和 Tomcat 會話，僅在應用程序中運行特定組件時纔有數據，還能夠註冊本身的度量信息。
- HTTP 的計數器和度量值須要作一點說明，counter.status 後的值是 HTTP 狀態碼，隨後是所請求的路徑。舉個例子，counter.status.200.metrics 代表 /metrics 端點返回 200(OK) 狀態碼的次數。
- HTTP 的度量信息在結構上也差很少，卻在報告另外一類信息。它們所有以 gauge.response 開頭，代表這是 HTTP 響應的度量信息，前綴後是對應的路徑，度量值是以毫秒爲單位的時間，反映了最近處理該路徑請求的耗時。
- 這裏還有幾個特殊的值須要注意，root 路徑指向的是根路徑或/，star-star 表明了那些 Spring 認爲是靜態資源的路徑，包括圖片、JavaScript 和樣式表，其中還包含了那些找不到的資源，這就是爲何常常會看到 counter.status.404.star-star，由於返回了 HTTP 404 (NOT FOUND) 狀態的請求數。　　
- /metrics 接口會返回全部的可用度量值，但你也可能只對某個值感興趣。要獲取單個值，請求時能夠在 URL 後加上對應的鍵名。例如，要查看空閒內存大小，能夠向 /metrics/mem.free 發一個GET請求，好比訪問網址 http://localhost:8080/actuator/metrics/mem.free，返回：{"mem.free":178123}。

十、shutdown

開啓接口優雅關閉 Spring Boot 應用，要使用這個功能首先須要在配置文件中開啓：

management.endpoint.shutdown.enabled=true

配置完成以後，啓動示例項目，使用 curl 模擬 post 請求訪問 shutdown 接口。

shutdown 接口默認只支持 post 請求。

curl -X POST "http://localhost:8080/actuator/shutdown" 
{
    "message": "Shutting down, bye..."
}

此時會發現應用已經被關閉。

十一、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)"
  }
}

十二、threaddump

/threaddump 接口會生成當前線程活動的快照，這個功能很是好，方便咱們在平常定位問題的時候查看線程的狀況，主要展現了線程名、線程 ID、線程的狀態、是否等待鎖資源等信息。
啓動示例項目，訪問網址 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
    }
  }
  ...
]

生產出現問題的時候，能夠經過應用的線程快照來檢測應用正在執行的任務。

4、總結

通過這節課實踐咱們發現 Spring Boot Actuator 做爲 Spring Boot 自帶的監控組件很是強大，它能夠監控和管理 Spring Boot 應用，如健康檢查、審計、統計和 HTTP 追蹤等，全部的這些特性能夠經過 JMX 或者 HTTP endpoints 來得到。使用 Spring Boot Actuator 以後，可讓咱們經過很簡單的接口或者命令來查詢應用的一切運行狀態，從而達到對應用的運行狀況瞭如指掌。

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。