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>
Actuator 的 REST 接⼝
- 应⽤配置类,可以查看应⽤在运⾏期的静态信息,例如⾃动配置信息、加载的 springbean 信息、yml ⽂ 件配置信息、环境信息、请求映射信息;
- 度量指标类,主要是运⾏期的动态信息,如堆栈、请求连、⼀些健康指标、metrics 信息等;
- 操作控制类,主要是指 shutdown,⽤户可以发送⼀个请求将应⽤的监控功能关闭。
HTTP ⽅方法 |
路路径 |
描述 |
GET | /auditevents | 显示应⽤用暴暴露露的审计事件(如认证进⼊入、订单失败) |
GET | /beans | 描述应⽤用程序上下⽂文⾥里里全部的 Bean 以及它们的关系 |
GET |
/conditions | 就是 1.0 的 /autoconfig,提供⼀一份⾃自动配置⽣生效的条件情况,记录哪些 ⾃自动配置条件通过了了,哪些没通过 |
GET | /configprops | 描述配置属性(包含默认值)如何注⼊入 Bean |
GET | /env | 获取全部环境属性 |
GET | /env/{name} | 根据名称获取特定的环境属性值 |
GET | /flyway | 提供⼀一份 Flyway 数据库迁移信息 |
GET | /liquidbase | 显示 Liquibase 数据库迁移的纤细信息 |
GET | /health | 报告应⽤用程序的健康指标,这些值由 HealthIndicator 的实现类提供 |
GET | /heapdump | dump ⼀一份应⽤用的 JVM 堆信息 |
GET | /httptrace | 显示 HTTP ⾜足迹,最近 100 个 HTTP request/repsponse |
GET | /info | 获取应⽤用程序的定制信息,这些信息由 info 打头的属性提供 |
GET | /logfile | 返回 log file 中的内容(如果 logging.file 或者 logging.path 被设置) |
GET | /loggers | 显示和修改配置的 loggers |
GET | /metrics | 报告各种应⽤用程序度量量信息,⽐比如内存⽤用量量和 HTTP 请求计数 |
GET | /metrics/{name} | 报告指定名称的应⽤用程序度量量值 |
GET | /scheduledtasks | 展示应⽤用中的定时任务信息 |
GET | /sessions | 如果我们使⽤用了了 Spring Session 展示应⽤用中的 HTTP Sessions 信息 |
POST | /shutdown | 关闭应⽤用程序,要求 endpoints.shutdown.enabled 设置为 true |
GET |
/mappings | 描述全部的 URI 路路径,以及它们和控制器器(包含 Actuator 端点)的映射关系 |
GET | /threaddump | 获取线程活动的快照 |
命令详解
management.endpoints.web.exposure.include=*
management.endpoints.web.exposure.exclude=beans,trace
management.endpoints.web.base-path=/manage
health
{
"status" : "UP"
}
- 设置状态码顺序为 setStatusOrder(Status.DOWN, Status.OUTOFSERVICE, Status.UP, Status.UNKNOWN);
- 过滤掉不能识别的状态码
- 如果⽆任何状态码,整个 Spring Boot 应⽤的状态是 UNKNOWN
- 将所有收集到的状态码按照 1 中的顺序排序
- 返回有序状态码序列中的第⼀个状态码,作为整个 Spring Boot 应⽤的状态
management.health.redise.enabled=false
详细的健康检查信息
management.endpoint.health.show-details=always
"status": "UP",
"diskSpace": {
"status": "UP",
"total": 209715195904,
"free": 183253909504,
"threshold": 10485760
}
}
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
[
{
"context": "application:8080:management",
"parent": "application:8080",
"beans": [
{
"bean": "embeddedServletContainerFactory",
"aliases": [
],
"scope": "singleton",
"type": "org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedSe
rvletContainerFactory",
"resource": "null",
"dependencies": [
]
},
{
"bean": "endpointWebMvcChildContextConfiguration",
"aliases": [
],
"scope": "singleton",
"type": "org.springframework.boot.actuate.autoconfigure.EndpointWebMvcChil
dContextConfiguration$$EnhancerBySpringCGLIB$$a4a10f9d",
"resource": "null",
"dependencies": [
]
}
}
]
conditions
{
"positiveMatches": {
"DevToolsDataSourceAutoConfiguration": {
"notMatched": [
{
"condition": "DevToolsDataSourceAutoConfiguration.DevToolsData
SourceCondition",
"message": "DevTools DataSource Condition did not find a singl
e DataSource bean"
}
],
"matched": [ ]
},
"RemoteDevToolsAutoConfiguration": {
"notMatched": [
{
"condition": "OnPropertyCondition",
"message": "@ConditionalOnProperty (spring.devtools.remote.sec
ret) did not find property 'secret'"
}
],
"matched": [
{
"condition": "OnClassCondition",
"message": "@ConditionalOnClass found required classes 'javax.
servlet.Filter', 'org.springframework.http.server.ServerHttpRequest'; @Conditional
OnMissingClass did not find unwanted class"
}
]
}
}
}
confifigprops
{
...
"environmentEndpoint": {
"prefix": "endpoints.env",
"properties": {
"id": "env",
"sensitive": true,
"enabled": true
}
},
"spring.http.multipart-org.springframework.boot.autoconfigure.web.MultipartPrope
rties": {
"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
{
"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/{name} ⽤法
heapdump
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,151496
1720,1515649377; Hm_lvt_6d8e8bb59814010152d98507a18ad229=1515247964,1515296008,151
5672972,1516086283; UM_distinctid=1647364371ef6-003ab9d0469ea5-b7a103e-100200-1647
364371f104; CNZZDATA1260945749=232252692-1513233181-%7C1537492730"
],
"accept-language": [
"zh-CN,zh;q=0.9"
],
GitChat
"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,ima
ge/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
{
"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
}
分类 | 前缀 | 报告内容 |
垃圾收集器器 |
gc.* | 已经发⽣生过的垃圾收集次数,以及垃圾收集所耗费的时间,适⽤用于标记—清理理垃圾收集器器和并⾏行行垃圾收集器器(数据源⾃自java.lang.management.GarbageCollectorMXBean) |
内存 |
mem.* | 分配给应⽤用程序的内存数量量和空闲的内存数量量(数据源⾃自 java.lang. Runtime) |
堆 | heap.* | 当前内存⽤用量量(数据源⾃自 java.lang.management.MemoryUsage) |
类加载器器 |
classes.* | JVM 类加载器器加载与卸载的类的数量量(数据源⾃自 java.lang. management.ClassLoadingMXBean) |
系统 | processors、instance.uptime、uptime、systemload.average |
系统信息,如处理理器器数量量(数据源⾃自 java.lang.Runtime、运⾏行行时间 (数据源⾃自 java.lang.management.RuntimeMXBean)、平均负载 (数据源⾃自 java.lang.management.OperatingSystemMXBean) |
线程池 |
thread.* | 线程、守护线程的数量量,以及 JVM 启动后的线程数量量峰值(数据源 ⾃ 自 java.lang .management.ThreadMXBean) |
数据源 |
datasource.* | 数据源连接的数量量(源⾃自数据源的元数据,仅当 Spring 应⽤用程序上下⽂文⾥里里存在 DataSource Bean 的时候才会有这个信息) |
Tomcat 会话 |
httpsessions.* | Tomcat 的活跃会话数和最⼤大会话数(数据源⾃自嵌⼊入式 Tomcat 的Bean,仅在使⽤用嵌⼊入式 Tomcat 服务器器运⾏行行应⽤用程序时才有这个信息) |
HTTP | counter.status._、gauge.response._ |
多种应⽤用程序服务 HTTP 请求的度量量值与计数器器 |
- 请注意,这⾥的⼀些度量值,⽐如数据源和 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 接⼝会返回所有的可⽤度量值,但你也可能只对某个值感兴趣。要获取单个值,请求时可以在GitChat URL 后加上对应的键名。例如,要查看空闲内存⼤⼩,可以向 /metrics/mem.free 发⼀个GET请求,⽐ 如访问⽹址 http://localhost:8080/actuator/metrics/mem.free,返回:{"mem.free":178123}。
shutdown
management.endpoint.shutdown.enabled=true
curl -X POST "http://localhost:8080/actuator/shutdown"
{
"message": "Shutting down, bye..."
}
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.l
ang.String, java.lang.Object>> org.springframework.boot.autoconfigure.web.BasicErr
orController.error(javax.servlet.http.HttpServletRequest)"
}
}
threaddump
{
"threadName": "http-nio-8088-exec-6",
"threadId": 49,
"blockedTime": -1,
"blockedCount": 0,
"waitedTime": -1,
"waitedCount": 2,
"lockName": "java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionOb
ject@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$Conditio
nObject",
"identityHashCode": 372286721
}
}
...
]