From 359cff34798e025863903ae460ee8f87a4c7f984 Mon Sep 17 00:00:00 2001 From: He Wang Date: Fri, 31 Dec 2021 14:38:04 +0800 Subject: [PATCH] add workflow desc in logproxy-client-tutorial.md (#19) * add logproxy-client workflow pic * add workflow desc in logproxy-client-tutorial.md --- .gitattributes | 1 + docs/images/logproxy-client-workflow.png | 3 +++ docs/quickstart/logproxy-client-tutorial.md | 6 ++++++ 3 files changed, 10 insertions(+) create mode 100644 .gitattributes create mode 100644 docs/images/logproxy-client-workflow.png diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..24a8e87 --- /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 0000000..76b8ed5 --- /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 75bfc9a..7cc5434 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 -- GitLab