关于tomcat:Tomcat-下部署若依单体应用可观测最佳实践

4次阅读

共计 8171 个字符，预计需要花费 21 分钟才能阅读完成。

采集指标信息
采集链路信息
采集日志信息
采集 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

......
    <dependencyManagement>
        <dependencies>

            <!-- SpringBoot 的依赖配置 -->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.5.15</version>
                <type>pom</type>
                <scope>import</scope>
                <!-- 移除外部 tomcat -->
                <exclusions>
                    <exclusion>
                        <artifactId>spring-boot-starter-tomcat</artifactId>
                        <groupId>org.springframework.boot</groupId>
                    </exclusion>
                </exclusions>
            </dependency>
......

war 输入

调整 ruoyi-admin 模块下的 pom.xml 文件

<packaging>war</packaging>

调整日志

在 ruoyi-admin/src/main/resources 新增 logback-spring.xml，原文如下：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 日志寄存门路 -->
    <property name="log.path" value="/home/root/ruoyi/logs" />
    <!-- 日志输入格局 -->
    <property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - [%method,%line] %X{dd.service} %X{dd.trace_id} %X{dd.span_id} - %msg%n" />

    <!-- 控制台输入 -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
    </appender>

    <!-- 系统日志输入 -->
    <appender name="file_info" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/sys-info.log</file>
        <!-- 循环政策：基于工夫创立日志文件 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 日志文件名格局 -->
            <fileNamePattern>${log.path}/sys-info.%d{yyyy-MM-dd}.log</fileNamePattern>
            <!-- 日志最大的历史 60 天 -->
            <maxHistory>60</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 过滤的级别 -->
            <level>INFO</level>
            <!-- 匹配时的操作：接管（记录）-->
            <onMatch>ACCEPT</onMatch>
            <!-- 不匹配时的操作：回绝（不记录）-->
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <appender name="file_error" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/sys-error.log</file>
        <!-- 循环政策：基于工夫创立日志文件 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 日志文件名格局 -->
            <fileNamePattern>${log.path}/sys-error.%d{yyyy-MM-dd}.log</fileNamePattern>
            <!-- 日志最大的历史 60 天 -->
            <maxHistory>60</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 过滤的级别 -->
            <level>ERROR</level>
            <!-- 匹配时的操作：接管（记录）-->
            <onMatch>ACCEPT</onMatch>
            <!-- 不匹配时的操作：回绝（不记录）-->
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 用户拜访日志输入  -->
    <appender name="sys-user" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/sys-user.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滚 daily -->
            <fileNamePattern>${log.path}/sys-user.%d{yyyy-MM-dd}.log</fileNamePattern>
            <!-- 日志最大的历史 60 天 -->
            <maxHistory>60</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
    </appender>

    <!-- 零碎模块日志级别管制  -->
    <logger name="com.ruoyi" level="info" />
    <!-- Spring 日志级别管制  -->
    <logger name="org.springframework" level="warn" />

    <root level="info">
        <appender-ref ref="console" />
    </root>

    <!-- 零碎操作日志 -->
    <root level="debug">
        <appender-ref ref="file_info" />
        <appender-ref ref="file_error" />
    </root>

    <!-- 零碎用户操作日志 -->
    <logger name="sys-user" level="info">
        <appender-ref ref="sys-user"/>
    </logger>
</configuration>

编译

进入我的项目根目录执行以下命令进行编译：

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 装置文档：https://docs.guance.com/datakit/datakit-install/

DDTrace 采集器用于采集利用链路信息，参考 DDTrace 采集器接入文档：https://docs.guance.com/integrations/ddtrace/

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")

StatsD 采集器用于采集指标信息，参考 StatsD 采集器接入文档：https://docs.guance.com/integrations/statsd/

RUM 采集器: RUM（Real User Monitor）采集器用于收集网页端或挪动端上报的用户拜访监测数据。参考 RUM 采集器接入文档：https://docs.guance.com/integrations/rum/

重启 DataKit：https://docs.guance.com/datakit/datakit-service-how-to/#manag…

下载 dd-trace-java，尽量下载最新版本：https://github.com/GuanceCloud/dd-trace-java/releases

登陆观测云
抉择 用户拜访检测 ，抉择 利用列表 ，点击 新建利用
利用名称 填写 ruoyi-admin， 利用 ID 能够自定义，也能够点击 随机生成 按钮
利用类型 抉择 web，左边 SDK 配置 有几个类型，这里咱们抉择 CDN 同步载入， 复制对应的脚本内容，后续会用到。
点击 创立 按钮，实现创立。

下载对应版本的 Tomcat：https://tomcat.apache.org/download-90.cgi

在 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 下。

执行 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.

Tomcat 启动实现后，主动解压 war 利用，进入到 /webapps/ruoyi-admin/WEB-INF/classes/templates 目录下，调整 include.html，将上一步复制的脚本代码粘贴到 head。

<head th:fragment=header(title)>
...
<script src="https://static.guance.com/browser-sdk/v3/dataflux-rum.js" type="text/javascript"></script>
<script>
  window.DATAFLUX_RUM &&
    window.DATAFLUX_RUM.init({
      applicationId: 'APP_ID',
      datakitOrigin: 'http://localhost:9529', // 协定（包含：//），域名（或 IP 地址）[和端口号]
      env: 'production',
      version: '1.0.0',
      service: 'browser',
      sessionSampleRate: 100,
      sessionReplaySampleRate: 70,
      trackInteractions: true,
      traceType: 'ddtrace', // 非必填，默认为 ddtrace，目前反对 ddtrace、zipkin、skywalking_v3、jaeger、zipkin_single_header、w3c_traceparent 6 种类型
      allowedTracingOrigins: ['http://localhost:8080','http://localhost:8080/ruoyi-admin'],  // 非必填，容许注入 trace 采集器所需 header 头部的所有申请列表。能够是申请的 origin，也能够是是正则
    });
    window.DATAFLUX_RUM && window.DATAFLUX_RUM.startSessionReplayRecording()
</script>
...
</head>

applicationId：复制过去的就不须要调整。
datakitOrigin: 用于接管 RUM 数据上报的 DataKit 地址
allowedTracingOrigins：与后端 APM 串联，前端调用 API 接口，会在对应的接口新增 Trace 所需的 Header 信息

拜访 http://localhost:8080/ruoyi-admin，默认用户名：admin，明码：admin123。

进入日志详情，能够查看到以后日志对应的链路信息

也能够通过链路查看日志和指标信息

正文完

tomcat

发表至： tomcat

2024-02-26

0

关于tomcat:部署tomcat项目

关于tomcat:TomcatHTTP总结1

关于tomcat:初学Tomcat遇到的一些问题

关于tomcat:tomcatThis-environment-variable-is-needed-to-run-this-program

关于程序员:MoonBit支持云原生调试功能

关于tomcat:Tomcat-下部署若依单体应用可观测最佳实践

实现目标

版本信息

若依的单体利用

DataKit

装置 DataKit

DataKit 开启 DDTrace 采集器

DataKit 开启 Log 采集器

DataKit 开启 StatsD 采集器

DataKit 开启 RUM 采集器

重启 DataKit

DDTrace

创立 RUM

Tomcat

下载 Tomcat

配置 DDTrace

部署利用

启动 Tomcat

退出 RUM

成果

日志

链路信息

指标信息

RUM 看板

会话重放

站内搜索