Uploaded image for project: 'Flink'
  1. Flink
  2. FLINK-7224

Incorrect Javadoc description in all Kafka consumer versions

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 1.3.1, 1.4.0
    • Fix Version/s: 1.4.0, 1.3.2
    • Component/s: Kafka Connector
    • Labels:
      None

      Description

      Currently, all Kafka consumer version still have this in the Javadoc:

      The implementation currently accesses partition metadata when the consumer
      is constructed. That means that the client that submits the program needs to be able to
      reach the Kafka brokers or ZooKeeper.
      

      This is also the case for the documentation:

      The current FlinkKafkaConsumer implementation will establish a connection from the client (when calling the constructor) for querying the list of topics and partitions.
      
      For this to work, the consumer needs to be able to access the consumers from the machine submitting the job to the Flink cluster. If you experience any issues with the Kafka consumer on the client side, the client log might contain information about failed requests, etc.
      

      These statements are no longer true since starting from Flink 1.3. partition metadata happens only in open().

        Issue Links

          Activity

          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user tzulitai opened a pull request:

          https://github.com/apache/flink/pull/4363

          FLINK-7224 [kafka, docs] Fix incorrect Javadoc / docs regarding Kafka partition metadata querying

          Since Flink 1.3, partition metadata is no longer queried on the client
          side. This commit corrects the statements of this legacy behaviour in
          the Javadocs and documentation.

          This should be merged for both `release-1.3` and `master`.

          You can merge this pull request into a Git repository by running:

          $ git pull https://github.com/tzulitai/flink FLINK-7224

          Alternatively you can review and apply these changes as the patch at:

          https://github.com/apache/flink/pull/4363.patch

          To close this pull request, make a commit to your master/trunk branch
          with (at least) the following in the commit message:

          This closes #4363


          commit 8341083005e4de64b5d1b4e1fe2a543975197d02
          Author: Tzu-Li (Gordon) Tai <tzulitai@apache.org>
          Date: 2017-07-19T06:24:27Z

          FLINK-7224 [kafka, docs] Fix incorrect Javadoc / docs regarding Kafka partition metadata querying

          Since Flink 1.3, partition metadata is no longer queried on the client
          side. This commit corrects the statements of this legacy behaviour in
          the Javadocs and documentation.


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user tzulitai opened a pull request: https://github.com/apache/flink/pull/4363 FLINK-7224 [kafka, docs] Fix incorrect Javadoc / docs regarding Kafka partition metadata querying Since Flink 1.3, partition metadata is no longer queried on the client side. This commit corrects the statements of this legacy behaviour in the Javadocs and documentation. This should be merged for both `release-1.3` and `master`. You can merge this pull request into a Git repository by running: $ git pull https://github.com/tzulitai/flink FLINK-7224 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/4363.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #4363 commit 8341083005e4de64b5d1b4e1fe2a543975197d02 Author: Tzu-Li (Gordon) Tai <tzulitai@apache.org> Date: 2017-07-19T06:24:27Z FLINK-7224 [kafka, docs] Fix incorrect Javadoc / docs regarding Kafka partition metadata querying Since Flink 1.3, partition metadata is no longer queried on the client side. This commit corrects the statements of this legacy behaviour in the Javadocs and documentation.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user zentol commented on the issue:

          https://github.com/apache/flink/pull/4363

          +1.

          Show
          githubbot ASF GitHub Bot added a comment - Github user zentol commented on the issue: https://github.com/apache/flink/pull/4363 +1.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user tzulitai commented on the issue:

          https://github.com/apache/flink/pull/4363

          Merging ..

          Show
          githubbot ASF GitHub Bot added a comment - Github user tzulitai commented on the issue: https://github.com/apache/flink/pull/4363 Merging ..
          Hide
          tzulitai Tzu-Li (Gordon) Tai added a comment -

          Fixed for master via 58b53748293c160c28c7f9d08c3a0ad23152d34f.
          Fixed for release-1.3 via cf70255d427c4f16cb5cda008952d28f20655da1.

          Show
          tzulitai Tzu-Li (Gordon) Tai added a comment - Fixed for master via 58b53748293c160c28c7f9d08c3a0ad23152d34f. Fixed for release-1.3 via cf70255d427c4f16cb5cda008952d28f20655da1.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user tzulitai closed the pull request at:

          https://github.com/apache/flink/pull/4363

          Show
          githubbot ASF GitHub Bot added a comment - Github user tzulitai closed the pull request at: https://github.com/apache/flink/pull/4363

            People

            • Assignee:
              tzulitai Tzu-Li (Gordon) Tai
              Reporter:
              tzulitai Tzu-Li (Gordon) Tai
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development