springboot中使用actuator進行監控

weixin_33727510發表於2017-06-15

本文springboot版本：1.5.4.RELEASE
如果使用springboot2.x，請參考springboot2.x-actuator

spring-boot-actuator模組提供了一個監控和管理生產環境的模組，可以使用http、jmx、ssh、telnet等來管理和監控應用。審計（Auditing）、健康（health）、資料採集（metrics gathering）會自動加入到應用裡面。

新增依賴

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

可以在你的application.yml配置檔案配置：

##執行狀態 actuator監控
endpoints:
  enabled: true
  info:
    sensitive: false
  health:
    sensitive: false
management:
  ##服務路徑
  context-path: /
  ##服務埠
  port: 8081

如果你使用application.properties，可以做類似的配置：

endpoints.enabled=true
endpoints.info.sensitive=false
endpoints.health.sensitive=false
management.context-path=/
management.port=8081

啟動後可以看到以下日誌：

2017-03-15 15:50:58.775  INFO 9544 --- [           main] s.w.s.m.m.a.RequestMappingHandlerAdapter : Detected ResponseBodyAdvice bean in org.springframework.boot.actuate.autoconfigure.EndpointWebMvcHypermediaManagementContextConfiguration$ActuatorEndpointLinksAdvice
2017-03-15 15:50:58.956  INFO 9544 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/dump || /dump.json],methods=[GET],produces=[application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter.invoke()
2017-03-15 15:50:58.957  INFO 9544 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/configprops || /configprops.json],methods=[GET],produces=[application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter.invoke()
2017-03-15 15:50:58.958  INFO 9544 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/metrics/{name:.*}],methods=[GET],produces=[application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.MetricsMvcEndpoint.value(java.lang.String)
2017-03-15 15:50:58.958  INFO 9544 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/metrics || /metrics.json],methods=[GET],produces=[application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter.invoke()
2017-03-15 15:50:58.959  INFO 9544 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/health || /health.json],produces=[application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.HealthMvcEndpoint.invoke(java.security.Principal)
2017-03-15 15:50:58.960  INFO 9544 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/autoconfig || /autoconfig.json],methods=[GET],produces=[application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter.invoke()
2017-03-15 15:50:58.960  INFO 9544 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/mappings || /mappings.json],methods=[GET],produces=[application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter.invoke()
2017-03-15 15:50:58.961  INFO 9544 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/beans || /beans.json],methods=[GET],produces=[application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter.invoke()
2017-03-15 15:50:58.963  INFO 9544 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/heapdump || /heapdump.json],methods=[GET],produces=[application/octet-stream]}" onto public void org.springframework.boot.actuate.endpoint.mvc.HeapdumpMvcEndpoint.invoke(boolean,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse) throws java.io.IOException,javax.servlet.ServletException
2017-03-15 15:50:58.964  INFO 9544 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/actuator || /actuator.json],produces=[application/json]}" onto public org.springframework.hateoas.ResourceSupport org.springframework.boot.actuate.endpoint.mvc.HalJsonMvcEndpoint.links()
2017-03-15 15:50:58.965  INFO 9544 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/info || /info.json],methods=[GET],produces=[application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter.invoke()
2017-03-15 15:50:58.973  INFO 9544 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/env/{name:.*}],methods=[GET],produces=[application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.EnvironmentMvcEndpoint.value(java.lang.String)
2017-03-15 15:50:58.973  INFO 9544 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/env || /env.json],methods=[GET],produces=[application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter.invoke()
2017-03-15 15:50:58.974  INFO 9544 --- [           main] o.s.b.a.e.mvc.EndpointHandlerMapping     : Mapped "{[/trace || /trace.json],methods=[GET],produces=[application/json]}" onto public java.lang.Object org.springframework.boot.actuate.endpoint.mvc.EndpointMvcAdapter.invoke()

介面

介面	描述	敏感
actuator	列出所有可用介面	true
autoconfig	顯示一個auto-configuration的報告，該報告展示所有auto-configuration候選者及它們被應用或未被應用的原因	true
beans	顯示一個應用中所有Spring Beans的完整列表	true
configprops	顯示一個所有@ConfigurationProperties的整理列表	true
dump	顯示當前應用執行緒狀態資訊	true
env	顯示Spring的ConfigurableEnvironment屬性	true
health	展示應用的健康資訊（當使用一個未認證連線訪問時顯示一個簡單的’status’，使用認證連線訪問則顯示全部資訊詳情）	false
info	顯示應用資訊	false
metrics	展示當前應用的’指標’資訊	true
mappings	顯示一個所有@RequestMapping路徑的整理列表	true
shutdown	允許應用以優雅的方式關閉（預設情況下不啟用）	true
trace	顯示trace資訊（預設情況下是最後100個HTTP請求）	true
loggers	提供顯示和修改應用程式中loggers配置的功能	true

測試幾個介面

/health

訪問http://127.0.0.1:8081/health 可以看到

{
    "status":"UP",
    "hello":{
        "status":"UP"
    },
    "diskSpace":{
        "status":"UP",
        "total":116333809664,
        "free":86622515200,
        "threshold":10485760
    },
    "db":{
        "status":"UP",
        "database":"Oracle",
        "hello":"Hello"
    }
}

自動配置的HealthIndicators

下面的HealthIndicators會被Spring Boot自動配置（在合適的時候）：

名字	描述
CassandraHealthIndicator	檢查Cassandra database是否正常
DiskSpaceHealthIndicator	低磁碟空間檢測
DataSourceHealthIndicator	檢查資料庫連線是否正常
ElasticsearchHealthIndicator	檢查Elasticsearch cluster是否正常
JmsHealthIndicator	檢查JMS broker是否正常
MailHealthIndicator	檢查mail server是否正常
MongoHealthIndicator	檢查Mongo database是否正常
RabbitHealthIndicator	檢查Rabbit server是否正常
RedisHealthIndicator	檢查Redis server是否正常
SolrHealthIndicator	檢查Solr server是否正常

編寫自定義HealthIndicators

想提供自定義健康資訊，你可以註冊實現了HealthIndicator介面的Spring beans。你需要提供一個health()方法的實現，並返回一個Health響應。Health響應需要包含一個status和可選的用於展示的詳情。比如上面/health介面中的hello就是再下面定義的

@Component
public class HelloHealthIndicator implements HealthIndicator {
    @Override
    public Health health() {
        int errorCode = check(); // perform some specific health check
        if (errorCode != 0) {
            return Health.down().withDetail("Error Code", errorCode)  .build();
        }
        return Health.up().build();
    }

    int check(){
        return 0;
    }
}

/metrics

{
    "counter.status.200.root": 20,
    "counter.status.200.metrics": 3,
    "counter.status.200.star-star": 5,
    "counter.status.401.root": 4,
    "gauge.response.star-star": 6,
    "gauge.response.root": 2,
    "gauge.response.metrics": 3,
    "classes": 5808,
    "classes.loaded": 5808,
    "classes.unloaded": 0,
    "heap": 3728384,
    "heap.committed": 986624,
    "heap.init": 262144,
    "heap.used": 52765,
    "nonheap": 0,
    "nonheap.committed": 77568,
    "nonheap.init": 2496,
    "nonheap.used": 75826,
    "mem": 986624,
    "mem.free": 933858,
    "processors": 8,
    "threads": 15,
    "threads.daemon": 11,
    "threads.peak": 15,
    "threads.totalStarted": 42,
    "uptime": 494836,
    "instance.uptime": 489782,
    "datasource.primary.active": 5,
    "datasource.primary.usage": 0.25
}

此處我們可以看到基本的 memory ， heap ， class loading ， processor 和 thread pool 資訊，連同一些HTTP指標，還可以使用 / /{name:.} 訪問單個屬性。在該例項中， root ('/')， /metrics URLs分別返回20次，3次 HTTP 200 響應。同時可以看到 root URL返回了4次 HTTP 401 （unauthorized）響應。雙asterix（star-star）來自於被Spring MVC /* 匹配到的一個請求（通常為一個靜態資源）。
gauge 級別展示了一個請求的最後響應時間。所以， root 的最後請求被響應耗時2毫秒， /metrics 耗時3毫秒。

Spring Boot提供以下系統指標：
系統記憶體總量（mem），單位:Kb
空閒記憶體數量（mem.free），單位:Kb
處理器數量（processors）
系統正常執行時間（uptime），單位:毫秒
應用上下文（就是一個應用例項）正常執行時間（instance.uptime），單位:毫秒
系統平均負載（systemload.average）
堆資訊（heap，heap.committed，heap.init，heap.used），單位:Kb
執行緒資訊（threads，thread.peak，thead.daemon）
類載入資訊（classes，classes.loaded，classes.unloaded）
垃圾收集資訊（gc.xxx.count, gc.xxx.time）

還會為你應用中定義的支援的DataSource提供以下指標：
最大連線數（datasource.xxx.max）
最小連線數（datasource.xxx.min）
活動連線數（datasource.xxx.active）
連線池的使用情況（ .xxx.usage）

所有的資料來源指標共用 datasoure. 字首。該字首對每個資料來源都非常合適：
如果是主資料來源（唯一可用的資料來源或存在的資料來源中被@Primary標記的）字首為datasource.primary
如果資料來源bean名稱以dataSource結尾，那字首就是bean的名稱去掉dataSource的部分（例如，batchDataSource的前
綴是datasource.batch）
其他情況使用bean的名稱作為字首

記錄自己的指標

想要記錄你自己的指標，只需將CounterService或GaugeService注入到你的bean中。CounterService提供increment：將指定的計數器增加1。，decrement：將指定的計數器減1。和reset：復位指定的計數器。方法；GaugeService提供一個submit方法。

@Service
public class UserService {
    @Autowired
    UserMapper mapper;

    @Autowired
    CounterService counterService;

    @Autowired
    GaugeService gaugeService;

    public Map<Object, Object> findById(String id) {
        this.counterService.increment("services.system.userService.findById.invoked");
        gaugeService.submit("a", 1.0);
        return mapper.findById(id);
    }
}

/trace

訪問http://127.0.0.1:8081/trace

[
    {
        "timestamp":1489568887768,
        "info":{
            "method":"GET",
            "path":"/",
            "headers":{
                "request":{
                    "host":"127.0.0.1:8080",
                    "connection":"keep-alive",
                    "accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8",
                    "upgrade-insecure-requests":"1",
                    "user-agent":"Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/49.0.2623.22 Safari/537.36 SE 2.X MetaSr 1.0",
                    "accept-encoding":"gzip, deflate, sdch",
                    "accept-language":"zh-CN,zh;q=0.8"
                },
                "response":{
                    "X-Application-Context":"youyu:localdev:8080",
                    "status":"404"
                }
            }
        }
    },
    {
        "timestamp":1489568886967,
        "info":{
            "method":"GET",
            "path":"/",
            "headers":{
                "request":{
                    "host":"127.0.0.1:8080",
                    "connection":"keep-alive",
                    "accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8",
                    "upgrade-insecure-requests":"1",
                    "user-agent":"Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/49.0.2623.22 Safari/537.36 SE 2.X MetaSr 1.0",
                    "accept-encoding":"gzip, deflate, sdch",
                    "accept-language":"zh-CN,zh;q=0.8"
                },
                "response":{
                    "X-Application-Context":"youyu:localdev:8080",
                    "status":"404"
                }
            }
        }
    }
]

/loggers

訪問http://127.0.0.1:8081/loggers返回：

{
    "levels":[
        "OFF",
        "ERROR",
        "WARN",
        "INFO",
        "DEBUG",
        "TRACE"
    ],
    "loggers":{
        "ROOT":{
            "configuredLevel":"INFO",
            "effectiveLevel":"INFO"
        },
        "com":{
            "configuredLevel":null,
            "effectiveLevel":"INFO"
        },
        "com.caiyi":{
            "configuredLevel":null,
            "effectiveLevel":"INFO"
        }
        ...
    }
}

可以通過post請求http://127.0.0.1:8081/loggers/{elephant}修改不同包下的日誌級別。
舉個例子：訪問

http:127.0.0.1:8081/manage/loggers/com.caiyi

請求body中傳引數：

{
    "configuredLevel": "debug"
}

就能修改com.caiyi下面的日誌級別為debug，用get請求一下http://127.0.0.1:8081/manage/loggers/com.caiyi
可看到修改成功了：

{
    "configuredLevel": "DEBUG",
    "effectiveLevel": "DEBUG"
}

SpringBoot整合Actuator進行健康監控
2020-08-22
Spring Boot
使用SpringBoot Actuator監控應用
2018-05-16
Spring Boot
springboot之actuator監控
2017-12-14
Spring Boot
SpringBoot Actuator — 埋點和監控
2021-11-14
Spring Boot
SpringBoot如何利用Actuator來監控應用？
2020-12-13
Spring Boot
SpringBoot第二十二篇：應用監控之Actuator
2019-07-23
Spring Boot
Spring Boot (十九)：使用 Spring Boot Actuator 監控應用
2018-02-06
Spring Boot
【Zabbix】如何使用Zabbix進行IPMI監控？
2018-11-14
使用Ganglia對hadoop進行監控
2014-03-28
Hadoop
springboot中加入druid對sql進行監控
2018-08-18
Spring BootUISQL
SpringBoot使用prometheus監控
2019-03-17
Spring BootPrometheus
Zabbix監控使用進階
2020-12-07
SpringBoot使用SOFA-Lookout監控
2019-03-17
Spring Boot
想在 KubeSphere 中進行自定義監控？來瞧瞧這
2021-12-07
使用 iotop 監控哪些程式在進行I/O操作
2020-12-05
centos7使用ntopng進行流量監控和分析
2020-11-30
CentOS
使用aop來監控方法進行增強處理
2020-10-10
在fedora中使用MRTG進行系統監控（zt）
2007-07-06
使用AUDIT_SYSLOG_LEVEL進行Sys使用者行為監控
2012-07-02
對table的操作進行監控
2007-12-14
SpringBoot：定製 Actuator
2021-03-25
Spring Boot
如何使用表格儲存控制檯進行資料監控
2018-05-18
一種對雲主機進行效能監控的監控系統及其監控方法
2018-07-30
使用 Sentry 對應用進行監控，少 bug 少加班
2021-10-19
如何進行網站的真實使用者監控(RUM)？怎麼進入監控網站
2020-11-30
網站
Linux下使用pv監控進度
2018-02-23
Linux
使用 Skywalking 對 Kubernetes（K8s）中的微服務進行監控
2021-12-05
K8S微服務
使用Prometheus和Grafana進行系統監控和預測 - flightaware
2020-08-12
PrometheusGrafana
分散式監控系統Zabbix--使用Grafana進行圖形展示
2017-07-02
分散式Grafana
如何有效使用Project（2）——進度計劃的執行與監控
2014-04-06
Project
jfinal中如何使用過濾器監控Druid監聽SQL執行？
2022-06-29
過濾器UISQL
SpringBoot 監控、專案部署
2022-01-06
Spring Boot
遠端監控Springboot JVM
2018-12-15
Spring BootJVM
進行Linux效能監控的命令介紹
2023-11-09
Linux
使用Flink SQL進行實時效能監控：AdTech廣告用例
2020-12-08
SQL
監控批量操作進度
2011-10-12
【譯】Google - 使用 webpack 進行 web 效能優化（三）：監控和分析應用
2018-09-17
GoWeb優化
使用Shell指令碼對Linux系統和程式資源進行監控
2013-04-18
指令碼Linux