fix path checking

.gitignore

@@ -1,2 +1,3 @@
 build
 vue/node_modules
+log/

.gitmodules

@@ -1,10 +1,9 @@
 [submodule "3rd/lua-cjson"]
 	path = 3rd/lua-cjson
 	url = https://github.com/cloudwu/lua-cjson
-[submodule "3rd/luaprofile"]
-	path = 3rd/luaprofile
-	url = https://github.com/lsg2020/luaprofile
 [submodule "skynet"]
 	path = skynet
-	url = https://github.com/lsg2020/skynet
-	branch = skynet_profile
+	url = https://github.com/wilsonloo/skynet.git
+[submodule "3rd/luaprofile"]
+	path = 3rd/luaprofile
+	url = https://github.com/wilsonloo/luaprofile.git

Makefile

@@ -56,6 +56,7 @@ clean: clean-skynet
 
 
 # 3rd
+.PHONY: 3rd
 all: 3rd
 
 linux: CFLAGS = -g3 -O2 -rdynamic -Wall -Iskynet/3rd/lua -Iskynet/skynet-src
@@ -74,6 +75,7 @@ CSERVICE_TARGET=$(patsubst %, $(CSERVICE_DIR)/%.so, $(CSERVICE))
 3rd: $(CLUALIB_TARGET) \
 	$(CSERVICE_TARGET)
 
+# lua cjson ####################################
 CJSON_SOURCE=3rd/lua-cjson/lua_cjson.c \
 	3rd/lua-cjson/strbuf.c \
 	3rd/lua-cjson/fpconv.c
@@ -84,8 +86,10 @@ CJSON_SOURCE=3rd/lua-cjson/lua_cjson.c \
 $(CLUALIB_DIR)/cjson.so: $(CJSON_SOURCE)
 	gcc $(CFLAGS) -I3rd/lua-cjson $(SHARED) $^ -o $@ $(LDFLAGS)
 
-# lua profile
-LUAPROFILE_SOURCE=3rd/luaprofile/imap.c 3rd/luaprofile/profile.c 3rd/luaprofile/icallpath.c
+# lua profile ####################################
+LUAPROFILE_SOURCE=3rd/luaprofile/imap.c \
+	3rd/luaprofile/profile.c \
+	3rd/luaprofile/icallpath.c
 
 3rd/luaprofile/imap.c:
 	git submodule update --init 3rd/luaprofile
@@ -94,6 +98,13 @@ $(CLUALIB_DIR)/profile.so: $(LUAPROFILE_SOURCE)
 	#gcc $(CFLAGS) $(SHARED) -lprofiler -DUSE_EXPORT_NAME -DUSE_RDTSC $^ -o $@
 	gcc $(CFLAGS) $(SHARED) -DUSE_EXPORT_NAME -DUSE_RDTSC $^ -o $@
 
-# clean
+# vue ####################################
+.PHONY: vue
+build_vue:
+	cd vue && npm install
+	# export NODE_OPTIONS=--openssl-legacy-provider
+	cd vue && npm run build
+
+# clean ####################################
 clean:
 	-rm -rf $(BUILD_DIR)

README.md

@@ -1,30 +1,219 @@
 # swt
 skynet 火焰图 flamegraph + debug, 运行过程中随时启停profiler,方便调试线上问题
 
+## 架构设计
+![Alt text](./doc/images/architecture.png)
+* 1个master服务：负责收集各个agent上报的profiler数据、提供admin网页服务；部署在某个中心（管理）进程上（ 如monitor 管理进程）
+* 多个agent服务：负责收集所在节点的各个服务的profiler数据，并进行上报；部署在各个功能逻辑进程上（ 如game-1、game-2、game-3...）
+
+## 使用示例
+* 以下示例中，都是以 admin 和 vue 的共同目录作为【根目录】即【根目录】
+* samples/monitor 为monitor进程，维护了 swt/master 服务
+* samples/game-1 为功能逻辑进程（可多开为game-2/3)， 维护了以下内容：
+    * swt/agent 服务, 用于上报profiler到 monitor/master 服务
+    * bar 服务，消耗cpu和内存，用于后续火焰图展示
+    * foo 服务，消耗cpu和内存，用于后续火焰图展示
+* 启动 samples/game-1:
+    ```sh
+    ./build/skynet ./samples/game-1/config
+    ```
+    将会显示如下输出：
+    ```txt
+    [:00000002] LAUNCH snlua bootstrap
+    [:00000003] LAUNCH snlua launcher
+    [:00000004] LAUNCH snlua cdummy
+    [:00000005] LAUNCH harbor 0 4
+    [:00000006] LAUNCH snlua datacenterd
+    [:00000007] LAUNCH snlua service_mgr
+    [:00000008] LAUNCH snlua main
+    [:00000009] LAUNCH snlua swt/agent
+    swt/agent start listening at 0.0.0.0:10001...
+    [:0000000a] LAUNCH snlua bar
+    bar service started
+    [:0000000b] LAUNCH snlua foo
+    foo service started
+    [:00000002] KILL self
+    ```
+    * 表明在当前机器上的 10001 端口开启了 swt/agent 功能，本例为 `192.168.3.9:10001`
+    * 后续在admin管理页面对该 地址进行注册 以 关注 game-1 的profiler
+* 启动 samples/monitor:
+    ```sh
+    ./build/skynet ./samples/monitor/config 
+    ```
+    将会显示如下输出：
+    ```txt
+    [:00000002] LAUNCH snlua bootstrap
+    [:00000003] LAUNCH snlua launcher
+    [:00000004] LAUNCH snlua cdummy
+    [:00000005] LAUNCH harbor 0 4
+    [:00000006] LAUNCH snlua datacenterd
+    [:00000007] LAUNCH snlua service_mgr
+    [:00000008] LAUNCH snlua main
+    [:00000009] LAUNCH snlua swt/master
+    [:00000002] KILL self
+    swt/master start listening at 0.0.0.0:9527...
+    ```
+    表明在当前机器上的 9527端口开启了 swt/master 功能
+* 访问 `http://<monitor>:9527/admin` 进入admin管理页面，进行agent管理， 本例为 `http://192.168.3.9:9527/admin`
+    ![Alt text](./doc/images/dashboard-empty.png)
+* 在 `dashboard#dashboard` 分页，在输入框添加 game-1/agent地址（本例为 192.168.3.9:10001）并提交，即可以获取显示该节点的信息，包含节点类型、节点名称、地址和状态（具体的数据流可查阅 `doc/火焰图swt框架.xls/dashboard#注册agent`）：
+![Alt text](./doc/images/dashboard-game-1.png)
+
+* `dashboard#profiler` 性能监控
+    * 在 `dashboard#profiler` 分页，选择【节点类型】【类型名称】【服务】会显示出这个服务的信息（具体的数据流程可查阅 `doc/火焰图swt框架.xls/profiler#获取节点的服务列表`）:
+    ![Alt text](./doc/images/profiler-select-services.png)
+
+    * 调整进行监控的时长，点击【开始】按钮，即可以让所选择的服务马上开始监控，时间达到时自动结束监控(具体的数据流程可查阅 `doc/火焰图swt框架.xls/profiler#对节点的服务进行profiler`)：
+    ![Alt text](./doc/images/profiler-start.png)
+
+    * 在监控结束后，`game-1/agent` 服务自动上报profiler结果到 `monitor/master`, 然后更新到 profiler页面上，此时服务行的【CPU】和【MEM】按钮变为可选状态：
+    ![Alt text](./doc/images/profiler-stoped.png)
+    点击【CPU】按钮，可以查看到【函数调用关系和时长】的火焰图：
+    ![Alt text](./doc/images/profiler-show-cpu.png)
+    在解析这个图前，先来看看 game-1/bar 服务做了什么：
+        ```lua
+        local skynet    = require "skynet"
+
+        local function bar_short()
+            local sum = 0
+            for k = 1, 10000 do
+                for h = 1, 10000 do
+                    sum = sum + 1
+                end
+            end
+        end
+
+        local function bar_long()
+            for k = 1, 5 do
+                bar_short()
+            end
+        end
+
+        local function bar_sub()
+            local sum = 0
+            for k = 1, 10000 do
+                for h = 1, 10000 do
+                    sum = sum + 1
+                end
+            end
+            bar_short()
+            bar_long()
+        end
+
+        local function bar_main()
+            while true do
+                local tb = {}
+                for k = 1, 10000 do
+                    tb[#tb+1] = k
+                end
+                bar_sub()
+                skynet.sleep(100)
+            end
+        end
+
+        skynet.start(function ()
+            print("bar service started")
+            skynet.fork(bar_main)
+        end)
+
+        ```
+        主要是在 bar_main() 调用了长耗时的 bar_long() 和 短耗时的bar_short()
+        在结合火焰图可以看出，bar_long() 的时长为 bar_short() 的5倍，和代码一样；而bar_long() 和 bar_short() 的上一层 bar_main() 则耗时更长一些，因为还有其他逻辑需要跑cpu
+    【MEM】也类似的情况。
+
+* `bashboard#debug` 对服务发起调试
+如下图，选择 debug分页，选择好服务，例如foo服务，输入调试脚本内容，执行，最后可以在【结果栏】看到结果（具体的数据流程可查阅 `doc/火焰图swt框架.xls/debug#服务调试` ）
+![Alt text](./doc/images/debug-run-result.png)
 
 ## 使用说明
-* 确认skynet版本是否一至,有一点[修改](https://github.com/lsg2020/skynet/commit/4ace42e80814abfff6b8e64335061a206c674f96)
-* 引入调试命令 `SWT_RUN` 让服务支持debug脚本执行
-    * 配置 `preload = "./lualib/swt/debug.lua"`
-    * 或者在服务启动时 `require "swt.debug"`
-* 启动 master 节点
-``` lua
-local swt       = require "swt"
-swt.start_master("0.0.0.0:9527") -- 监听地址
-```
+* 以 admin 和 vue 的共同目录作为【根目录】即【根目录】
+* 不管是 master 还是 agent，都依赖于skynet框架，在启动master和agent前，需要确保skynet已经构建完成
+* master 说明：
+    1. 对skynet并无版本要求
+    2. 依赖于vue做 admin 管理页面
+* agent 说明：
+    1. 使用 【luaprofile】进行性能监控：https://github.com/wilsonloo/luaprofile.git
+    2. 使用 skynet 的定制版本：https://github.com/wilsonloo/skynet/commit/536e6b8624ccac56680ff49b7de1882eb857c79c，请确定版本是否一致；
+        * 目的是为了和  【luaprofile】 配套使用；
+        * 可以cherry-pick 这个skynet的commit，也可以手抄到自己所在项目代码里
 
-* 启动 agent节点
-``` lua
-local swt       = require "swt"
-swt.start_agent("app", "node1", "127.0.0.1:9527") -- 类型名,节点名,master连接地址
+## 如何构建
+```sh
+    git clone 本项目 swt
+    cd swt
+    make
 ```
+将会编译出以下内容：
+* `build/skynet`
+* `build/clualib/cjson.so` # agent/master 数据交使用
+* `build/clualib/profile.so` # agent 进行性能监控使用
+
+## swt/master 相关
+* swt/master 有两部分内容：【admin管理页面】和 【profile收集器】
+* 第一种启动方式，【admin管理页面】和 【profile收集器】由同一个addr管理，如 "0.0.0.0:9527"
+    * 可以在app内开启swt/master 服务：
+    ``` lua
+        local swt = require "swt"
+        swt.start_master("0.0.0.0:9527") -- 监听地址
+    ```
+
+    * 也可以参考 samples/monitor/config 配置, `SWT_MASTER_PORT` 设置为 swt/master 后台的端口，例如 9527:
+    ```sh
+        ./build/skynet samples/monitor/config
+    ```
+
+    * 要注意的是，这种方式的启动，需要将工作目录定位到 【根目录】，因为这种方式是采用 static加载 admin/index.html
+    * 启动成功后即可 进入管理界面，请查看前面的示例
+
+* 第二种启动方式，将【admin管理页面】和 【profile收集器】分开启动
+    * 【profile收集器】还是和第一种的启动方式，注意工作目录
+    * 【admin管理页面】则通过 npm run 方式启动：
+    ```sh
+        # 如果启动失败，请看下面的两个注意点
+        cd vue && npm run serve
+    ```
+    这是根据 npm 的启动提示，一般会有提示在 8080 开启了admin管理页面
+    * 第一个注意点：为了让 admin(8080) 能够 和 【profile收集器】进行交互， 需要修改 vue/.env 的`VUE_APP_BASE_API` 设置为 【profile收集器】的地址:
+    ```sh
+        VUE_APP_BASE_API = 'http://<实际的对外ip>:9527'
+    ```
+    * 第二个注意点：如果 `npm run serve` 启动失败，活着对admin页面有进行修改，则需进行重新构建：
+    ```sh
+        # 只需要执行一次，用于初始化vue所需的各种依赖库
+        cd vue && npm install
+
+        # 如果npm run build 时出现 ERR_OSSL_EVP_UNSUPPORTED 报错问题，还是需要进行export:
+        # export NODE_OPTIONS=--openssl-legacy-provider
+        cd vue && npm run build
+    ```
+
+## swt/agent 相关
+* profiler 的运行原理是通过inject方式 往服务里添加 start_profiler 和 end_profiler。
+  服务需要对 `prototype=debug， cmd=SWT_RUN` 进行注册，一种注册方式是在skynet的config文件里添加proload设置，这样每个服在创建时就会自动进行协议注册，例如：
+  ```lua
+    preload = "../lualib/sfg/debug.lua"
+    -- 或者在服务启动时 require "swt.debug"
+  ```    
+
+* 启动 swt/agent节点
+    ``` lua
+    local swt = require "swt"
 
-* 进入管理界面 `http://127.0.0.1:9527/admin`
+    -- 类型名,节点名, 暴露给master连接的地址
+    swt.start_agent("game-app", "game-1", "0.0.0.0:10001") 
+    ```
 
-## 示例
-* `make`
-* 启动`./build/skynet ./config`
-* 进入`http://127.0.0.1:9527/admin`
+    也可以参考 `samples/game-1/config` 配置:
+    ```lua
+        -- samples/game-1/config:
+        SFG_NODE_TYPE = "game-app" -- 类型名
+        SFG_NODE_NAME = "game-1" -- 节点名
+        SFG_AGENT_PORT = 10001 -- 暴露给master连接的地址
+    ```
+    再进行启动:
+    ```sh
+        ./build/skynet samples/game-1/config
+    ```
 
 ## 展示 
 ![cpuprofile](https://github.com/lsg2020/swt/blob/master/doc/images/cpuprofiler3.png)

admin/index.html

@@ -1 +1 @@
-<!DOCTYPE html><html lang=en><head><meta charset=utf-8><meta http-equiv=X-UA-Compatible content="IE=edge"><meta name=viewport content="width=device-width,initial-scale=1"><!--[if IE]><link rel="icon" href="/admin/favicon.ico"><![endif]--><title>Vue Typescript Admin</title><link href=/admin/css/404.04075428.css rel=prefetch><link href=/admin/css/login.e330e60a.css rel=prefetch><link href=/admin/js/404.c5fe2fdd.js rel=prefetch><link href=/admin/js/Debug.9db52dac.js rel=prefetch><link href=/admin/js/Debug~Profiler.c373001c.js rel=prefetch><link href=/admin/js/Profiler.61d29cbe.js rel=prefetch><link href=/admin/js/dashboard.0676f976.js rel=prefetch><link href=/admin/js/login.e0a84561.js rel=prefetch><link href=/admin/css/app.b428ed95.css rel=preload as=style><link href=/admin/css/chunk-vendors.ee57d822.css rel=preload as=style><link href=/admin/js/app.646d23d6.js rel=preload as=script><link href=/admin/js/chunk-vendors.08c8f398.js rel=preload as=script><link href=/admin/css/chunk-vendors.ee57d822.css rel=stylesheet><link href=/admin/css/app.b428ed95.css rel=stylesheet><link rel=icon type=image/png sizes=32x32 href=/admin/img/icons/favicon-32x32.png><link rel=icon type=image/png sizes=16x16 href=/admin/img/icons/favicon-16x16.png><link rel=manifest href=/admin/manifest.json><meta name=theme-color content=#4DBA87><meta name=apple-mobile-web-app-capable content=no><meta name=apple-mobile-web-app-status-bar-style content=default><meta name=apple-mobile-web-app-title content="Vue Typescript Admin"><link rel=apple-touch-icon href=/admin/img/icons/apple-touch-icon-152x152.png><link rel=mask-icon href=/admin/img/icons/safari-pinned-tab.svg color=#4DBA87><meta name=msapplication-TileImage content=/admin/img/icons/msapplication-icon-144x144.png><meta name=msapplication-TileColor content=#000000></head><body><noscript><strong>We're sorry but Vue Typescript Admin doesn't work properly without JavaScript enabled. Please enable it to continue.</strong></noscript><div id=app></div><script src=/admin/js/chunk-vendors.08c8f398.js></script><script src=/admin/js/app.646d23d6.js></script></body></html>
+<!DOCTYPE html><html lang=en><head><meta charset=utf-8><meta http-equiv=X-UA-Compatible content="IE=edge"><meta name=viewport content="width=device-width,initial-scale=1"><!--[if IE]><link rel="icon" href="/admin/favicon.ico"><![endif]--><title>Vue Typescript Admin</title><link href=/admin/css/404.04075428.css rel=prefetch><link href=/admin/css/login.e330e60a.css rel=prefetch><link href=/admin/js/404.664e2db3.js rel=prefetch><link href=/admin/js/Debug.0448e9be.js rel=prefetch><link href=/admin/js/Debug~Profiler.a751b36f.js rel=prefetch><link href=/admin/js/Profiler.ab06ab79.js rel=prefetch><link href=/admin/js/dashboard.97c33c99.js rel=prefetch><link href=/admin/js/login.d582cda5.js rel=prefetch><link href=/admin/css/app.b428ed95.css rel=preload as=style><link href=/admin/css/chunk-vendors.ee57d822.css rel=preload as=style><link href=/admin/js/app.5499a6d7.js rel=preload as=script><link href=/admin/js/chunk-vendors.d14d9218.js rel=preload as=script><link href=/admin/css/chunk-vendors.ee57d822.css rel=stylesheet><link href=/admin/css/app.b428ed95.css rel=stylesheet><link rel=icon type=image/png sizes=32x32 href=/admin/img/icons/favicon-32x32.png><link rel=icon type=image/png sizes=16x16 href=/admin/img/icons/favicon-16x16.png><link rel=manifest href=/admin/manifest.json><meta name=theme-color content=#4DBA87><meta name=apple-mobile-web-app-capable content=no><meta name=apple-mobile-web-app-status-bar-style content=default><meta name=apple-mobile-web-app-title content="Vue Typescript Admin"><link rel=apple-touch-icon href=/admin/img/icons/apple-touch-icon-152x152.png><link rel=mask-icon href=/admin/img/icons/safari-pinned-tab.svg color=#4DBA87><meta name=msapplication-TileImage content=/admin/img/icons/msapplication-icon-144x144.png><meta name=msapplication-TileColor content=#000000></head><body><noscript><strong>We're sorry but Vue Typescript Admin doesn't work properly without JavaScript enabled. Please enable it to continue.</strong></noscript><div id=app></div><script src=/admin/js/chunk-vendors.d14d9218.js></script><script src=/admin/js/app.5499a6d7.js></script></body></html>