feat: add native agent monomer mode

Author: flzj-kl

labs/cluster-management/README.md

@@ -1,18 +1,65 @@
 
 ## Arthas Native Agent - 集群管理
- 
-![](images/cluster_management.png)
 
-# 快速开始
+
+
+# 快速开始 - 单体模式(适用快速体验)
+
+![](asserts/cluster_management_single.png)
+## 单体模式启动native-agent-management-web
+native-agent的管理页面
+启动参数
+
+| 参数                   | 必填  | 解释                                  |
+|----------------------|-----|-------------------------------------|
+| port                 | N   | http端口 ，默认3939                      |
+
+example：
+```shell
+java -jar native-agent-management-web.jar 
+```
+
+## 单体模式启动native-agent-proxy
+proxy会向native-agent-management-web注册自己
+
+| 参数                 | 必填  | 解释                                   |
+|--------------------|-----|--------------------------------------|
+| port               | N   | http/ws端口 ，默认2233                    |
+| ip                 | Y   | proxy的ip                             |
+| management-address | Y   | native-agent-manangement-web的地址，用于注册 |
+```shell
+java -jar native-agent-proxy.jar --ip 127.0.0.1 --management-address 127.0.0.1:3939
+```
+
+## 单体模式启动native-agent
+native-agent，启动在需要动态attach的服务器上。同时需要依赖arthas-agent。请把arthas-agent、arthas-core、arthas-spy放在和native-agent同一个目录下。
+
+| 参数            | 必填  | 解释                         |
+|---------------|-----|----------------------------|
+| http-port     | N   | http端口 ，默认2671             |
+| ws-port       | N   | ws端口，默认2672                |
+| ip            | Y   | native-agent的ip            | 
+| proxy-address | Y   | native-agent-proxy的地址，用于注册 |
+```shell
+java -jar native-agent.jar --ip 127.0.0.1 --proxy-address 127.0.0.1 :2233
+```
+
+
+
+
+# 集群模式
+![](asserts/cluster_management.png)
 
 ## 启动native-agent
-native-agent，启动在需要动态attach的服务器上
+native-agent，启动在需要动态attach的服务器上。同时需要依赖arthas-agent。请把arthas-agent、arthas-core、arthas-spy放在和native-agent同一个目录下。
+
 启动参数
 
 | 参数                   | 必填  | 解释                                  |
 |----------------------|-----|-------------------------------------|
 | http-port            | N   | http端口 ，默认2671                      |
 | ws-port              | N   | ws端口，默认2672                         |
+| ip                   | Y   | native-agent的ip地址                   |
 | registration-typ     | Y   | 注册中心类型（目前实现的有etcd和zookeeper,推荐etcd） |
 | registration-address | Y   | 注册中心的地址                             |
 
@@ -57,11 +104,11 @@ java -jar native-agent-management-web.jar  --registration-type etcd --registrati
 
 ## 监控指定JVM
 进入native-agent-server管理页面，点击VIEW JAVA PROCESS INFO 按钮，可以查看到当前服务器上的Java进程
-![](images/native_agent_list.png)
+![](asserts/native_agent_list.png)
 进入到Java进程页后，我们可以点击Monitor按钮，Monitor目标Java进程
-![](images/native_agent_java_process_page.png)
+![](asserts/native_agent_java_process_page.png)
 之后点击MONITOR按钮就可以进入到监控界面了
-![](images/native_agent_moniotr_page.png)
+![](asserts/native_agent_moniotr_page.png)
 
 # 扩展注册中心
 目前实现的有zookeeper和etcd，如果想要扩展注册中心，可以看看下面的实现。下面演示的是native-agent-management-web的扩展，其他也是同样的道理。

labs/cluster-management/images/cluster_management.png renamed to labs/cluster-management/asserts/cluster_management.png

@@ -43,4 +43,18 @@ public static String post(String url, String json) throws IOException {
         }
     }
 
+
+    public static Response postAndResponse(String url, String json) throws IOException {
+        RequestBody body = RequestBody.create(json, JSON);
+        Request request = new Request.Builder()
+                .url(url)
+                .post(body)
+                .header("Content-Type", "application/json")
+                .build();
+
+        try (Response response = client.newCall(request).execute()) {
+            return response;
+        }
+    }
+
 }

labs/cluster-management/asserts/cluster_management_single.png

@@ -0,0 +1,49 @@
+package com.alibaba.arthas.nat.agent.management.web.discovery.impl;
+
+import com.alibaba.arthas.nat.agent.management.web.discovery.NativeAgentProxyDiscovery;
+
+import java.time.LocalDateTime;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.Executors;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.TimeUnit;
+
+/**
+ * @description: NativeAgentManagementNativeAgentProxyDiscovery(Σ(っ °Д °;)っ 好长的类名)
+ * @author：flzjkl
+ * @date: 2024-10-29 20:59
+ */
+public class NativeAgentManagementNativeAgentProxyDiscovery implements NativeAgentProxyDiscovery {
+
+    /**
+     * key: native agent ip : http port : ws port , value: expiration time
+     */
+    private static Map<String, LocalDateTime> nativeAgentProxyMap = new ConcurrentHashMap<>();
+    private final static int INITIAL_DELAY_SECONDS = 5;
+    private final static int PERIOD_SECONDS = 5;
+
+    public static void storageNativeAgent(String address, LocalDateTime expirationTime) {
+        nativeAgentProxyMap.put(address, expirationTime);
+    }
+
+    public static void nativeAgentProxyCheckScheduled () {
+        ScheduledExecutorService scheduler = Executors.newScheduledThreadPool(1);
+        Runnable task = () -> {
+            LocalDateTime now = LocalDateTime.now();
+            nativeAgentProxyMap.forEach((key, expirationTime) ->{
+                if (now.isAfter(expirationTime)) {
+                    nativeAgentProxyMap.remove(key);
+                }
+            });
+        };
+        scheduler.scheduleAtFixedRate(task, INITIAL_DELAY_SECONDS, PERIOD_SECONDS, TimeUnit.SECONDS);
+    }
+
+    @Override
+    public List<String> listNativeAgentProxy(String address) {
+        return new ArrayList<>(nativeAgentProxyMap.keySet());
+    }
+}

labs/cluster-management/images/native_agent_architecture.png renamed to labs/cluster-management/asserts/native_agent_architecture.png

@@ -2,6 +2,7 @@
 
 import com.alibaba.arthas.nat.agent.common.constants.NativeAgentConstants;
 import com.alibaba.arthas.nat.agent.common.utils.WelcomeUtil;
+import com.alibaba.arthas.nat.agent.management.web.discovery.impl.NativeAgentManagementNativeAgentProxyDiscovery;
 import com.alibaba.arthas.nat.agent.management.web.server.http.HttpRequestHandler;
 
 import com.taobao.middleware.cli.CLI;
@@ -23,14 +24,14 @@
 import java.util.Arrays;
 
 /**
- * @description: native agent server
+ * @description: native agent management web
  * @author：flzjkl
  * @date: 2024-07-20 9:23
  */
-
 @Name("arthas-native-agent-management-web")
 @Summary("Bootstrap Arthas Native Management Web")
-@Description("EXAMPLES:\n" + "  java -jar native-agent-management-web.jar  --registration-type etcd --registration-address 161.169.97.114:2379\n"
+@Description("EXAMPLES:\n" + "java -jar native-agent-management-web.jar\n"
+        + "java -jar native-agent-management-web.jar  --registration-type etcd --registration-address 161.169.97.114:2379\n"
         + "java -jar native-agent-management-web.jar  --port 3939  --registration-type etcd --registration-address 161.169.97.114:2379\n"
         + "https://arthas.aliyun.com/doc\n")
 public class NativeAgentManagementWebBootstrap {
@@ -46,13 +47,13 @@ public void setPort(Integer port) {
         this.port = port;
     }
 
-    @Option(longName = "registration-type", required = true)
+    @Option(longName = "registration-type")
     @Description("registration type")
     public void setRegistrationType(String registrationType) {
         this.registrationType = registrationType;
     }
 
-    @Option(longName = "registration-address", required = true)
+    @Option(longName = "registration-address")
     @Description("registration address")
     public void setRegistrationAddress(String registrationAddress) {
         this.registrationAddress = registrationAddress;
@@ -75,6 +76,17 @@ public static void main(String[] args) {
         }
         logger.info("read input success!");
 
+        logger.info("check bootstrap params ...");
+        boolean checkBootstrapParamsRes = checkBootstrapParams(nativeAgentManagementWebBootstrap);
+        if (!checkBootstrapParamsRes) {
+            throw new RuntimeException("Failed to verify the bootstrap parameters. " +
+                    "Please read the documentation and check the parameters you entered");
+        }
+        if (nativeAgentManagementWebBootstrap.getRegistrationType() == null && nativeAgentManagementWebBootstrap.getRegistrationAddress() == null) {
+            nativeAgentManagementWebBootstrap.setRegistrationType("native-agent-management");
+            nativeAgentManagementWebBootstrap.setRegistrationAddress("127.0.0,1:" + nativeAgentManagementWebBootstrap.getPortOrDefault());
+            NativeAgentManagementNativeAgentProxyDiscovery.nativeAgentProxyCheckScheduled();
+        }
         // Start the http server
         logger.info("start the http server... httPort:{}", nativeAgentManagementWebBootstrap.getPortOrDefault());
         NioEventLoopGroup bossGroup = new NioEventLoopGroup();
@@ -106,6 +118,20 @@ protected void initChannel(SocketChannel ch) {
         }
     }
 
+    private static boolean checkBootstrapParams(NativeAgentManagementWebBootstrap managementBootstrap) {
+        String address = managementBootstrap.getRegistrationAddress();
+        String type = managementBootstrap.getRegistrationType();
+        // single
+        if (address == null && type == null) {
+            return true;
+        }
+        // cluster
+        if (address != null && type != null) {
+            return true;
+        }
+        return false;
+    }
+
     public int getPortOrDefault() {
         if (this.port == null) {
             return DEFAULT_NATIVE_AGENT_MANAGEMENT_WEB_PORT;

labs/cluster-management/images/native_agent_java_process_page.png renamed to labs/cluster-management/asserts/native_agent_java_process_page.png

@@ -1,18 +1,18 @@
 package com.alibaba.arthas.nat.agent.management.web.server.http;
 
 import com.alibaba.arthas.nat.agent.management.web.discovery.NativeAgentProxyDiscovery;
+import com.alibaba.arthas.nat.agent.management.web.discovery.impl.NativeAgentManagementNativeAgentProxyDiscovery;
 import com.alibaba.arthas.nat.agent.management.web.factory.NativeAgentProxyDiscoveryFactory;
 import com.alibaba.arthas.nat.agent.management.web.server.NativeAgentManagementWebBootstrap;
 import com.alibaba.fastjson2.JSON;
 import com.alibaba.fastjson2.TypeReference;
 import io.netty.buffer.Unpooled;
 import io.netty.channel.ChannelHandlerContext;
-import io.netty.handler.codec.http.DefaultFullHttpResponse;
-import io.netty.handler.codec.http.FullHttpRequest;
-import io.netty.handler.codec.http.FullHttpResponse;
-import io.netty.handler.codec.http.HttpResponseStatus;
+import io.netty.handler.codec.http.*;
 
 import java.nio.charset.StandardCharsets;
+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
 import java.util.List;
 import java.util.Map;
 import java.util.Random;
@@ -34,9 +34,27 @@ public FullHttpResponse handle(ChannelHandlerContext ctx, FullHttpRequest reques
             return responseFindAvailableProxyAddress(ctx, request);
         }
 
+        if ("register".equals(operation)) {
+            String addressInfo = (String) bodyMap.get("nativeAgentProxyAddress");
+            String expirationTimeStr = (String) bodyMap.get("expirationTime");
+            return doRegisterNativeAgentProxy(request, addressInfo, expirationTimeStr);
+        }
+
         return null;
     }
 
+    private FullHttpResponse doRegisterNativeAgentProxy(FullHttpRequest request, String addressInfo, String expirationTimeStr) {
+        LocalDateTime expirationTime = LocalDateTime.parse(expirationTimeStr, DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss.SSS"));
+        NativeAgentManagementNativeAgentProxyDiscovery.storageNativeAgent(addressInfo, expirationTime);
+        DefaultFullHttpResponse response = new DefaultFullHttpResponse(
+                request.getProtocolVersion(),
+                HttpResponseStatus.OK,
+                Unpooled.copiedBuffer("success", StandardCharsets.UTF_8)
+        );
+        fillCorsHead(response);
+        return response;
+    }
+
 
     public FullHttpResponse responseFindAvailableProxyAddress(ChannelHandlerContext ctx, FullHttpRequest request) {
         String availableProxyAddress = findAvailableProxyAddress();
@@ -48,6 +66,7 @@ public FullHttpResponse responseFindAvailableProxyAddress(ChannelHandlerContext
                 HttpResponseStatus.OK,
                 Unpooled.copiedBuffer(availableProxyAddress, StandardCharsets.UTF_8)
         );
+        fillCorsHead(response);
         return response;
     }
 
@@ -67,4 +86,15 @@ public String findAvailableProxyAddress() {
     }
 
 
+    private void fillCorsHead(FullHttpResponse fullHttpResponse) {
+        // 设置跨域响应头
+        fullHttpResponse.headers().set(HttpHeaderNames.ACCESS_CONTROL_ALLOW_ORIGIN, "*");
+        fullHttpResponse.headers().set(HttpHeaderNames.ACCESS_CONTROL_ALLOW_METHODS, "GET, POST, PUT, DELETE, OPTIONS");
+        fullHttpResponse.headers().set(HttpHeaderNames.ACCESS_CONTROL_ALLOW_HEADERS, "X-Requested-With, Content-Type, Authorization");
+
+        // 设置其他必要的头部
+        fullHttpResponse.headers().set(HttpHeaderNames.CONTENT_TYPE, "application/json");
+        fullHttpResponse.headers().set(HttpHeaderNames.CONTENT_LENGTH, fullHttpResponse.content().readableBytes());
+    }
+
 }

labs/cluster-management/images/native_agent_list.png renamed to labs/cluster-management/asserts/native_agent_list.png

@@ -1,2 +1,3 @@
+native-agent-management=com.alibaba.arthas.nat.agent.management.web.discovery.impl.NativeAgentManagementNativeAgentProxyDiscovery
 zookeeper=com.alibaba.arthas.nat.agent.management.web.discovery.impl.ZookeeperNativeAgentProxyDiscovery
 etcd=com.alibaba.arthas.nat.agent.management.web.discovery.impl.EtcdNativeAgentProxyDiscovery

labs/cluster-management/images/native_agent_moniotr_page.png renamed to labs/cluster-management/asserts/native_agent_moniotr_page.png

@@ -0,0 +1,54 @@
+package com.alibaba.arthas.nat.agent.proxy.discovery.impl;
+
+import com.alibaba.arthas.nat.agent.proxy.discovery.NativeAgentDiscovery;
+
+import java.time.LocalDateTime;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.Executors;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.TimeUnit;
+
+/**
+ * @description: NativeAgentProxyNativeAgentDiscovery
+ * @author：flzjkl
+ * @date: 2024-10-28 21:07
+ */
+public class NativeAgentProxyNativeAgentDiscovery implements NativeAgentDiscovery {
+
+    /**
+     * key: native agent ip : http port : ws port , value: expiration time
+     */
+    private static Map<String, LocalDateTime> nativeAgentMap = new ConcurrentHashMap<>();
+    private final static int INITIAL_DELAY_SECONDS = 5;
+    private final static int PERIOD_SECONDS = 5;
+
+    public static void storageNativeAgent(String address, LocalDateTime expirationTime) {
+        nativeAgentMap.put(address, expirationTime);
+    }
+
+    public static void nativeAgentCheckScheduled () {
+        ScheduledExecutorService scheduler = Executors.newScheduledThreadPool(1);
+        Runnable task = () -> {
+            LocalDateTime now = LocalDateTime.now();
+            nativeAgentMap.forEach((key, expirationTime) ->{
+                if (now.isAfter(expirationTime)) {
+                    nativeAgentMap.remove(key);
+                }
+            });
+        };
+        scheduler.scheduleAtFixedRate(task, INITIAL_DELAY_SECONDS, PERIOD_SECONDS, TimeUnit.SECONDS);
+    }
+
+
+    @Override
+    public Map<String, String> findNativeAgent(String address) {
+        Map<String, String> res = new HashMap<>();
+        for (String key : nativeAgentMap.keySet()) {
+            String[] split = key.split("@");
+            res.put(split[0], split[1]);
+        }
+        return res;
+    }
+}