README_zh.md
1# SmartPerf 编译指导
2
3
4## 1. 编译环境搭建:
5 注意:在linux编译环境安装时以root或者其他 sudo 用户身份运行下面的命令
6### 1.1 node 环境安装:
7##### 1.1.1 下载Node js安装包(windows推荐, linux跳过此步骤)
8 从网站 下载node js安装包 https://nodejs.org/en/download/current/
9##### 1.1.2 安装nodejs.
10- ubuntu 20.04 与Debian 11系统中, 直接用apt-get安装,命令如下:
11```
12 先切换到 root用户下 sudo su
13 apt-get update
14 apt-get install nodejs npm
15```
16
17- centos 系统中 使用yum 安装，命令如下：
18```
19 先切换到 root用户下 sudo su
20 sudo yum -y install nodejs npm
21```
22
23- windows系统中, 用安装包一路next即可:
24
25
26- 安装完成后运行检查是否安装成功:
27```
28 node -v
29 npm -v
30```
31 出现版本号就代表安装成功了.
32
33##### 1.1.3 安装tsc typeScript 编译器
34
35- 直接使用npm 安装运行命令:
36```
37npm install -g typescript
38
39备注：如果安装失败可以更换npm源,再次尝试.
40验证安装完成:
41 tsc -v
42```
43### 1.2 go 编译环境安装:
44- ubuntu 环境下直接使用apt安装:
45```
46 apt-get install golang-go
47```
48- centos 系统中 使用yum 安装，命令如下：
49
50```
51先切换到 root用户下 sudo su
52
53 sudo yum -y install go
54```
55- windows 系统请自行下载安装包并完成安装。
56
57- 安装完成后 命令行运行验证是否安装成功：
58
59```
60 go version
61```
62## 2. 项目编译:
63#### 2.1 先下载sql.js的二进制包,:
64 从如下 https://github.com/sql-js/sql.js/releases/download/v1.6.2/sqljs-all.zip 获取到sql.js的二进制包.
65 将压缩包解压后, 将文件放置到项目third-party 目录下.
66
67
68#### 2.2 先编译获取trace_streamer 的二进制包:
69 参照:smartperf/trace_streamer/compile_trace_streamer.md 编译出wasm 、linux、Windows版本的二进制文件
70 将获取到二进制文件放入到项目bin目录下,如果项目目录中无bin目录 先创建bin目录.
71 然后将trace_streamer的二进制文件放入bin目录中.
72
73
74#### 2.3 代码编译(依赖于上面node环境 和 go环境)
75 1) 在项目目录安装项目依赖:
76 npm install
77 2) 在项目目录下运行命令:
78 npm run compile
79 编译成功后会有main 可执行文件生成
80
81## 3. 项目部署:
82 1. linux 版本部署需要给trace_stream程序赋予执行权限:
83 cd dist/bin 目录下,执行 chmod +x trace_streamer_*
84
85 直接运行 ./main 可执行程序,完成项目的部署;
86
87 ## 4. 访问项目:
88 在浏览器上打开 https://[部署机器ip地址]:9001/application/
89 !!! 注意一定是https.
90
91 备注：如果未出现如图所示网页.而是显示 无法访问此网站
92 可以在window cmd 里执行telnet [部署机器ip地址] 9001
93 如果显示端口连接失败 可能是防火墙未对9001 端口放开即可
94