You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@kafka.apache.org by "Walenwein. Jakob" <j....@seeburger.de> on 2020/04/09 06:11:32 UTC
Kafka: documentation - reliable reference?
Hello Apache Kafka team,
comparing the 2.4.1 code state of KafkaProducer with documentation, i noticed the following difference:
The „send(record, callback)“ method catches internally the apiException’s and set it into Future-Object.
The callback object handles this exceptions afterwards.
But the documentation states, the send method throws these exceptions (subclasses are: TimeoutException, AuthenticationException..).
Now my question: what is the „reliable reference“ our client code should be based on? (with regard to the future versions of kafka)
Is it the documentation or the implementation ?
It is unclear, if the documentation has a mistake, or it consciously considers the possibility, that any future versions of kafka could
indeed throw an apiException here.
Jacob.
SEEBURGER AG Vorstand/SEEBURGER Executive Board:
Sitz der Gesellschaft/Registered Office: Axel Haas, Michael Kleeberg, Axel Otto, Dr. Martin Kuntz, Matthias Feßenbecker
Edisonstr. 1
D-75015 Bretten Vorsitzende des Aufsichtsrats/Chairperson of the SEEBURGER Supervisory Board:
Tel.: 07252 / 96 - 0 Prof. Dr. Simone Zeuchner
Fax: 07252 / 96 - 2222
Internet: http://www.seeburger.de Registergericht/Commercial Register:
e-mail: info@seeburger.de HRB 240708 Mannheim
Dieses E-Mail ist nur für den Empfänger bestimmt, an den es gerichtet ist und kann vertrauliches bzw. unter das Berufsgeheimnis fallendes Material enthalten. Jegliche darin enthaltene Ansicht oder Meinungsäußerung ist die des Autors und stellt nicht notwendigerweise die Ansicht oder Meinung der SEEBURGER AG dar. Sind Sie nicht der Empfänger, so haben Sie diese E-Mail irrtümlich erhalten und jegliche Verwendung, Veröffentlichung, Weiterleitung, Abschrift oder jeglicher Druck dieser E-Mail ist strengstens untersagt. Weder die SEEBURGER AG noch der Absender (Walenwein. Jakob) übernehmen die Haftung für Viren; es obliegt Ihrer Verantwortung, die E-Mail und deren Anhänge auf Viren zu prüfen.
This email is intended only for the recipient(s) to whom it is addressed. This email may contain confidential material that may be protected by professional secrecy. Any fact or opinion contained, or expression of the material herein, does not necessarily reflect that of SEEBURGER AG. If you are not the addressee or if you have received this email in error, any use, publication or distribution including forwarding, copying or printing is strictly prohibited. Neither SEEBURGER AG, nor the sender (Walenwein. Jakob) accept liability for viruses; it is your responsibility to check this email and its attachments for viruses.
Re: Kafka: documentation - reliable reference?
Posted by Israel Ekpo <is...@gmail.com>.
Hi Jacob,
The Kafka code base is huge and the documentation is also very broad. It is
always likely that you will notice discrepancies between the current
implementation for a specific version of Kafka or ecosystem components when
compared to the reference documentation.
If you notice such issues you can file a JIRA with the evidence or more
importantly, you can create a patch for the documentation and submit it
alongside your JIRA issue.
Check out this page for steps on how you can assist in this effort
https://kafka.apache.org/contributing
Whenever in doubt, always look at what the code is doing and how the CORE
core was implemented.
This should apply to any of the Kafka project code or the code of ecosystem
components.
I hope this helps
On Thu, Apr 9, 2020 at 10:56 AM Walenwein. Jakob <j....@seeburger.de>
wrote:
> Hello Apache Kafka team,
>
> comparing the 2.4.1 code state of KafkaProducer with documentation, i
> noticed the following difference:
>
> The „send(record, callback)“ method catches internally the apiException’s
> and set it into Future-Object.
> The callback object handles this exceptions afterwards.
>
> But the documentation states, the send method throws these exceptions
> (subclasses are: TimeoutException, AuthenticationException..).
>
> Now my question: what is the „reliable reference“ our client code should
> be based on? (with regard to the future versions of kafka)
> Is it the documentation or the implementation ?
> It is unclear, if the documentation has a mistake, or it consciously
> considers the possibility, that any future versions of kafka could
> indeed throw an apiException here.
>
> Jacob.
>
>
>
>
>
>
>
>
> SEEBURGER AG Vorstand/SEEBURGER Executive Board:
> Sitz der Gesellschaft/Registered Office: Axel Haas, Michael
> Kleeberg, Axel Otto, Dr. Martin Kuntz, Matthias Feßenbecker
> Edisonstr. 1
> D-75015 Bretten Vorsitzende des Aufsichtsrats/Chairperson of the
> SEEBURGER Supervisory Board:
> Tel.: 07252 / 96 - 0 Prof. Dr. Simone Zeuchner
> Fax: 07252 / 96 - 2222
> Internet: http://www.seeburger.de
> Registergericht/Commercial Register:
> e-mail: info@seeburger.de HRB 240708 Mannheim
>
>
> Dieses E-Mail ist nur für den Empfänger bestimmt, an den es gerichtet ist
> und kann vertrauliches bzw. unter das Berufsgeheimnis fallendes Material
> enthalten. Jegliche darin enthaltene Ansicht oder Meinungsäußerung ist die
> des Autors und stellt nicht notwendigerweise die Ansicht oder Meinung der
> SEEBURGER AG dar. Sind Sie nicht der Empfänger, so haben Sie diese E-Mail
> irrtümlich erhalten und jegliche Verwendung, Veröffentlichung,
> Weiterleitung, Abschrift oder jeglicher Druck dieser E-Mail ist strengstens
> untersagt. Weder die SEEBURGER AG noch der Absender (Walenwein. Jakob)
> übernehmen die Haftung für Viren; es obliegt Ihrer Verantwortung, die
> E-Mail und deren Anhänge auf Viren zu prüfen.
>
>
> This email is intended only for the recipient(s) to whom it is addressed.
> This email may contain confidential material that may be protected by
> professional secrecy. Any fact or opinion contained, or expression of the
> material herein, does not necessarily reflect that of SEEBURGER AG. If you
> are not the addressee or if you have received this email in error, any use,
> publication or distribution including forwarding, copying or printing is
> strictly prohibited. Neither SEEBURGER AG, nor the sender (Walenwein.
> Jakob) accept liability for viruses; it is your responsibility to check
> this email and its attachments for viruses.
>
>