diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000000000000000000000000000000000000..24a8e87939aa53cdd833f6be7610cb4972e063ad --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +*.png filter=lfs diff=lfs merge=lfs -text diff --git a/docs/images/logproxy-client-workflow.png b/docs/images/logproxy-client-workflow.png new file mode 100644 index 0000000000000000000000000000000000000000..76b8ed5f7c12414f0162664d084867872ec6ccb3 --- /dev/null +++ b/docs/images/logproxy-client-workflow.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ae573db88f9c517809951ff3df273fafe1ede81a213b2840338fff74dff9d072 +size 53062 diff --git a/docs/quickstart/logproxy-client-tutorial.md b/docs/quickstart/logproxy-client-tutorial.md index 75bfc9aa086ff3e07bdad822d3dbdd79f3c15c79..7cc5434f05102f6e325ee963905d0283f071a637 100644 --- a/docs/quickstart/logproxy-client-tutorial.md +++ b/docs/quickstart/logproxy-client-tutorial.md @@ -47,6 +47,12 @@ If you'd rather like the latest snapshots of the upcoming major version, use our ``` +## Workflow + +![image](../images/logproxy-client-workflow.png) + +When `LogProxyClient.start()` is executed, a new thread will be created in `ClientStream`. The thread will initialize a netty channel which will receive log data from LogProxy and put the data as `TransferPacket` to a BlockingQueue. When the netty connection is established, the thread will poll the queue and pass the `LogMessage` in TransferPacket to `RecordListener.notify`. + ## Usage ### Basic Usage