Springboot集成actuator实现JVM监控和请求追踪

发表于 | 分类于 ，

Springboot集成actuator实现JVM监控和请求追踪

一、简介

Actuator 是 Spring Boot 提供的对应用系统的自省和监控的集成功能，可以查看应用配置的详细信息，例如自动化配置信息、创建的 Spring beans 以及一些环境属性等。

Spring Boot 2.0中的端点和之前的版本有较大不同,使用时需注意。另外端点的监控机制也有很大不同，启用了不代表可以直接访问，还需要将其暴露出来，传统的management.security管理已被标记为不推荐。

为了保证 actuator 暴露的监控接口的安全性，需要添加安全控制的依赖spring-boot-start-security依赖，访问应用监控端点时，都需要输入验证信息。Security 依赖，可以选择不加，不进行安全管理，但不建议这么做。

官方文档

二、Actuator的REST接口

Actuator 监控分成两类：原生端点和用户自定义端点；自定义端点主要是指扩展性，用户可以根据自己的实际应用，定义一些比较关心的指标，在运行期进行监控。

原生端点是在应用程序里提供众多 Web 接口，通过它们了解应用程序运行时的内部状况。原生端点又可以分成三类：

应用配置类：可以查看应用在运行期的静态信息：例如自动配置信息、加载的 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 获取线程活动的快照

三、默认装配HealthIndicators

下列是依赖spring-boot-xxx-starter后相关HealthIndicator的实现（通过management.health.defaults.enabled属性可以禁用它们），但想要获取一些额外的信息时，自定义的作用就体现出来了…

名称 描述
CassandraHealthIndicator 检查Cassandra数据库是否启动。
DiskSpaceHealthIndicator 检查磁盘空间不足。
DataSourceHealthIndicator 检查是否可以获得连接DataSource。
ElasticsearchHealthIndicator 检查Elasticsearch集群是否启动。
InfluxDbHealthIndicator 检查InfluxDB服务器是否启动。
JmsHealthIndicator 检查JMS代理是否启动。
MailHealthIndicator 检查邮件服务器是否启动。
MongoHealthIndicator 检查Mongo数据库是否启动。
Neo4jHealthIndicator 检查Neo4j服务器是否启动。
RabbitHealthIndicator 检查Rabbit服务器是否启动。
RedisHealthIndicator 检查Redis服务器是否启动。
SolrHealthIndicator 检查Solr服务器是否已启动。

四、Springboot集成actuator

1、添加POM依赖

1
2
3
4
5
6
7
8
9
<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>

2、配置文件

1
2
3
4
5
6
# 健康监控
management:
  endpoints:
    web:
      exposure:
        include: ['httptrace', 'metrics']

3、系统监控

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
package cn.pconline.web;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * @Description 系统监控
 * @Author jie.zhao
 * @Date 2019/8/21 11:18
 */
@Controller
@RequestMapping("/admin")
public class MonitorController {

    /**
     * 跳转系统信息页面
     *
     * @return
     */
    @RequestMapping("/monitor/systemInfo.do")
    public String systemInfo() {
        return "admin/monitor/systemInfo";
    }

    /**
     * 跳转请求追踪页面
     *
     * @return
     */
    @RequestMapping("/monitor/httptrace.do")
    public String httptraceInfo() {
        return "admin/monitor/httptrace";
    }
}

4、页面显示

  • 系统监控
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
<%@page contentType="text/html; charset=UTF-8" session="false"
%>
<%@include file="/WEB-INF/jspf/import.jspf"
%>
<div class="pageContent">
    <div class="panelBar">
        <ul class="toolBar">
            <li><a class="icon" href="###" onclick="monitorInfo()" title="刷新"><span>点击刷新</span></a><span id="dataTime"></span>
            </li>
        </ul>
    </div>
    <table class="table" style="width: 100%" layoutH="75">
        <thead>
        <tr>
            <th>参数</th>
            <th>描述</th>
            <th>当前值</th>
        </tr>
        </thead>
        <tbody>
        <tr>
            <td>
                <a-tag color="green">system.cpu.count</a-tag>
            </td>
            <td>CPU 数量</td>
            <td><span id="system-cpu-count"></span> 核</td>
        </tr>
        <tr>
            <td>
                <a-tag color="green">system.cpu.usage</a-tag>
            </td>
            <td>系统 CPU 使用率</td>
            <td><span id="system-cpu-usage"></span> %</td>
        </tr>
        <tr>
            <td>
                <a-tag color="purple">process.start.time</a-tag>
            </td>
            <td>应用启动时间点</td>
            <td><span id="process-start-time"></span></td>
        </tr>
        <tr>
            <td>
                <a-tag color="purple">process.uptime</a-tag>
            </td>
            <td>应用已运行时间</td>
            <td><span id="process-uptime"></span> 秒</td>
        </tr>
        <tr>
            <td>
                <a-tag color="purple">process.cpu.usage</a-tag>
            </td>
            <td>当前应用 CPU 使用率</td>
            <td><span id="process-cpu-usage"></span> %</td>
        </tr>
        <tr>
            <td>
                <a-tag color="purple">jvm.memory.max</a-tag>
            </td>
            <td>JVM 最大内存</td>
            <td><span id="jvm-memory-max"></span> MB</td>
        </tr>
        <tr>
            <td>
                <a-tag color="purple">jvm.memory.committed</a-tag>
            </td>
            <td>JVM 可用内存</td>
            <td><span id="jvm-memory-committed"></span> MB</td>
        </tr>
        <tr>
            <td>
                <a-tag color="purple">jvm.memory.used</a-tag>
            </td>
            <td>JVM 已用内存</td>
            <td><span id="jvm-memory-used"></span> MB</td>
        </tr>
        <tr>
            <td>
                <a-tag color="cyan">jvm.buffer.memory.used</a-tag>
            </td>
            <td>JVM 缓冲区已用内存</td>
            <td><span id="jvm-buffer-memory-used"></span> MB</td>
        </tr>
        <tr>
            <td>
                <a-tag color="cyan">jvm.buffer.count</a-tag>
            </td>
            <td>当前缓冲区数量</td>
            <td><span id="jvm-buffer-count"></span> 个</td>
        </tr>
        <tr>
            <td>
                <a-tag color="green">jvm.threads.daemon</a-tag>
            </td>
            <td>JVM 守护线程数量</td>
            <td><span id="jvm-threads-daemon"></span> 个</td>
        </tr>
        <tr>
            <td>
                <a-tag color="green">jvm.threads.live</a-tag>
            </td>
            <td>JVM 当前活跃线程数量</td>
            <td><span id="jvm-threads-live"></span> 个</td>
        </tr>
        <tr>
            <td>
                <a-tag color="green">jvm.threads.peak</a-tag>
            </td>
            <td>JVM 峰值线程数量</td>
            <td><span id="jvm-threads-peak"></span> 个</td>
        </tr>
        <tr>
            <td>
                <a-tag color="orange">jvm.classes.loaded</a-tag>
            </td>
            <td>JVM 已加载 Class 数量</td>
            <td><span id="jvm-classes-loaded"></span> 个</td>
        </tr>
        <tr>
            <td>
                <a-tag color="orange">jvm.classes.unloaded</a-tag>
            </td>
            <td>JVM 未加载 Class 数量</td>
            <td><span id="jvm-classes-unloaded"></span> 个</td>
        </tr>
        <tr>
            <td>
                <a-tag color="pink">jvm.gc.memory.allocated</a-tag>
            </td>
            <td>GC 时, 年轻代分配的内存空间</td>
            <td><span id="jvm-gc-memory-allocated"></span> MB</td>
        </tr>
        <tr>
            <td>
                <a-tag color="pink">jvm.gc.memory.promoted</a-tag>
            </td>
            <td>GC 时, 老年代分配的内存空间</td>
            <td><span id="jvm-gc-memory-promoted"></span> MB</td>
        </tr>
        <tr>
            <td>
                <a-tag color="pink">jvm.gc.max.data.size</a-tag>
            </td>
            <td>GC 时, 老年代的最大内存空间</td>
            <td><span id="jvm-gc-max-data-size"></span> MB</td>
        </tr>
        <tr>
            <td>
                <a-tag color="pink">jvm.gc.live.data.size</a-tag>
            </td>
            <td>FullGC 时, 老年代的内存空间</td>
            <td><span id="jvm-gc-live-data-size"></span> MB</td>
        </tr>
        <tr>
            <td>
                <a-tag color="blue">jvm.gc.pause.count</a-tag>
            </td>
            <td>系统启动以来GC 次数</td>
            <td><span id="jvm-gc-pause-count"></span> 次</td>
        </tr>
        <tr>
            <td>
                <a-tag color="blue">jvm.gc.pause.totalTime</a-tag>
            </td>
            <td>系统启动以来GC 总耗时</td>
            <td><span id="jvm-gc-pause-total-time"></span> 秒</td>
        </tr>
        </tbody>
    </table>
</div>

<script type="application/javascript">
    $(function () {
        monitorInfo();
    });

    /**
     * 监控信息
     */
    function monitorInfo() {
        $("#dataTime").html("<span style='color:blue;'>数据获取时间  "+dateMoment(new Date())+"</span>");
        //服务器相关
        ajaxGetTodo("${ctx}/actuator/metrics/system.cpu.count", function (data) {
            $("#system-cpu-count").html("<span>" + data.measurements[0].value + "</span>")
        });
        ajaxGetTodo("${ctx}/actuator/metrics/system.cpu.usage", function (data) {
            $("#system-cpu-usage").html("<span>" + sysConvert(data.measurements[0].value) + "</span>")
        });
        ajaxGetTodo("${ctx}/actuator/metrics/process.uptime", function (data) {
            $("#process-uptime").html("<span>" + data.measurements[0].value + "</span>")
        });
        ajaxGetTodo("${ctx}/actuator/metrics/process.start.time", function (data) {
            $("#process-start-time").html("<span>" + dateMoment(data.measurements[0].value * 1000) + "</span>")
        });
        ajaxGetTodo("${ctx}/actuator/metrics/process.cpu.usage", function (data) {
            $("#process-cpu-usage").html("<span>" + sysConvert(data.measurements[0].value) + "</span>")
        });
        //JVM相关
        ajaxGetTodo("${ctx}/actuator/metrics/jvm.memory.max", function (data) {
            $("#jvm-memory-max").html("<span>" + jvmConvert(data.measurements[0].value) + "</span>")
        });
        ajaxGetTodo("${ctx}/actuator/metrics/jvm.memory.committed", function (data) {
            $("#jvm-memory-committed").html("<span>" + jvmConvert(data.measurements[0].value) + "</span>")
        });
        ajaxGetTodo("${ctx}/actuator/metrics/jvm.memory.used", function (data) {
            $("#jvm-memory-used").html("<span>" + jvmConvert(data.measurements[0].value) + "</span>")
        });
        ajaxGetTodo("${ctx}/actuator/metrics/jvm.buffer.memory.used", function (data) {
            $("#jvm-buffer-memory-used").html("<span>" + jvmConvert(data.measurements[0].value) + "</span>")
        });
        ajaxGetTodo("${ctx}/actuator/metrics/jvm.buffer.count", function (data) {
            $("#jvm-buffer-count").html("<span>" + data.measurements[0].value + "</span>")
        });
        ajaxGetTodo("${ctx}/actuator/metrics/jvm.threads.daemon", function (data) {
            $("#jvm-threads-daemon").html("<span>" + data.measurements[0].value + "</span>")
        });
        ajaxGetTodo("${ctx}/actuator/metrics/jvm.threads.live", function (data) {
            $("#jvm-threads-live").html("<span>" + data.measurements[0].value + "</span>")
        });
        ajaxGetTodo("${ctx}/actuator/metrics/jvm.threads.peak", function (data) {
            $("#jvm-threads-peak").html("<span>" + data.measurements[0].value + "</span>")
        });
        ajaxGetTodo("${ctx}/actuator/metrics/jvm.classes.loaded", function (data) {
            $("#jvm-classes-loaded").html("<span>" + data.measurements[0].value + "</span>")
        });
        ajaxGetTodo("${ctx}/actuator/metrics/jvm.classes.unloaded", function (data) {
            $("#jvm-classes-unloaded").html("<span>" + data.measurements[0].value + "</span>")
        });
        ajaxGetTodo("${ctx}/actuator/metrics/jvm.gc.memory.allocated", function (data) {
            $("#jvm-gc-memory-allocated").html("<span>" + jvmConvert(data.measurements[0].value) + "</span>")
        });
        ajaxGetTodo("${ctx}/actuator/metrics/jvm.gc.memory.promoted", function (data) {
            $("#jvm-gc-memory-promoted").html("<span>" + jvmConvert(data.measurements[0].value) + "</span>")
        });
        ajaxGetTodo("${ctx}/actuator/metrics/jvm.gc.max.data.size", function (data) {
            $("#jvm-gc-max-data-size").html("<span>" + jvmConvert(data.measurements[0].value) + "</span>")
        });
        ajaxGetTodo("${ctx}/actuator/metrics/jvm.gc.live.data.size", function (data) {
            $("#jvm-gc-live-data-size").html("<span>" + jvmConvert(data.measurements[0].value) + "</span>")
        });
        ajaxGetTodo("${ctx}/actuator/metrics/jvm.gc.pause", function (data) {
            $("#jvm-gc-pause-count").html("<span>" + data.measurements[0].value + "</span>")
            $("#jvm-gc-pause-total-time").html("<span>" + data.measurements[1].value + "</span>")
        });
    }

    function sysConvert(value) {
        return Number(value * 100).toFixed(2);
    }

    function jvmConvert(value) {
        return Number(value / 1048576).toFixed(3);
    }

    function dateMoment(value) {
        return moment(value).format('YYYY-MM-DD HH:mm:ss');
    }
</script>
  • 请求监控
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
<%@page contentType="text/html; charset=UTF-8" session="false"
%>
<%@include file="/WEB-INF/jspf/import.jspf"
%>
<div class="pageContent">
    <div class="panelBar">
        <ul class="toolBar">
            <li><a class="icon" href="###" onclick="httptraceInfo()" title="刷新"><span>点击刷新</span></a><span
                    id="dataTime"></span>
            </li>
        </ul>
    </div>
    <table class="table" style="width: 100%" layoutH="75">
        <thead>
        <tr>
            <th>请求时间</th>
            <th>请求方法</th>
            <th>请求URL</th>
            <th>响应状态</th>
            <th>请求耗时</th>
        </tr>
        </thead>
        <tbody id="httptrace-list">

        </tbody>
    </table>
</div>

<script type="application/javascript">
    $(function () {
        httptraceInfo();
    });

    /**
     * 请求追踪信息
     */
    function httptraceInfo() {
        $("#dataTime").html("<span style='color:blue;'>近期HTTP请求记录，数据获取时间  " + dateMoment(new Date()) + "</span>");
        ajaxGetTodo("${ctx}/actuator/httptrace", function (data) {
            var node = [];
            var arr = data.traces;
            arr.forEach(function (val, index) {
                var item = val;
                var request = item.request;
                var response = item.response;
                if (request.method !== 'OPTIONS' && request.uri.indexOf('.do') > 0 && request.uri.indexOf('httptrace') === -1) {
                    node.push("<tr>");
                    node.push("<td>" + dateMoment(item.timestamp) + "</td>");
                    node.push("<td>" + request.method + "</td>");
                    node.push("<td>" + request.uri + "</td>");
                    node.push("<td>" + response.status + "</td>");
                    node.push("<td>" + item.timeTaken + "</td>");
                    node.push("</tr>");
                }
            });
            $("#httptrace-list").empty();
            $("#httptrace-list").html(node.join(''));
        });
    }

    function dateMoment(value) {
        return moment(value).format('YYYY-MM-DD HH:mm:ss');
    }
</script>
5、运行结果

image

image

参考文档：

http://www.ityouknow.com/springboot/2018/02/06/spring-boot-actuator.html

-------------已经触及底线 感谢您的阅读-------------

本文标题:Springboot集成actuator实现JVM监控和请求追踪

文章作者:趙小傑~～

发布时间:2019年08月23日 - 16:08:26

最后更新:2019年09月02日 - 19:51:44

原始链接:https://cnsyear.com/posts/fe181368.html

许可协议: 署名-非商业性使用-禁止演绎 4.0 国际 转载请保留原文链接及作者。

0%