[hudi] branch asf-site updated: [HUDI-1121] Provide a document describing how to use callback (#1935)

[vinoyang]

This is an automated email from the ASF dual-hosted git repository.

vinoyang pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/hudi.git


The following commit(s) were added to refs/heads/asf-site by this push:
     new a6f991c  [HUDI-1121] Provide a document describing how to use callback 
(#1935)
a6f991c is described below

commit a6f991c4c2d72166fe8c898b6f63bb1d16ccd7a0
Author: Mathieu <wxhj...@126.com>
AuthorDate: Tue Aug 11 09:59:27 2020 +0800

    [HUDI-1121] Provide a document describing how to use callback (#1935)
---
 docs/_docs/2_4_configurations.cn.md | 27 +++++++++++++++++++++++++++
 docs/_docs/2_4_configurations.md    | 27 +++++++++++++++++++++++++++
 2 files changed, 54 insertions(+)

diff --git a/docs/_docs/2_4_configurations.cn.md 
b/docs/_docs/2_4_configurations.cn.md
index b577990..8578285 100644
--- a/docs/_docs/2_4_configurations.cn.md
+++ b/docs/_docs/2_4_configurations.cn.md
@@ -547,3 +547,30 @@ Hudi提供了一个选项，可以通过将对该分区中的插入作为对现
 #### withWriteStatusFailureFraction(failureFraction = 0.1) 
{#withWriteStatusFailureFraction}
 属性：`hoodie.memory.writestatus.failure.fraction` <br/>
 <span style="color:grey">此属性控制报告给驱动程序的失败记录和异常的比例</span>
+
+### 写提交回调配置
+控制写提交的回调。 如果用户启用了回调并且回调过程发生了错误，则会抛出异常。 当前只支持Http回调方式，Kafka不久后会支持。
+[withCallbackConfig](#withCallbackConfig) (HoodieWriteCommitCallbackConfig) 
<br/>
+<span style="color:grey">写提交回调相关配置</span>
+
+##### writeCommitCallbackOn(callbackOn = false) {#writeCommitCallbackOn} 
+Property: `hoodie.write.commit.callback.on` <br/>
+<span style="color:grey">打开或关闭回调功能. 默认关闭.</span>
+
+##### withCallbackClass(callbackClass) {#withCallbackClass} 
+Property: `hoodie.write.commit.callback.class` <br/>
+<span style="color:grey">用户自定义回调的类全路径名，回调类必须为HoodieWriteCommitCallback的子类。默认 
org.apache.hudi.callback.impl.HoodieWriteCommitHttpCallback</span>
+
+#### HoodieWriteCommitHttpCallback
+
+##### withCallbackHttpUrl(url) {#withCallbackHttpUrl} 
+Property: `hoodie.write.commit.callback.http.url` <br/>
+<span style="color:grey">Http回调主机，回调信息将会发送到该主机</span>
+
+##### withCallbackHttpTimeoutSeconds(timeoutSeconds = 3) 
{#withCallbackHttpTimeoutSeconds} 
+Property: `hoodie.write.commit.callback.http.timeout.seconds` <br/>
+<span style="color:grey">Http回调超时时间（单位秒），默认3秒</span>
+
+##### withCallbackHttpApiKey(apiKey) {#withCallbackHttpApiKey} 
+Property: `hoodie.write.commit.callback.http.api.key` <br/>
+<span style="color:grey">Http 回调秘钥. 默认 hudi_write_commit_http_callback</span>
diff --git a/docs/_docs/2_4_configurations.md b/docs/_docs/2_4_configurations.md
index 627d148..47bd08c 100644
--- a/docs/_docs/2_4_configurations.md
+++ b/docs/_docs/2_4_configurations.md
@@ -510,3 +510,30 @@ Property: `hoodie.memory.compaction.fraction` <br/>
 #### withWriteStatusFailureFraction(failureFraction = 0.1) 
{#withWriteStatusFailureFraction}
 Property: `hoodie.memory.writestatus.failure.fraction` <br/>
 <span style="color:grey">This property controls what fraction of the failed 
record, exceptions we report back to driver</span>
+
+### Write commit callback configs
+Controls callback behavior on write commit. Exception will be thrown if user 
enabled the callback service and errors occurred during the process of 
callback. Currently support http callback only, kafka implementation will be 
supported in the near future. 
+[withCallbackConfig](#withCallbackConfig) (HoodieWriteCommitCallbackConfig) 
<br/>
+<span style="color:grey">Callback related configs</span>
+
+##### writeCommitCallbackOn(callbackOn = false) {#writeCommitCallbackOn} 
+Property: `hoodie.write.commit.callback.on` <br/>
+<span style="color:grey">Turn callback on/off. off by default.</span>
+
+##### withCallbackClass(callbackClass) {#withCallbackClass} 
+Property: `hoodie.write.commit.callback.class` <br/>
+<span style="color:grey">Full path of user-defined callback class and must be 
a subclass of HoodieWriteCommitCallback class, 
org.apache.hudi.callback.impl.HoodieWriteCommitHttpCallback by default</span>
+
+#### HoodieWriteCommitHttpCallback
+
+##### withCallbackHttpUrl(url) {#withCallbackHttpUrl} 
+Property: `hoodie.write.commit.callback.http.url` <br/>
+<span style="color:grey">Callback host to be sent along with callback 
messages</span>
+
+##### withCallbackHttpTimeoutSeconds(timeoutSeconds = 3) 
{#withCallbackHttpTimeoutSeconds} 
+Property: `hoodie.write.commit.callback.http.timeout.seconds` <br/>
+<span style="color:grey">Callback timeout in seconds. 3 by default</span>
+
+##### withCallbackHttpApiKey(apiKey) {#withCallbackHttpApiKey} 
+Property: `hoodie.write.commit.callback.http.api.key` <br/>
+<span style="color:grey">Http callback API key. 
hudi_write_commit_http_callback by default</span>