文章自动采集插件( 工银的方案大而全集成Arthas实践中的改造方案参考)
优采云 发布时间: 2022-01-01 05:22文章自动采集插件(
工银的方案大而全集成Arthas实践中的改造方案参考)
该项目最初使用 Arthas 有两个主要目的：
通过arthas，解决实现测试环境、性能测试环境、生产环境性能问题分析工具的问题。生产环境中部分节点代码的热更新能力是通过jad、mc、redefine等功能组合实现的。技术选型相关
由于公司尚未建立较为统一的生产微服务配置和状态管理能力，各自系统的研发、运维相对独立。现在项目采用Spring Cloud和Eureka的框架结构，匹配SBA的基础支持能力。同时，SBA已经可以提供服务感知、日志级别的配置管理，以及很多基于actuator-based JVM和Spring容器的管理插件。基本使用要求。
经查，Arthas整体版本为3.4.5，提供基于Webconsole的Tunner Server模式。通过前面的链接文章已经实践过了，实现了与SBA的集成。由于项目本身没有历史包袱，所以在实际集成过程中采用了SBA2.0版本，提供更多的管理功能和图形界面能力。其他优势：
整体结构
几个关键点，使用JVM内置的Arthas Spring Boot插件，参考ICBC模型建立完整的客户端下载和修改脚本实现远程控制。内置方案工作量和开发量小，只需集成相关开源组件即可实现相关远程使用模式，兼顾安全性。工行的解决方案规模庞大，完全适合在整体架构规划后部署专门研发团队的城市。内置方案还包括通过JMX的启动和停止操作（基于3.4.5的Spring Boot插件无法获取相关句柄，暂时无法实现），不通过默认。远程JMX激活后，JVM增加了8个相关线程，新增虚拟机内存约30MB，与本文引用的SBA1.0方案相同。在线激活前需要考虑是否支持JVM内存。
实现效果
SBA 2.0 最大的方便是它提供了配置外部网页链接的能力。同时，如果网页在当前JVM进程中实现，则可以实现Spring-Security的本地权限管理。在生产环境中，只有登录后，才能使用相关的集成artha功能，只有在SBA之后才能使用。
重建计划
参考原文-SpringBoot Admin集成Arthas实践中实现的几个步骤。
1.整体项目结构
整体项目修改自SBA开源项目的示例项目。使用custom-ui的具体项目链接是：[_[spring-boot-admin-sample-custom-ui]_]()_，_红框部分是arthas web控制台的所有静态文件，通过Maven Resource的指定配置进入指定目录，实现SBA启动时的自定义加载。 maven 资源配置-下一步：
static
${project.build.directory}/classes/META-INF/spring-boot-admin-server-ui/extensions/arthas
false
最终构建的JAR中的META-INFO收录相关文件，可以在SBA自带的tomcat启动后加载到相关静态资源中，最终URL对应自定义实现配置的外部URL阿尔萨斯控制台。 .
2. 外链配置
SBA 2.0 从一开始就使用vue全家桶，扩展集成方便。其中，官方文档给出了外部连接的配置方法：[_[Linking/Embedding External Pages]_](#customizing-external-views)_。 _
参考sba示例工程的application.yml配置：
# tag::customization-external-views[]
spring:
boot:
admin:
ui:
external-views:
- label: "Arthas Console"
url: http://21.129.49.153:8080/
order: 1900
# end::customization-external-views[]
3.对应Spring MVC控制器实现
参考原实现的SBA集成部分，该部分主要修改实现以下功能：
4. Arthas Spring Boot 插件修改与配置
参考SBA集成插件修改及客户端配置application.yml原文实现。
对原Spring boot插件的主要修改是原插件通过Spring的@ConditionalOnMissingBean自动加载。
修改主要是通过修改这部分实现配置文件默认不启动，然后在使用时远程启动相关代理线程。
5.基于Spring Actuator的JMX实现
SBA 客户端在引入 maven 时会默认导入 jolokia-core.jar。如果没有SBA客户端依赖，可以自己导入包，通过actuator实现基于http的jmx操作能力和SBA控制台相关功能的无缝开启。合作。
在application.yml中开启管理相关的配置。根据自己的环境，也可以在客户端开启Spring安全认证。 SBA 还可以通过服务发现很好地支持受密码保护的执行器端点访问。
#放开management
management:
endpoints:
web:
exposure:
# 这里用* 代表暴露所有端点只是为了观察效果，实际中按照需进行端点暴露
include: "*"
exclude: env
endpoint:
health:
# 详细信息显示给所有用户。
show-details: ALWAYS
health:
status:
http-mapping:
# 自定义健康检查返回状态码对应的 http 状态码
FATAL: 503
JMX实现是指原文中EnvironmentChangeListener的实现思路，可以基于Spring的JMX注解实现。
@Component
@ManagedResource(objectName = "com.ArthasAgentManageMbean:name=ArthasMbean", description = "Arthas远程管理Mbean")
public class ArthasMbeanImpl {
@Autowired
private Map arthasConfigMap;
@Autowired
private ArthasProperties arthasProperties;
@Autowired
private ApplicationContext applicationContext;
/**
* 初始化
*
* @return
*/
private ArthasAgent arthasAgentInit() {
arthasConfigMap = StringUtils.removeDashKey(arthasConfigMap);
// 给配置全加上前缀
Map mapWithPrefix = new HashMap(arthasConfigMap.size());
for (Map.Entry entry : arthasConfigMap.entrySet()) {
mapWithPrefix.put("arthas." + entry.getKey(), entry.getValue());
}
final ArthasAgent arthasAgent = new ArthasAgent(mapWithPrefix, arthasProperties.getHome(),
arthasProperties.isSlientInit(), null);
arthasAgent.init();
return arthasAgent;
}
@ManagedOperation(description = "获取配置Arthas Tunnel Server地址")
public String getArthasTunnelServerUrl() {
return arthasProperties.getTunnelServer();
}
@ManagedOperation(description = "设置Arthas Tunnel Server地址，重新attach后生效")
@ManagedOperationParameter(name = "tunnelServer", description = "example:ws://127.0.0.1:7777/ws")
public Boolean setArthasTunnelServerUrl(String tunnelServer) {
if (tunnelServer == null || tunnelServer.trim().equals("") || tunnelServer.indexOf("ws://") < 0) {
return false;
}
arthasProperties.setTunnelServer(tunnelServer);
return true;
}
@ManagedOperation(description = "获取AgentID")
public String getAgentId() {
return arthasProperties.getAgentId();
}
@ManagedOperation(description = "获取应用名称")
public String getAppName() {
return arthasProperties.getAppName();
}
@ManagedOperation(description = "获取ArthasConfigMap")
public HashMap getArthasConfigMap() {
return (HashMap) arthasConfigMap;
}
@ManagedOperation(description = "返回是否已经加载Arthas agent")
public Boolean isArthasAttched() {
DefaultListableBeanFactory defaultListableBeanFactory = (DefaultListableBeanFactory) applicationContext.getAutowireCapableBeanFactory();
String bean = "arthasAgent";
if (defaultListableBeanFactory.containsBean(bean)) {
return true;
}
return false;
}
@ManagedOperation(description = "启动Arthas agent")
public Boolean startArthasAgent() {
DefaultListableBeanFactory defaultListableBeanFactory = (DefaultListableBeanFactory) applicationContext.getAutowireCapableBeanFactory();
String bean = "arthasAgent";
if (defaultListableBeanFactory.containsBean(bean)) {
((ArthasAgent) defaultListableBeanFactory.getBean(bean)).init();
return true;
}
defaultListableBeanFactory.registerSingleton(bean, arthasAgentInit());
return true;
}
@ManagedOperation(description = "关闭Arthas agent，暂未实现")
public Boolean stopArthasAgent() {
// TODO 无法获取自定义tmp文件夹加载的classLoader，因此无法获取到com.taobao.arthas.core.server.ArthasBootstrap类并调用destroy方法
DefaultListableBeanFactory defaultListableBeanFactory = (DefaultListableBeanFactory) applicationContext.getAutowireCapableBeanFactory();
String bean = "arthasAgent";
if (defaultListableBeanFactory.containsBean(bean)) {
defaultListableBeanFactory.destroySingleton(bean);
return true;
} else {
return false;
}
}
}
实际使用
管理项目投产后，多次用于生产环境进行故障排除和代码热修复。性能问题主要用于灰度发布的性能流控组件和相关配置参数的在线验证和调试。
在代码热加载初期，操作由jad+mc进行。后来发现jad由于环境配置和部分代码jvm问题，反编译出来的代码不一致。然后通过maven部署应用源码压缩包。解决这个问题，直接使用与应用程序jar相同版本构建的源代码进行修改更可靠。整体解决方案在严格管理的生产环境中提供有效的性能分析和热修复能力。
遗留问题
现有官方com.taobao.arthas.agent.attach.ArthasAgent中启动arthas代理的客户端使用的arthasClassLoader和bootstrapClass是方法中的临时变量，无法从外部获取相关句柄来实现通过bootstrapClass关闭arthas代理 临时解决方案是通过JMX启动并连接到web控制台使用后，使用stop命令关闭目标进程中的arthas代理。
现有的字节码加载工具可以很好的实现内部类和私有类的在线热部署和替换。还测试了兼容 SkyWalk8.x 版本的 javaagent 插件，但是在测试环境中因为配置了 jacoco 覆盖 采集 插件与 Arthas 字节码不兼容。在某些环境下，需要关闭相应的agent才能使用arthas的相关功能。
作者 |麻雀
