Skip to content

Commit

Permalink
optimize doc
Browse files Browse the repository at this point in the history
  • Loading branch information
yangjing committed Dec 31, 2020
1 parent 1451f2b commit 5cdbf44
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 3 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,9 @@ replayer-agent/agent
replayer-agent/replayer-agent
replayer-agent/agent.log
replayer-agent/agent.pid
replayer-agent/conf.tar
replayer-agent/template.tar
replayer-agent/replayer-agent.linux
replayer-agent/replayer-agent.mac

vendor/
6 changes: 3 additions & 3 deletions doc/recorder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ cd /path/to/your/project
go build -tags="recorder_grpc"
```

注意,此处tag值是 "recorder_grpc"。
注意,此处tag值是 **"recorder_grpc"**

<br>

Expand All @@ -135,9 +135,9 @@ grpc server的其他录制操作,同 上面http server标准录制流程的1-4
>对于使用grpc-server做PHP转GO的模块,跨语言流量回放是支持的。
replayer-agent已经支持 [grpc server回放](../replayer/README.md#2.2-grpc-server)回放时replayer-agent将fastcgi转为http协议回放
replayer-agent已经支持 [grpc server回放](../replayer/README.md#22-grpc-server)回放时,replayer-agent自动识别inbound的fastcgi协议,并转为http协议后进行回放

grpc server框架流量:http协议→ grpc-gateway→ grpc协议→grpc server.
grpc server框架流量链路:http协议→ grpc-gateway→ grpc协议→grpc server.

因此,对于使用http协议,且基于grpc-gateway的模块,跨语言回放不受影响。

Expand Down
2 changes: 2 additions & 0 deletions doc/replayer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ wget https://github.com/didi/sharingan/releases/download/replayer-agent%2Fv1.3.0
```
最新版本请查看 [releases](https://github.com/didi/sharingan/releases)

将上步wget的bin文件与 [replayer-agent/conf](https://github.com/didi/sharingan/releases/download/replayer-agent%2Fv1.3.0/conf.tar)[replayer-agent/template](https://github.com/didi/sharingan/releases/download/replayer-agent%2Fv1.3.0/template.tar) 放到一个目录下,启动bin文件即可。

##### 编译安装
首先,确保本地存在go环境(官方或定制版均可,且版本无要求), 并根据本地go版本选择go mod或glide来安装sharingan的依赖。
```shell script
Expand Down
2 changes: 2 additions & 0 deletions replayer-agent/compile
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
GOOS=linux GOARCH=amd64 go build -o ./replayer-agent.linux main.go
GOOS=darwin GOARCH=amd64 go build -o ./replayer-agent.mac main.go

0 comments on commit 5cdbf44

Please sign in to comment.