Springboot Actuator之一:執行器Actuator入門介紹


介紹

Spring Boot有四大神器,分別是auto-configuration、starters、cli、actuator,本文主要講actuator。actuator是spring boot提供的對應用系統的自省和監控的集成功能,可以對應用系統進行配置查看、相關功能統計等。

如何使用

在pom文件中添加spring-boot-starter-actuator依賴

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

啟動應用,日志里會打印actuator相關信息如下,

沒有spring-boot-starter-actuator依賴之前如下,

Actuator功能點說明

Spring Boot Actuator的關鍵特性是在應用程序里提供眾多Web端點,通過它們了解應用程序 運行時的內部狀況。有了Actuator,你可以知道Bean在Spring應用程序上下文里是如何組裝在一 起的,掌握應用程序可以獲取的環境屬性信息,獲取運行時度量信息的快照…… Actuator提供了13個端點,具體如表7-1所示。 

/info端點顯示應用程序的基本描述

/info,這個endpoint顯示應用程序的基本描述,在之前的實踐例子中我們看過它的返回信息,屬性值來自appliaction.properties,同時也可以使用占位符獲取pom.xml文件中的信息。任何以info.開頭的屬性都會在訪問http://localhost:8080/info時顯示。

例如/info:首先在application.properties文件中添加對應的屬性值,符號@包圍的屬性值來自pom.xml文件中的元素節點。

info.build.artifact=@project.artifactId@
info.build.name=@project.name@
info.build.description=@project.description@
info.build.version=@project.version@

要獲取配置文件中的節點值,需要在pom文件中進行一定的配置,首先在<build>節點里面添加:

<resources>
 <resource>
    <directory>src/main/resources</directory>
    <filtering>true</filtering>
 </resource>
</resources>

然后在<plugins>節點里面增加對應的插件:

<plugin>
 <groupId>org.apache.maven.plugins</groupId>
 <artifactId>maven-resources-plugin</artifactId>
 <version>2.6</version>
 <configuration>
    <delimiters>
       <delimiter>@</delimiter>
    </delimiters>
    <useDefaultDelimiters>false</useDefaultDelimiters>
 </configuration>
</plugin>

然后運行應用程序,訪問http://localhost:8080/info,可以看到下列信息

  • /env提供應用程序的環境變量,如果你在調試時想知道某個配置項在運行時的值,可以通過這個endpoint訪問——訪問http://localhost:8080/env,可以看到很多方面的配置,例如,class path resources—[tomcat.https.properties]、applicationConfig—[classpath:/application.properties]、commonsConfig、systemEnvironment、systemProperties等。
    這些變量的值由Environment實例中的PropertySource實例保存,根據這些屬性值所在的層次,有可能在運行時已經做了值替換,跟配置文件中的不一樣了。為了確認某個屬性的具體值,例如book.count.rate屬性,可以訪問http://localhost:8080/env/book.counter.rate來查詢,如果跟配置文件中的不一樣,則可能是被系統變量或者命令行參數覆蓋了。EnvironmentEndpoint類負責實現上述功能,有興趣可以再看看它的源碼;
  • /configprops提供不同配置對象,例如WebConfiguration.TomcatSslConnectionProperties,它與/env不同的地方在於它會表示出與配置項綁定的對象。嘗試下訪問http://localhost:8080/configprops,然后在網頁中查詢custom.tomcat.https,可以看到我們之前用於配置TomcatSslConnector對象的屬性值(參見:讓你的Spring Boot工程支持HTTP和HTTPS)。

    TomcatSslConnector對應的屬性值
  • /autoconfig以web形式對外暴露AutoConfiguration 信息,這些信息的解釋可以參考Spring Boot:定制自己的starter一文,這樣我們就不需要通過“修改應用程序的日志級別和查看應用的啟動信息”來查看應用的自動配置情況了。
  • /beans,這個endpoint列出所有由Spring Boot創建的bean。

    /beans顯示所有Spring Boot創建的bean
  • /mappings,這個endpoint顯示當前應用支持的URL映射,該映射關系由HandlerMapping類維護,通過這個endpoint可以查詢某個URL的路由信息。

    /mappings查看URL映射

 

  • /health提供應用程序的健康狀態,或者是某個核心模塊的健康狀態

/health端點所提供的所有信息都是由一個或多個健康指示器提供的。表7-3列出了Spring Boot 自帶的健康指示器:

 

  • /metrics,這個endpoint查看應用程序的度量值

下表 /metrics端點報告的度量值和計數器,

/metrics端點會返回所有的可用度量值,但你也可能只對某個值感興趣。要獲取單個值,請 求時可以在URL后加上對應的鍵名。例如,要查看空閑內存大小,可以向/metrics/mem.free發一 個GET請求:

垃圾收集器

 

http

counter.status后的值是HTTP狀態碼,隨后是所請 求的路徑。舉個例子,counter.status.200.metrics表明/metrics端點返回200(OK)狀態碼 的次數。 HTTP的度量信息在結構上也差不多,卻在報告另一類信息。它們全部以gauge.response開頭, 表明這是HTTP響應的度量信息。前綴后是對應的路徑。度量值是以毫秒為單位的時間,反映了 近處理該路徑請求的耗時。舉個例子,代碼清單7-6里的gauge.response.beans說明上一次 請求耗時169毫秒。 這里還有幾個特殊的值需要注意。root路徑指向的是根路徑或/。

star-star代表了那些Spring 認為是靜態資源的路徑,包括圖片、JavaScript和樣式表,其中還包含了那些找不到的資源。這就 是為什么你經常會看到counter.status.404.star-star,這是返回了HTTP 404 (NOT FOUND) 狀態的請求數。 

 

/trace追蹤Web請求

/trace端點能報告所有Web請求的詳細信息,包括請求方法、路徑、時間戳以及請求和響應的 頭信息。代碼清單7-7是/trace輸出的一個片段,其中包含了整個請求跟蹤項。 

正如method和path屬性所示,你可以看到這個跟蹤項是一個針對/metrics的請求。 timestamp屬性(以及響應中的Date頭)告訴了你請求的處理時間。headers屬性的內容是請 求和響應中所攜帶的頭信息。 雖然代碼清單7-7里只顯示了一條跟蹤項,但/trace端點實際能顯示近100個請求的信息,包 含對/trace自己的請求。它在內存里維護了一個跟蹤庫。稍后在7.4.4節里,你會看到如何創建一 個自定義的跟蹤庫實現,以便將請求的跟蹤持久化。 

/dump導出線程活動

/dump端點會生成當前線程活動的快照。完整的線程導出報告里會包含應用程序的每個線程。為了節省空間,下面只放了 一個線程的內容片段。如你所見,其中包含很多線程的特定信息,還有線程相關的阻塞和鎖狀態。 本例中,還有一個跟蹤棧(stack trace),表明這是一個Tomcat容器線程。 

/shutdown端點關閉應用程序

為了關閉應用程序,你要往/shutdown發送一個POST請求。很顯然,關閉運行中的應用程序是件危險的事情,因此這個端點默認是關閉的。要開啟該端點,可以將endpoints.shutdown.enabled設置為true。舉例來說,可以把如 下內容加入application.yml,借此開啟/shutdown端點: 

endpoints.shutdown.enabled=true

GET請求提示不支持,如下圖:

用fiddler模擬一個POST請求,可以成功關閉應用,如下圖: 

 

上述各個endpoint是Spring Boot Actuator提供的接口和方法,接下來看看我們自己定制的HealthIndicator,我們只需要實現HealthIndicator接口,Spring Boot會收集該接口的實現,並加入到/health這個endpoint中。

在我們的例子中,我們為每個CrudRepository實例都創建了一個HealthIndicator實例,為此我們創建了一個CompositeHealthIndicator實例,由這個實例管理所有的DbHealthIndicator實例。作為一個composite,它會提供一個內部的層次關系,從而可以返回JSON格式的數據。

代碼中的HealthAggregator實例的作用是:它維護一個map,告訴CompositeHealthIndicator如何決定所有HealthIndicator代表的整體的狀態。例如,除了一個repository返回DOWN其他的都返回UP,這時候這個composite indicator作為一個整體應該返回UP還是DOWN,HealthAggregator實例的作用就在這里。

Spring Boot使用的默認的HealthAggregator實現是OrderedHealthAggregator,它的策略是手機所有的內部狀態,然后選出在DOWN、OUT_OF_SERVICE、UP和UNKNOWN中間具有最低優先級的那個狀態。這里使用策略設計模式,因此具體的狀態判定策略可以改變和定制,例如我們可以創建定制的HealthAggregator

最后需要考慮下安全問題,通過這些endpoints暴露出很多應用的信息,當然,Spring Boot也提供了配置項,可以關閉指定的endpoint——在application.properties中配置<name>.enable=false

還可以通過設置management.port=-1關閉endpoint的HTTP訪問接口,或者是設置其他的端口,供內部的admin服務訪問;除了控制端口,還可以設置僅僅讓本地訪問,只需要設置management.address=127.0.0.1;通過設置management.context-path=/admin,可以設置指定的根路徑。綜合下,經過上述設置,在本地訪問http://127.0.0.1/admin/health來訪問健康狀態。

可以在防火牆上屏蔽掉不是/admin/*的endpoints訪問請求,更進一步,利用Spring Security可以配置驗證信息,這樣要訪問當前應用的endpoints必須使用用戶名和密碼登陸。

二、連接Actuator的遠程 shell

Actuator通過REST端點提供了不少非常有用的信息。另一個深入運行中應用程序內部的方式 是使用遠程shell。Spring Boot集成了CRaSH,一種能嵌入任意Java應用程序的shell。Spring Boot 還擴展了CRaSH,添加了不少Spring Boot特有的命令,提供了與Actuator端點類似的功能。 要使用遠程shell,只需加入遠程shell的起步依賴即可。你需要這樣的Gradle依賴:

compile("org.springframework.boot:spring-boot-starter-remote-shell") 

如果用Maven構建項目,你需要在pom.xml文件里添加如下依賴: 

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

添加了遠程shell依賴后,就可以構建並運行應用程序了。在啟動的時候,可以看到要寫進日 志的一行密碼。這行密碼所在的行大概是這樣的: 

Using default password for shell access: c59b152d-f7e2-41de-86f1-6c3e9e38229b

現在你可以通過SSH工具連接shell了,它監聽的端口號是2000。如果你用的是Unix的ssh命 令,那么它看起來大概是這樣的: 

賬號密碼分別是user/c59b152d-f7e2-41de-86f1-6c3e9e38229b

登陸成功后,顯示如下:

遠程shell提供了24個可以在運行應用程序上下文中執行的命令,其中大部分都是CRaSH自帶 的。但Spring Boot也添加了一些。表7-4列出了這些Spring Boot特有的命令。 

 

例如用autoconfig生成了一個與Actuatord的/autoconfig端點類似的報告。

 

metrics

三、通過JMX監控應用程序 

除了REST端點和遠程shell,Actuator還把它的端點以MBean的方式發布了出來,可以通過 JMX來查看和管理。使用JMX是管理Spring Boot應用程序的一個好方法,如果你已在用JMX管理 應用程序中的其他MBean,則尤其如此。 

Actuator的端點都發布在org.springframework.boot域下。比如,你想要查看應用程序的請求映 射關系,那么可以看一下圖7-6(通過JConsole查看請求映射端點)。 

連接成功后,

如你所見,在requestMappingEndpoint下可以找到請求映射端點,位於org.spring- framework.boot域中的Endpoint下。Data屬性中包含了該端點所要輸出的JSON內容。 和其他MBean一樣,端點MBean有可供調用的操作。大部分端點MBean只有訪問操作,返回 其中的某個屬性,但/shutdown端點提供了一些有趣(同時具有毀滅性)的操作,如下圖所示,點擊shutdown的方框,應用就停止了。

 

 


參考:http://www.jianshu.com/p/734519d3c383
 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM