本文涉及模块属于「实验性功能」,此类功能使用门槛较高,功能仍在进行打磨优化中。
若您有相关实际使用场景,建议添加微信群,向运营人员获取使用帮助、反馈功能相关建议和评价。
1. 概述编辑
1.1 版本
运维平台版本 | 功能变更 |
---|---|
V1.5.5 | - |
V1.5.7 | 1)非容器化项目,启用链路追踪功能步骤简化 2)支持关闭链路追踪功能 |
1.2 功能简介
运维平台提供「链路追踪」功能,但该功能默认仅对容器化部署的应用生效。
本文将介绍如何将非容器化部署的 FineReport/FineBI 项目,接入链路追踪功能。
2. 操作步骤编辑
2.1 确认工程JDK版本
使用链路追踪功能,必须确保FR/BI项目使用JDK8u211及以上版本。
2.2 启用运维组件
链路追踪功能,由这些运维组件提供:elasticSearch、skywalking_oap。
1.5.7及之后版本,这些组件默认启动,用户可手动关闭组件。1.5.6及之前版本,这些组件默认不启动。
如需使用「链路追踪」功能,必须先确保已启动这些组件。否则提示「链路追踪组件未启用,请在运维组件目录中启动elasticsearch以及skywalking_oap」。如下图所示:
管理员登录运维平台,点击「运维管理>运维组件」,先启动elasticSearch组件,再启动skywalking_oap组件。
2.3 确认端口互通
运维平台的skywalking_oap组件,负责链路追踪的数据上报和分析整理服务。
因此必须确保FineReport/FineBI 项目所在服务器,支持访问运维平台的skywalking_oap组件端口。
skywalking_oap组件默认端口为:{11800:11800}、{12800:12800}
2.4 新增项目
管理员需要先将待接入链路追踪的非容器化部署的 FineReport/FineBI 项目,新增到运维平台的「项目管理」中。如下图所示:
新增项目的操作方法请参见:接入已有非容器化项目
2.5 启用链路追踪
1)管理员访问「链路追踪」相关界面,选择待启用链路追踪的非容器化项目。
2)界面显示「当前未启用链路追踪」,点击「启用链路追踪」。
3)跳出提示「请手动重启项目,该项目在开启链路追踪后需手动重启」,点击「我知道了」,开始自动启用链路追踪。
4)FineOps运维平台会自动执行启用步骤
自动传输 skywalking-java-agent 文件到 FineReport/FineBI 工程的 WEB-INF 文件夹下
自动为 FineReport/FineBI 工程添加 skywalkingAgent 相关的启动参数
5)启用步骤执行完成后,提示「已启用链路追踪,将在手动重启项目后生效」。
2.6 重启项目
参考 关闭或重启FineBI工程 / 关闭或重启FineReport工程 文档,重启FineReport/FineBI项目。
即可将该非容器化部署的 FineReport/FineBI 项目,接入链路追踪功能。
注:FineReport/FineBI工程下的所有节点,都需要依次进行以上操作。
3. 注意事项编辑
3.1 升级链路追踪依赖文件
skywalking-java-agent 文件会持续更新升级。
管理员登录FineOps运维平台时,会自动检测非容器化项目是否存在 skywalking-java-agent 文件更新。
若需要更新,会自动进行更新。更新成功后,仍需要重启FineReport/FineBI项目才能生效。
若更新了文件但未重启项目,使用该容器化项目的链路追踪功能时,提示「当前项目的链路追踪功能存在更新,请重启项目完成更新」。
3.2 关闭链路追踪
FineOps运维平台支持对项目停用链路追踪功能。
1)管理员登录运维平台,点击「实验性功能>链路追踪>全局设置」。
2)选择待关停链路追踪的项目,点击「关闭链路追踪」。
3)参考 关闭或重启FineBI工程 / 关闭或重启FineReport工程 文档,重启FineReport/FineBI项目。
即可成功关闭当前运维项目的链路追踪功能。