实现目标
- 采集指标信息
- 采集链路信息
- 采集日志信息
- 采集 RUM 信息
- 会话重放 即用户访问前端的一系列过程的会话录制信息，包括点击某个按钮、操作界面、停留时间等，有助于客户真是意图、操作复现
版本信息
- Tomcat (9.0.81)
- Springboot(2.6.2)
- JDK (>=8)
- DDTrace (>=1.0)
特别说明：如果是 Springboot 项目，Tomcat 大版本需与 Springboot 内置的 Tomcat 大版本一致，否则可能会存在启动异常。
若依的单体应用
- 下载源码
若依的单体应用：
https://gitee.com/y_project/RuoYi/tree/master
git clone https://gitee.com/y_project/RuoYi.git
- 移除内部 tomcat
调整项目根目录的 pom.xml
......
org.springframework.boot
spring-boot-dependencies
2.5.15
pom
import
spring-boot-starter-tomcat
org.springframework.boot
......
- war 输出
调整 ruoyi-admin 模块下的 pom.xml 文件
war
- 调整日志
在
ruoyi-admin/src/main/resources 新增 logback-spring.xml，原文如下：
${log.pattern}
${log.path}/sys-info.log
${log.path}/sys-info.%d{yyyy-MM-dd}.log
60
${log.pattern}
INFO
ACCEPT
DENY
${log.path}/sys-error.log
${log.path}/sys-error.%d{yyyy-MM-dd}.log
60
${log.pattern}
ERROR
ACCEPT
DENY
${log.path}/sys-user.log
${log.path}/sys-user.%d{yyyy-MM-dd}.log
60
${log.pattern}
- 编译
进入项目根目录执行以下命令进行编译：
mvn clean package
如果没有安装 Maven，则需要先安装 Maven 再进行编译。
[INFO] --- spring-boot:2.5.15:repackage (default) @ ruoyi-admin ---
[INFO] Replacing main artifact with repackaged archive
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary for ruoyi 4.7.7:
[INFO]
[INFO] ruoyi .............................................. SUCCESS [ 0.179 s]
[INFO] ruoyi-common ....................................... SUCCESS [ 4.622 s]
[INFO] ruoyi-system ....................................... SUCCESS [ 0.770 s]
[INFO] ruoyi-framework .................................... SUCCESS [ 0.950 s]
[INFO] ruoyi-quartz ....................................... SUCCESS [ 0.388 s]
[INFO] ruoyi-generator .................................... SUCCESS [ 0.378 s]
[INFO] ruoyi-admin ........................................ SUCCESS [ 4.554 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 12.287 s
[INFO] Finished at: 2023-10-13T16:30:12+08:00
[INFO] ------------------------------------------------------------------------
DataKit
- 安装 DataKit
- 开启采集器
安装 DataKit
参考 DataKit 安装文档：
https://docs.guance.com/datakit/datakit-install/
DataKit 开启 DDTrace 采集器
DDTrace 采集器用于采集应用链路信息，参考 DDTrace 采集器接入文档：
https://docs.guance.com/integrations/ddtrace/
DataKit 开启 Log 采集器
Log 采集器用于采集日志信息，参考 Log 采集器接入文档：
https://docs.guance.com/integrations/logging/
需要调整以下信息：
logfiles = [
"/home/liurui/ruoyi/logs/*.log",
]
## Add service tag, if it's empty, use $source.
service = "ruoyi"
## Grok pipeline script name.
pipeline = "ruoyi.p"
- logfiles：需要采集的日志文件路径
- service: 服务名称
- pipeline： 日志解析
Pipeline 配置
Pipeline 用于数据治理，这里主要是将日志信息进行提取，以便与链路信息关联。
在 datakit/pipeline/ 目录下创建 ruoyi.p 文件，内容如下：
grok(_, "%{TIMESTAMP_ISO8601:time} %{NOTSPACE:thread_name} %{LOGLEVEL:status}%{SPACE}%{NOTSPACE:class_name} - \\[%{NOTSPACE:method_name},%{NUMBER:line}\\] %{DATA:service_name2} %{DATA:trace_id} %{DATA:span_id} - %{GREEDYDATA:msg}")
default_time(time,"Asia/Shanghai")
DataKit 开启 StatsD 采集器
StatsD 采集器用于采集指标信息，参考StatsD 采集器接入文档：
https://docs.guance.com/integrations/statsd/
DataKit 开启 RUM 采集器
RUM 采集器: RUM（Real User Monitor）采集器用于收集网页端或移动端上报的用户访问监测数据。参考RUM 采集器接入文档：
https://docs.guance.com/integrations/rum/
重启 DataKit
重启 DataKit：
https://docs.guance.com/datakit/datakit-service-how-to/#manage-service
DDTrace
下载 dd-trace-java，尽量下载最新版本：
https://github.com/GuanceCloud/dd-trace-java/releases
创建 RUM
- 登陆观测云
- 选择 用户访问检测，选择 应用列表，点击 新建应用
- 应用名称 填写 ruoyi-admin，应用 ID 可以自定义，也可以点击 随机生成 按钮
- 应用类型 选择 web，右边 SDK 配置 有几个类型，这里我们选择 CDN 同步载入，复制对应的脚本内容，后续会用到。
- 点击 创建 按钮，完成创建。
Tomcat
下载 Tomcat
下载对应版本的 Tomcat：
https://tomcat.apache.org/download-90.cgi
配置 DDTrace
在 Tomcat bin 目录下新增脚本 setenv.sh 文件。
export CATALINA_OPTS="-javaagent:/home/root/agent/dd-java-agent-1.14.0-guance.jar \
-Ddd.tags=env:test \
-Ddd.jmxfetch.enabled=true \
-Ddd.jmxfetch.statsd.host=localhost \
-Ddd.jmxfetch.statsd.port=8125 \
-Ddd.jmxfetch.tomcat.enabled=true\
-Dlogging.config=classpath:logback-spring.xml"
- javaagent: 指定 ddtace 目录
- Dlogging.config: 指定应用的日志以 logback 日志输出。如果应用内部使用的是 log4j，指定对应的文件即可。
部署应用
将已经打包好的应用
RuoYi/ruoyi-admin/target/ruoyi-admin.war 复制到 Tomcat 的 webapps 下。
启动 Tomcat
执行 bin/startup.sh
apache-tomcat-9.0.81/bin$ ./startup.sh
Using CATALINA_BASE: /home/root/middleware/apache-tomcat-9.0.81
Using CATALINA_HOME: /home/root/middleware/apache-tomcat-9.0.81
Using CATALINA_TMPDIR: /home/root/middleware/apache-tomcat-9.0.81/temp
Using JRE_HOME: /home/root/middleware/jdk/jdk-11.0.18
Using CLASSPATH: /home/root/middleware/apache-tomcat-9.0.81/bin/bootstrap.jar:/home/root/middleware/apache-tomcat-9.0.81/bin/tomcat-juli.jar
Using CATALINA_OPTS: -javaagent:/home/root/agent/dd-java-agent-1.14.0-guance.jar -Ddd.tags=env:test -Ddd.jmxfetch.enabled=true -Ddd.jmxfetch.statsd.host=localhost -Ddd.jmxfetch.statsd.port=8125 -Ddd.jmxfetch.tomcat.enabled=true -Dlogging.config=classpath:logback-spring.xml
Tomcat started.
加入 RUM
Tomcat 启动完成后，自动解压 war 应用，进入到
/webapps/ruoyi-admin/WEB-INF/classes/templates 目录下，调整 include.html，将上一步复制的脚本代码粘贴到 head。
...
...
- applicationId：复制过来的就不需要调整。
- datakitOrigin: 用于接收 RUM 数据上报的 DataKit 地址
- allowedTracingOrigins： 与后端 APM 串联，前端调用 API 接口，会在对应的接口新增 Trace 所需的 Header 信息
效果
访问
http://localhost:8080/ruoyi-admin，默认用户名：admin，密码：admin123。
日志
进入日志详情，可以查看到当前日志对应的链路信息
链路信息
也可以通过链路查看日志和指标信息
指标信息
RUM 看板
会话重放