Skip to content

[HUDI-1186][DOC] Add description of write commit callback by kafka to document#1974

Merged
yanghua merged 3 commits intoapache:asf-sitefrom
wangxianghu:HUDI-1186
Aug 22, 2020
Merged

[HUDI-1186][DOC] Add description of write commit callback by kafka to document#1974
yanghua merged 3 commits intoapache:asf-sitefrom
wangxianghu:HUDI-1186

Conversation

@wangxianghu
Copy link
Contributor

Tips

What is the purpose of the pull request

Add description of write commit callback by kafka to document

Brief change log

(for example:)

  • Modify AnnotationLocation checkstyle rule in checkstyle.xml

Verify this pull request

(Please pick either of the following options)

This pull request is a trivial rework / code cleanup without any test coverage.

(or)

This pull request is already covered by existing tests, such as (please describe tests).

(or)

This change added tests and can be verified as follows:

(example:)

  • Added integration tests for end-to-end.
  • Added HoodieClientWriteTest to verify the change.
  • Manually verified the change by running a job locally.

Committer checklist

  • Has a corresponding JIRA in PR title & commit

  • Commit message is descriptive of the change

  • CI is green

  • Necessary doc changes done or have another open PR

  • For large changes, please consider breaking it into sub-tasks under an umbrella JIRA.

@wangxianghu
Copy link
Contributor Author

@yanghua please review this after #1886 is merged

@wangxianghu wangxianghu changed the title [HUDI-1186]Add description of write commit callback by kafka to document [HUDI-1186][DOC]Add description of write commit callback by kafka to document Aug 17, 2020
@yanghua yanghua self-assigned this Aug 18, 2020
@yanghua yanghua self-requested a review August 18, 2020 00:35
Copy link
Contributor

@yanghua yanghua left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wangxianghu Thanks for your contribution. Left some comments.


### 写提交回调配置
控制写提交的回调。 如果用户启用了回调并且回调过程发生了错误,则会抛出异常。 当前只支持Http回调方式,Kafka不久后会支持
控制写提交的回调。 如果用户启用了回调并且回调过程发生了错误,则会抛出异常。 当前只支持 Http, Kafka 两种回调方式
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we remove ? And Http -> HTTP?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we remove ? And Http -> HTTP?

done

##### withCallbackClass(callbackClass) {#withCallbackClass}
Property: `hoodie.write.commit.callback.class` <br/>
<span style="color:grey">用户自定义回调的类全路径名,回调类必须为HoodieWriteCommitCallback的子类。默认 org.apache.hudi.callback.impl.HoodieWriteCommitHttpCallback</span>
<span style="color:grey">回调类全路径名,回调类必须为HoodieWriteCommitCallback的子类。默认 org.apache.hudi.callback.impl.HoodieWriteCommitHttpCallback</span>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

回调类全路径名 -> 回调类的完全限定名 and 必须为HoodieWriteCommitCallback的子类 -> 必须实现HoodieWriteCommitCallback接口

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

回调类全路径名 -> 回调类的完全限定名 and 必须为HoodieWriteCommitCallback的子类 -> 必须实现HoodieWriteCommitCallback接口

done


##### CALLBACK_KAFKA_TOPIC
Property: `hoodie.write.commit.callback.kafka.topic` <br/>
<span style="color:grey">发送回调信息的主题</span>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

主题 -> topic

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

主题 -> topic

done


### 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.
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, kafka type only.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove only.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove only.

done

Copy link
Contributor

@yanghua yanghua left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One minor issue.


#### HoodieWriteCommitHttpCallback
#### HTTP CALLBACK
Callback via http, User does not need to specify this way explicitly, it is the default type.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

http -> HTTP

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

http -> HTTP

done

Copy link
Contributor

@yanghua yanghua left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wangxianghu Thanks for addressing my concern. LGTM now.

@yanghua yanghua changed the title [HUDI-1186][DOC]Add description of write commit callback by kafka to document [HUDI-1186][DOC] Add description of write commit callback by kafka to document Aug 22, 2020
@yanghua yanghua merged commit ce51638 into apache:asf-site Aug 22, 2020
@wangxianghu wangxianghu deleted the HUDI-1186 branch August 28, 2020 10:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants