Skip to content

Commit

Permalink
[GUI][DOC] Update client page for GUI (#1364)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jui-Yu-Hsieh authored Dec 30, 2022
1 parent 19aaac5 commit c64f497
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 10 deletions.
34 changes: 24 additions & 10 deletions docs/gui/client/README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,41 @@
### client

`client` 頁面提供您查詢 `consumer` `producer` `transaction` 的資訊
`client` 頁面提供您:
* 查詢 `consumer` `producer` `transaction` 的資訊。
* 使用`read`頁面來查看讀取數據的狀況
* 使用`write`頁面來寫入 `Key\Value` 數據到指定的`topic``partition`

- [consumer](#consumer)
- [read](#read)
- [producer](#producer)
- [write](#write)
- [transaction](#transaction)

## consumer

`consumer` 提供您查詢 consumer groups 的資訊,預設搜尋所有 consumer,您可以透過搜尋欄位過濾 `group id` 或是 `topic 名稱`,如下圖是顯示有訂閱 tina 的 consumers

`consumer` 提供您查詢 consumer 的資訊
* 可以透過搜尋欄,增加查詢條件(支援Regex)
![client_consumer](client_consumer.png)

## producer
## read
`read` 提供您資料寫入 `topic``partition` 的狀況
* 可以透過搜尋欄,增加查詢條件(支援Regex)
* records:預期取得多少幾筆資料
* timeout:可以等待多久時間(直到資料回傳)
![client_read](client_read.png)

`producer` 提供您查詢 producer 的資訊,預設搜尋所有 producer,您可以透過搜尋欄位過濾 `topic 名稱`,如下圖示顯示有寫資料到 tina 的 producers
## producer

**注意:只有idempotent producer 的資訊可供查詢**
`producer` 提供您查詢 producer 的資訊
* 可以透過搜尋欄,增加查詢條件(支援Regex)

***注意:只有 idempotent producer 的資訊可供查詢** ([Idempotent Producer介紹](https://kafka.apache.org/documentation/#producerconfigs_enable.idempotence))
![client_producer](client_producer.png)

## transaction

`transaction` 提供您查詢 transaction 的資訊,預設搜尋所有 transaction,您可以透過搜尋欄位過濾 `topic 名稱`或是 `transaction id` ,如下圖是顯示有涉及 tina 的交易狀態
## write
`write` 提供您單筆 `Key\Value` 寫入指定的`topic``partition`
![client_producer](client_write.png)

## transaction
`transaction` 提供您查詢 transaction 的資訊
* 可以透過搜尋欄,增加查詢條件(支援Regex)
![client_transaction](client_transaction.png)
Binary file modified docs/gui/client/client_consumer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/gui/client/client_producer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gui/client/client_read.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/gui/client/client_transaction.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gui/client/client_write.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c64f497

Please sign in to comment.