| Class | Test Case | Failure Rate | Build Scans |
| {full_class_name} | |||
| {method:<60} | {case['failure_rate']:.2%} | {case['total_runs']} | |
| {case['failure_rate']:.2%} | {case['total_runs']} |
Detailed Test Method History
\n") - - for test_name, details in sorted(cleared_tests.items(), - key=lambda x: x[1]['success_rate'], - reverse=True): - print(f"\n### {test_name}") - print(f"* Overall Success Rate: {details['success_rate']:.2%}") - print(f"* Total Executions: {details['total_executions']}") - print(f"* Consecutive Successful Runs: {details['successful_runs']}") - - for test_case in details['test_cases']: - method_name = test_case['name'].split('.')[-1] - print(f"\n#### {method_name}") - print(f"* Success Rate: {test_case['success_rate']:.2%}") - print(f"* Total Runs: {test_case['total_executions']}") - print("\nRecent Executions:") - print("```") - print("Date/Time (UTC) Outcome Build ID") - print("-" * 44) - for entry in sorted(test_case['recent_executions'], key=lambda x: x.timestamp, reverse=True)[:5]: - date_str = entry.timestamp.strftime('%Y-%m-%d %H:%M') - print(f"{date_str:<17} {entry.outcome:<10} {entry.build_id}") - print("```") - - print("| Class | Test Case | Success Rate | Build Scans |
| {test_name} | {details['success_rate']:.2%} | {details['total_executions']} |
New Tests ({len(new_table)})
\n") - print(f"| Module | Test |") - print(f"| ------ | ---- |") - logger.debug(f"::group::Found {len(new_table)} new tests") - for row in new_table: - row_joined = " | ".join(row) - print(f"| {row_joined} |") - logger.debug(f"{row[0]} > {row[1]}") - print("\n") + # Print special message if there was a timeout + test_exit_code = get_env("GRADLE_TEST_EXIT_CODE", int) + quarantined_test_exit_code = get_env("GRADLE_QUARANTINED_TEST_EXIT_CODE", int) - # Print errors and exit - for message in failure_messages: - logger.debug(message) - logger.debug(summary) - - if len(failure_messages) > 0: + if test_exit_code == 124 or quarantined_test_exit_code == 124: + # Special handling for timeouts. The exit code 124 is emitted by 'timeout' command used in build.yml. + # A watchdog script "thread-dump.sh" will use jstack to force a thread dump for any Gradle process + # still running after the timeout. We capture the exit codes of the two test tasks and pass them to + # this script. If either "test" or "quarantinedTest" fails due to timeout, we want to fail the overall build. + thread_dump_url = get_env("THREAD_DUMP_URL") + if test_exit_code == 124: + logger.debug(f"Gradle task for 'test' timed out. These are partial results!") + else: + logger.debug(f"Gradle task for 'quarantinedTest' timed out. These are partial results!") + logger.debug(summary) + if thread_dump_url: + print(f"\nThe JUnit tests were cancelled due to a timeout. Thread dumps were generated before the job was cancelled. " + f"Download [thread dumps]({thread_dump_url}).\n") + logger.debug(f"Failing this step because the tests timed out. Thread dumps were taken and archived here: {thread_dump_url}") + else: + logger.debug(f"Failing this step because the tests timed out. Thread dumps were not archived, check logs in JUnit step.") exit(1) + elif test_exit_code in (0, 1): + logger.debug(summary) + if total_failures > 0: + logger.debug(f"Failing this step due to {total_failures} test failures") + exit(1) + elif total_errors > 0: + logger.debug(f"Failing this step due to {total_errors} test errors") + exit(1) + else: + exit(0) else: - exit(0) + logger.debug(f"Gradle had unexpected exit code {test_exit_code}. Failing this step") + exit(1) diff --git a/.github/scripts/requirements.txt b/.github/scripts/requirements.txt index d3fcf50bb7400..d59455f79dac6 100644 --- a/.github/scripts/requirements.txt +++ b/.github/scripts/requirements.txt @@ -12,8 +12,6 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. - -# Note: Ensure the 'requests' version here matches the version in tests/setup.py PyYAML~=6.0 pytz==2024.2 -requests==2.32.4 +requests==2.32.3 diff --git a/.github/scripts/thread-dump.sh b/.github/scripts/thread-dump.sh index 89eb90f1355c2..8f387a3974cad 100755 --- a/.github/scripts/thread-dump.sh +++ b/.github/scripts/thread-dump.sh @@ -20,14 +20,16 @@ sleep $(($SLEEP_MINUTES*60)); echo "Timed out after $SLEEP_MINUTES minutes. Dumping threads now..." mkdir thread-dumps -touch thread-dumps/pids.txt sleep 5; for GRADLE_WORKER_PID in `jps | grep GradleWorkerMain | awk -F" " '{print $1}'`; do - echo $GRADLE_WORKER_PID >> thread-dumps/pids.txt echo "Dumping threads for GradleWorkerMain pid $GRADLE_WORKER_PID into $FILENAME"; FILENAME="thread-dumps/GradleWorkerMain-$GRADLE_WORKER_PID.txt" jstack $GRADLE_WORKER_PID > $FILENAME + if ! grep -q "kafka" $FILENAME; then + echo "No match for 'kafka' in thread dump file $FILENAME, discarding it." + rm $FILENAME; + fi; sleep 5; done; diff --git a/.github/workflows/README.md b/.github/workflows/README.md index 229b72596ac97..24116f32dd630 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -67,13 +67,13 @@ Unlike trunk, the PR builds _will_ utilize the Gradle cache. ### PR Triage In order to get the attention of committers, we have a triage workflow for Pull Requests -opened by non-committers. This workflow consists of two files: +opened by non-committers. This workflow consists of three files: -* [pr-update.yml](pr-update.yml) When a PR is created, add the `triage` label if - the PR was opened by a non-committer. -* [pr-labels-cron.yml](pr-labels-cron.yml) Cron job to add `needs-attention` label to community - PRs that have not been reviewed after 7 days. Also includes a cron job to - remove the `triage` and `needs-attention` labels from PRs which have been reviewed. +* [pr-update.yml](pr-update.yml) When a PR is created add the `triage` label if the PR + was opened by a non-committer. +* [pr-reviewed-trigger.yml](pr-reviewed-trigger.yml) Runs when any PR is reviewed. + Used as a trigger for the next workflow +* [pr-reviewed.yml](pr-reviewed.yml) Remove the `triage` label after a PR has been reviewed _The pr-update.yml workflow includes pull_request_target!_ @@ -84,8 +84,7 @@ organization must be public. Here are the steps to take: * Find yourself * Change "Organization Visibility" to Public -Full documentation for this process can be found in GitHub's docs: -https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/publicizing-or-hiding-organization-membership +Full documentation for this process can be found in GitHub's docs: https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/publicizing-or-hiding-organization-membership If you are a committer and do not want your membership in the ASF org listed as public, you will need to remove the `triage` label manually. @@ -101,36 +100,11 @@ There are two files related to this workflow: * [pr-labeled.yml](pr-labeled.yml) approves a pending approval for PRs that have been labeled with `ci-approved` -* [workflow-requested.yml](workflow-requested.yml) approves future workflow requests automatically +* [ci-requested.yml](ci-requested.yml) approves future CI requests automatically if the PR has the `ci-approved` label _The pr-labeled.yml workflow includes pull_request_target!_ -### PR Linter - -To help ensure good commit messages, we have added a "Pull Request Linter" job -that checks the title and body of the PR. - -There are two files related to this workflow: - -* [pr-reviewed.yml](pr-reviewed.yml) runs when a PR is reviewed or has its title -or body edited. This workflow simply captures the PR number into a text file -* [pr-linter.yml](pr-linter.yml) runs after pr-reviewed.yml and loads the PR -using the saved text file. This workflow runs the linter script that checks the -structure of the PR - -Note that the pr-reviewed.yml workflow uses the `ci-approved` mechanism described -above. - -The following checks are performed on our PRs: -* Title is not too short or too long -* Title starts with "KAFKA-", "MINOR", or "HOTFIX" -* Body is not empty -* Body includes "Reviewers:" if the PR is approved - -With the merge queue, our PR title and body will become the commit subject and message. -This linting step will help to ensure that we have nice looking commits. - ### Stale PRs This one is straightforward. Using the "actions/stale" GitHub Action, we automatically @@ -145,47 +119,4 @@ Composite actions are a convenient way to reuse build logic, but they have some limitations. - Cannot run more than one step in a composite action (see `workflow_call` instead) -- Inputs can only be strings, no support for typed parameters. See: https://github.com/actions/runner/issues/2238 - -## Troubleshooting - -### Gradle Cache Misses - -If your PR is running for longer than you would expect due to cache misses, there are a -few things to check. - -First, find the cache that was loaded into your PR build. This is found in the Setup Gradle -output. Look for a line starting with "Restored Gradle User Home from cache key". -For example, - -``` -Restored Gradle User Home from cache key: gradle-home-v1|Linux-X64|test[188616818c9a3165053ef8704c27b28e]-5c20aa187aa8f51af4270d7d1b0db4963b0cd10b -``` - -The last part of the cache key is the SHA of the commit on trunk where the cache -was created. If that commit is not on your branch, it means your build loaded a -cache that includes changes your PR does not yet have. This is a common way to -have cache misses. To resolve this, update your PR with the latest cached trunk commit: - -```commandline -git fetch origin -./committer-tools/update-cache.sh -git merge trunk-cached -``` - -then push your branch. - -If your build seems to be using the correct cache, the next thing to check is for -changes to task inputs. You can find this by locating the trunk Build Scan from -the cache commit on trunk and comparing it with the build scan of your PR build. -This is done in the Develocity UI using the two overlapping circles like `(A()B)`. -This will show you differences in the task inputs for the two builds. - -Finally, you can run your PR with extra cache debugging. Add this to the gradle invocation in -[run-gradle/action.yml](../actions/run-gradle/action.yml). - -``` --Dorg.gradle.caching.debug=true -``` - -This will dump out a lot of output, so you may also reduce the test target to one module. +- Inputs can only be strings, no support for typed parameters. See: https://github.com/actions/runner/issues/2238 \ No newline at end of file diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 47bb2cbc31d5d..e1992a4059281 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -31,47 +31,17 @@ on: type: boolean jobs: - configure: - runs-on: ubuntu-latest - name: Configure Workflow - outputs: - is-draft: ${{ steps.check-draft-pr.outputs.is-draft }} - test-catalog-days: ${{ steps.configure-outputs.outputs.days }} - sha: ${{ steps.configure-outputs.outputs.sha }} - steps: - - name: Env - run: printenv - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - - name: Check for Draft PR - id: check-draft-pr - if: | - github.event_name == 'pull_request' && - github.event.pull_request.draft - run: echo "is-draft=true" >> "$GITHUB_OUTPUT" - - name: Configure Outputs - id: configure-outputs - run: | - if [ "${{ github.event_name }}" = "pull_request" ]; then - echo "days=0" >> "$GITHUB_OUTPUT" - echo "sha=${{ github.event.pull_request.head.sha }}" >> "$GITHUB_OUTPUT" - else - echo "days=7" >> "$GITHUB_OUTPUT" - echo "sha=${{ github.sha }}" >> "$GITHUB_OUTPUT" - fi - load-catalog: - needs: [configure] runs-on: ubuntu-latest name: Load Test Catalog steps: - name: Checkout main - uses: actions/checkout@v5 + uses: actions/checkout@v4 with: persist-credentials: false - name: Checkout test-catalog - uses: actions/checkout@v5 + uses: actions/checkout@v4 with: ref: 'test-catalog' persist-credentials: false @@ -79,12 +49,9 @@ jobs: path: test-catalog - name: Checkout catalog at earlier date - if: ${{ needs.configure.outputs.test-catalog-days != '0' }} - env: - DAYS: ${{ needs.configure.outputs.test-catalog-days }} run: | cd test-catalog - SHA=$(git rev-list -1 --before $DAYS.days.ago origin/test-catalog) + SHA=$(git rev-list -1 --before 7.days.ago origin/test-catalog) echo $SHA git switch --detach $SHA git show --no-patch @@ -109,25 +76,31 @@ jobs: compression-level: 9 validate: - needs: [configure] runs-on: ubuntu-latest - name: Compile and Check (Merge Ref) + name: Compile and Check Java + outputs: + is-draft: ${{ steps.check-draft-pr.outputs.is-draft }} steps: - name: Env run: printenv env: GITHUB_CONTEXT: ${{ toJson(github) }} + - name: Check for Draft PR + id: check-draft-pr + if: | + github.event_name == 'pull_request' && + github.event.pull_request.draft + run: echo "is-draft=true" >> "$GITHUB_OUTPUT" - name: Checkout code - uses: actions/checkout@v5 + uses: actions/checkout@v4 with: persist-credentials: false - ref: ${{ github.sha }} # this is the default, just being explicit. - name: Setup Python uses: ./.github/actions/setup-python - name: Setup Gradle uses: ./.github/actions/setup-gradle with: - java-version: 24 + java-version: 23 gradle-cache-read-only: ${{ !inputs.is-trunk }} gradle-cache-write-only: ${{ inputs.is-trunk }} develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }} @@ -140,7 +113,7 @@ jobs: # --scan: Publish the build scan. This will only work on PRs from apache/kafka and trunk # --no-scan: For public fork PRs, we won't attempt to publish the scan run: | - ./gradlew --build-cache --info $SCAN_ARG check releaseTarGz -x test + ./gradlew --build-cache --info $SCAN_ARG check siteDocTar -x test - name: Archive check reports if: always() uses: actions/upload-artifact@v4 @@ -170,32 +143,23 @@ jobs: find ./site-docs/generated -type f -exec grep -L "." {} \; >&2 exit 1 fi - - name: Verify license file - run: python committer-tools/verify_license.py --skip-build test: - needs: [configure, validate, load-catalog] - if: ${{ ! needs.configure.outputs.is-draft }} + needs: [validate, load-catalog] + if: ${{ ! needs.validate.outputs.is-draft }} runs-on: ubuntu-latest strategy: fail-fast: false matrix: - # If we change these, make sure to adjust ci-complete.yml - java: [ 24, 17 ] - run-flaky: [ true, false ] - run-new: [ true, false ] - exclude: - - run-flaky: true - run-new: true - env: - job-variation: ${{ matrix.java }}-${{ matrix.run-flaky == true && 'flaky' || 'noflaky' }}-${{ matrix.run-new == true && 'new' || 'nonew' }} - name: JUnit tests Java ${{ matrix.java }}${{ matrix.run-flaky == true && ' (flaky)' || '' }}${{ matrix.run-new == true && ' (new)' || '' }} + java: [ 23, 17 ] # If we change these, make sure to adjust ci-complete.yml + outputs: + timed-out: ${{ (steps.junit-test.outputs.gradle-exitcode == '124' || steps.junit-quarantined-test.outputs.gradle-exitcode == '124') }} + name: JUnit tests Java ${{ matrix.java }} steps: - name: Checkout code - uses: actions/checkout@v5 + uses: actions/checkout@v4 with: persist-credentials: false - ref: ${{ needs.configure.outputs.sha }} - name: Setup Python uses: ./.github/actions/setup-python - name: Setup Gradle @@ -210,11 +174,20 @@ jobs: # the overall workflow, so we'll continue here without a test catalog. - name: Load Test Catalog id: load-test-catalog - uses: actions/download-artifact@v5 + uses: actions/download-artifact@v4 continue-on-error: true with: name: combined-test-catalog + - name: JUnit Quarantined Tests + id: junit-quarantined-test + uses: ./.github/actions/run-gradle + with: + test-task: quarantinedTest + timeout-minutes: 180 + test-catalog-path: ${{ steps.load-test-catalog.outputs.download-path }}/combined-test-catalog.txt + build-scan-artifact-name: build-scan-quarantined-test-${{ matrix.java }} + - name: JUnit Tests id: junit-test uses: ./.github/actions/run-gradle @@ -222,19 +195,13 @@ jobs: test-task: test timeout-minutes: 180 # 3 hours test-catalog-path: ${{ steps.load-test-catalog.outputs.download-path }}/combined-test-catalog.txt - build-scan-artifact-name: build-scan-${{ env.job-variation }} - run-new-tests: ${{ matrix.run-new }} - run-flaky-tests: ${{ matrix.run-flaky }} - test-retries: ${{ matrix.run-flaky == true && '3' || '1' }} - test-xml-output: ${{ env.job-variation }} - test-repeat: ${{ !inputs.is-trunk && matrix.run-new && '3' || '1' }} - test-verbose: ${{ runner.debug == '1' }} + build-scan-artifact-name: build-scan-test-${{ matrix.java }} - name: Archive JUnit HTML reports uses: actions/upload-artifact@v4 - id: archive-junit-html + id: junit-upload-artifact with: - name: junit-reports-${{ env.job-variation }} + name: junit-reports-${{ matrix.java }} path: | **/build/reports/tests/* compression-level: 9 @@ -243,98 +210,51 @@ jobs: - name: Archive JUnit XML uses: actions/upload-artifact@v4 with: - name: junit-xml-${{ env.job-variation }} + name: junit-xml-${{ matrix.java }} path: | build/junit-xml/**/*.xml compression-level: 9 if-no-files-found: ignore - name: Archive Thread Dumps - id: archive-thread-dump - if: steps.junit-test.outputs.gradle-exitcode == '124' + id: thread-dump-upload-artifact + if: always() && (steps.junit-test.outputs.gradle-exitcode == '124' || steps.junit-quarantined-test.outputs.gradle-exitcode == '124') uses: actions/upload-artifact@v4 with: - name: junit-thread-dumps-${{ env.job-variation }} + name: junit-thread-dumps-${{ matrix.java }} path: | thread-dumps/* compression-level: 9 if-no-files-found: ignore - name: Parse JUnit tests + run: python .github/scripts/junit.py --export-test-catalog ./test-catalog >> $GITHUB_STEP_SUMMARY env: GITHUB_WORKSPACE: ${{ github.workspace }} - JUNIT_REPORT_URL: ${{ steps.archive-junit-html.outputs.artifact-url }} - THREAD_DUMP_URL: ${{ steps.archive-thread-dump.outputs.artifact-url }} + JUNIT_REPORT_URL: ${{ steps.junit-upload-artifact.outputs.artifact-url }} + THREAD_DUMP_URL: ${{ steps.thread-dump-upload-artifact.outputs.artifact-url }} GRADLE_TEST_EXIT_CODE: ${{ steps.junit-test.outputs.gradle-exitcode }} - run: | - python .github/scripts/junit.py \ - --path build/junit-xml >> $GITHUB_STEP_SUMMARY + GRADLE_QUARANTINED_TEST_EXIT_CODE: ${{ steps.junit-quarantined-test.outputs.gradle-exitcode }} - # This job downloads all the JUnit XML files and thread dumps from the JDK 24 test runs. - # If any test job fails, we will not run this job. Also, if any thread dump artifacts - # are present, this means there was a timeout in the tests and so we will not proceed - # with catalog creation. - collate-test-catalog: - name: Collate Test Catalog - needs: test - runs-on: ubuntu-latest - outputs: - uploaded-test-catalog: ${{ steps.archive-test-catalog.outcome == 'success' }} - steps: - - name: Checkout code - uses: actions/checkout@v5 - with: - persist-credentials: false - - name: Download Thread Dumps - uses: actions/download-artifact@v5 - with: - pattern: junit-thread-dumps-24-* - path: thread-dumps - merge-multiple: true - - name: Check For Thread Dump - id: check-for-thread-dump - run: | - find . - if [ -d thread-dumps ]; then - echo "Found 'thread-dumps' directory. Will not proceed with test catalog collation."; - exit 1; - fi - - name: Download JUnit XMLs - uses: actions/download-artifact@v5 - with: - pattern: junit-xml-24-* # Only look at JDK 24 tests for the test catalog - path: junit-xml - merge-multiple: true - - name: Collate Test Catalog - continue-on-error: true - env: - GITHUB_WORKSPACE: ${{ github.workspace }} - GRADLE_TEST_EXIT_CODE: 0 - run: | - python .github/scripts/junit.py \ - --path junit-xml \ - --export-test-catalog ./test-catalog >> $GITHUB_STEP_SUMMARY - name: Archive Test Catalog - id: archive-test-catalog + if: ${{ always() && matrix.java == '23' }} uses: actions/upload-artifact@v4 with: name: test-catalog path: test-catalog compression-level: 9 - if-no-files-found: error + if-no-files-found: ignore - # This job downloads the test catalog from the previous job and overlays it on the test-catalog branch. - # This will only run on trunk and only if the collate job did not detect a timeout. update-test-catalog: name: Update Test Catalog - needs: collate-test-catalog - if: ${{ inputs.is-trunk && needs.collate-test-catalog.outputs.uploaded-test-catalog == 'true' }} + needs: test + if: ${{ always() && inputs.is-trunk && needs.test.outputs.timed-out == 'false' }} runs-on: ubuntu-latest permissions: contents: write steps: - name: Checkout Test Catalog - uses: actions/checkout@v5 + uses: actions/checkout@v4 with: persist-credentials: true # Needed to commit and push later ref: test-catalog @@ -342,7 +262,7 @@ jobs: run: | rm -rf test-catalog - name: Download Test Catalog - uses: actions/download-artifact@v5 + uses: actions/download-artifact@v4 with: name: test-catalog path: test-catalog @@ -362,28 +282,3 @@ jobs: git add test-catalog git diff --quiet && git diff --staged --quiet || git commit -m "$COMMIT_MSG" git push - - checks-complete: - name: "CI checks completed" - needs: [configure, validate, test] - if: always() - runs-on: ubuntu-latest - steps: - - name: Env - run: printenv - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - - name: Fail if Draft - if: ${{ needs.configure.outputs.is-draft }} - run: | - echo "Cannot merge a draft PR" - exit 1 - - name: Check Dependency Outcomes - run: | - if [[ "${{ needs.validate.result }}" == "success" && "${{ needs.test.result }}" == "success" ]]; then - echo "Required jobs completed successfully!" - exit 0 - else - echo "Required jobs did not complete successfully" - exit 1 - fi diff --git a/.github/workflows/ci-complete.yml b/.github/workflows/ci-complete.yml index 6b8492fb7c0ab..b2d26351545f4 100644 --- a/.github/workflows/ci-complete.yml +++ b/.github/workflows/ci-complete.yml @@ -43,25 +43,15 @@ jobs: strategy: fail-fast: false matrix: - # Make sure these match build.yml - java: [ 24, 17 ] - run-flaky: [ true, false ] - run-new: [ true, false ] - exclude: - - run-flaky: true - run-new: true - - env: - job-variation: ${{ matrix.java }}-${{ matrix.run-flaky == true && 'flaky' || 'noflaky' }}-${{ matrix.run-new == true && 'new' || 'nonew' }} - status-context: Java ${{ matrix.java }}${{ matrix.run-flaky == true && ' / Flaky' || '' }}${{ matrix.run-new == true && ' / New' || '' }} - + java: [ 23, 17 ] + artifact-prefix: [ "build-scan-test-", "build-scan-quarantined-test-"] steps: - name: Env run: printenv env: GITHUB_CONTEXT: ${{ toJson(github) }} - name: Checkout code - uses: actions/checkout@v5 + uses: actions/checkout@v4 with: persist-credentials: false @@ -72,12 +62,12 @@ jobs: develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }} - name: Download build scan archive id: download-build-scan - uses: actions/download-artifact@v5 + uses: actions/download-artifact@v4 continue-on-error: true # Don't want this step to fail the overall workflow with: github-token: ${{ github.token }} run-id: ${{ github.event.workflow_run.id }} - name: build-scan-${{ env.job-variation }} + name: ${{ matrix.artifact-prefix }}${{ matrix.java }} path: ~/.gradle/build-scan-data # This is where Gradle buffers unpublished build scan data when --no-scan is given - name: Handle missing scan if: ${{ steps.download-build-scan.outcome == 'failure' }} @@ -88,7 +78,7 @@ jobs: commit_sha: ${{ github.event.workflow_run.head_sha }} url: '${{ github.event.workflow_run.html_url }}' description: 'Could not find build scan' - context: Gradle Build Scan / ${{ env.status-context }} + context: 'Gradle Build Scan / Java ${{ matrix.java }}' state: 'error' - name: Publish Scan id: publish-build-scan @@ -116,7 +106,7 @@ jobs: commit_sha: ${{ github.event.workflow_run.head_sha }} url: '${{ github.event.repository.html_url }}/actions/runs/${{ github.run_id }}' description: 'The build scan failed to be published' - context: Gradle Build Scan / ${{ env.status-context }} + context: 'Gradle Build Scan / Java ${{ matrix.java }}' state: 'error' - name: Update Status Check if: ${{ steps.publish-build-scan.outcome == 'success' }} @@ -127,5 +117,5 @@ jobs: commit_sha: ${{ github.event.workflow_run.head_sha }} url: ${{ steps.publish-build-scan.outputs.build-scan-url }} description: 'The build scan was successfully published' - context: Gradle Build Scan / ${{ env.status-context }} + context: 'Gradle Build Scan / Java ${{ matrix.java }}' state: 'success' diff --git a/.github/workflows/ci-requested.yml b/.github/workflows/ci-requested.yml new file mode 100644 index 0000000000000..a1da6fa34a1f8 --- /dev/null +++ b/.github/workflows/ci-requested.yml @@ -0,0 +1,86 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: CI Requested + +on: + workflow_run: + workflows: [CI] + types: + - requested + +run-name: CI Requested for ${{ github.event.workflow_run.display_title}} + +jobs: + check-pr-labels: + # Even though job conditionals are difficult to debug, this will reduce the number of unnecessary runs + if: | + github.event_name == 'workflow_run' && + github.event.workflow_run.event == 'pull_request' && + github.event.workflow_run.status == 'completed' && + github.event.workflow_run.conclusion == 'action_required' + runs-on: ubuntu-latest + steps: + - name: Env + run: printenv + env: + GITHUB_CONTEXT: ${{ toJson(github) }} + - name: Checkout code + uses: actions/checkout@v4 + with: + persist-credentials: + false + - name: Check PR Labels + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + REPO: ${{ github.repository }} + RUN_ID: ${{ github.event.workflow_run.id }} + HEAD_BRANCH: ${{ github.event.workflow_run.head_branch }} + HEAD_REPO: ${{ github.event.workflow_run.head_repository.owner.login }} + # Caution! This is a bit hacky. The GH documentation shows that the workflow_run event should include a list + # of referencing pull_requests. I think this might only be the case for pull requests originating from the + # base repository. To deal with fork PRs, we need to query the API for PRs for the owner's branch. This + # code assumes that the fork repo owner is the same as the organization for the "org:branch" syntax used + # in the query. Also, only the first matching PR from that org will be considered. + run: | + set +e + PR_NUMBER=$(gh api \ + -H "Accept: application/vnd.github+json" \ + -H "X-GitHub-Api-Version: 2022-11-28" \ + /repos/$REPO/pulls?head=$HEAD_REPO:$HEAD_BRANCH \ + --jq '.[0].number') + if [ -z "$PR_NUMBER" ]; then + echo "Could not find the PR that triggered this workflow request"; + exit 1; + fi + gh pr view $PR_NUMBER --json labels -q '.labels[].name' | grep -q 'ci-approved' + exitcode="$?" + if [ $exitcode -ne 0 ]; then + echo "No ci-approved label set on PR #$PR_NUMBER. Will not auto-approve."; + exit 0; + else + echo "Found 'ci-approved' label on PR #$PR_NUMBER. Auto-approving workflow run $RUN_ID."; + fi + echo "PR_NUMBER=$PR_NUMBER" >> "$GITHUB_ENV" + echo "RUN_ID=$RUN_ID" >> "$GITHUB_ENV" + - name: Approve Workflow Run + if: env.RUN_ID != '' + uses: ./.github/actions/gh-api-approve-run + with: + gh-token: ${{ secrets.GITHUB_TOKEN }} + repository: ${{ github.repository }} + run_id: ${{ env.RUN_ID }} + pr_number: ${{ env.PR_NUMBER }} + commit_sha: ${{ github.event.workflow_run.head_sha }} diff --git a/.github/workflows/deflake.yml b/.github/workflows/deflake.yml index 3a2fbb56345b2..fa55ab5fb120b 100644 --- a/.github/workflows/deflake.yml +++ b/.github/workflows/deflake.yml @@ -42,20 +42,15 @@ jobs: name: Deflake JUnit tests steps: - name: Checkout code - uses: actions/checkout@v5 + uses: actions/checkout@v4 with: persist-credentials: false - - - name: Setup Python - uses: ./.github/actions/setup-python - - name: Setup Gradle uses: ./.github/actions/setup-gradle with: java-version: ${{ inputs.java-version }} gradle-cache-read-only: true develocity-access-key: ${{ secrets.DEVELOCITY_ACCESS_KEY }} - - name: Test timeout-minutes: 60 id: junit-test @@ -65,52 +60,26 @@ jobs: TEST_PATTERN: ${{ inputs.test-pattern }} run: | set +e - ./.github/scripts/thread-dump.sh & - timeout 60m ./gradlew --info --build-cache --scan --continue \ + ./gradlew --info --build-cache --scan --continue \ -PtestLoggingEvents=started,passed,skipped,failed \ - -PmaxParallelForks=2 \ + -PignoreFailures=true -PmaxParallelForks=2 \ -Pkafka.cluster.test.repeat=$TEST_REPEAT \ -PmaxTestRetries=$TEST_REPEAT -PmaxTestRetryFailures=0 \ - ${TEST_MODULE}:test --tests $TEST_PATTERN + -PmaxQuarantineTestRetries=$TEST_REPEAT -PmaxQuarantineTestRetryFailures=0 \ + ${TEST_MODULE}:test ${TEST_MODULE}:quarantinedTest --tests $TEST_PATTERN exitcode="$?" echo "exitcode=$exitcode" >> $GITHUB_OUTPUT - - - name: Archive JUnit HTML reports - uses: actions/upload-artifact@v4 - id: archive-junit-html - with: - name: junit-html-reports - path: | - **/build/reports/tests/* - compression-level: 9 - if-no-files-found: ignore - - - name: Archive JUnit XML - uses: actions/upload-artifact@v4 - with: - name: junit-xml - path: | - build/junit-xml/**/*.xml - compression-level: 9 - if-no-files-found: ignore - - - name: Archive Thread Dumps - id: archive-thread-dump - if: steps.junit-test.outputs.gradle-exitcode == '124' + - name: Archive JUnit reports uses: actions/upload-artifact@v4 + id: junit-upload-artifact with: - name: junit-thread-dumps-${{ env.job-variation }} + name: junit-reports-${{ inputs.java-version }} path: | - thread-dumps/* - compression-level: 9 + **/build/reports/tests/test/* if-no-files-found: ignore - - name: Parse JUnit tests + run: python .github/scripts/junit.py >> $GITHUB_STEP_SUMMARY env: GITHUB_WORKSPACE: ${{ github.workspace }} - JUNIT_REPORT_URL: ${{ steps.archive-junit-html.outputs.artifact-url }} - THREAD_DUMP_URL: ${{ steps.archive-thread-dump.outputs.artifact-url }} - GRADLE_TEST_EXIT_CODE: ${{ steps.junit-test.outputs.gradle-exitcode }} - run: | - python .github/scripts/junit.py \ - --path build/junit-xml >> $GITHUB_STEP_SUMMARY + REPORT_URL: ${{ steps.junit-upload-artifact.outputs.artifact-url }} + GRADLE_EXIT_CODE: ${{ steps.junit-test.outputs.exitcode }} diff --git a/.github/workflows/docker_build_and_test.yml b/.github/workflows/docker_build_and_test.yml index 6a1b2f7de25f1..67acdf9fb7424 100644 --- a/.github/workflows/docker_build_and_test.yml +++ b/.github/workflows/docker_build_and_test.yml @@ -32,9 +32,9 @@ jobs: build: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v4 - name: Set up Python 3.10 - uses: actions/setup-python@v6 + uses: actions/setup-python@v5 with: python-version: "3.10" - name: Setup Docker Compose diff --git a/.github/workflows/docker_official_image_build_and_test.yml b/.github/workflows/docker_official_image_build_and_test.yml index 1580ea1f744ba..58866a19d6cab 100644 --- a/.github/workflows/docker_official_image_build_and_test.yml +++ b/.github/workflows/docker_official_image_build_and_test.yml @@ -31,9 +31,9 @@ jobs: build: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v4 - name: Set up Python 3.10 - uses: actions/setup-python@v6 + uses: actions/setup-python@v5 with: python-version: "3.10" - name: Setup Docker Compose diff --git a/.github/workflows/docker_rc_release.yml b/.github/workflows/docker_rc_release.yml index da851f4a43028..1f824b39b977a 100644 --- a/.github/workflows/docker_rc_release.yml +++ b/.github/workflows/docker_rc_release.yml @@ -37,9 +37,9 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v5 + uses: actions/checkout@v4 - name: Set up Python 3.10 - uses: actions/setup-python@v6 + uses: actions/setup-python@v5 with: python-version: "3.10" - name: Install dependencies diff --git a/.github/workflows/docker_scan.yml b/.github/workflows/docker_scan.yml index 55df9f65e4c08..a76916fffa916 100644 --- a/.github/workflows/docker_scan.yml +++ b/.github/workflows/docker_scan.yml @@ -26,7 +26,7 @@ jobs: strategy: matrix: # This is an array of supported tags. Make sure this array only contains the supported tags - supported_image_tag: ['latest', '3.9.1', '4.0.0', '4.1.0'] + supported_image_tag: ['latest', '3.7.2', '3.8.1', '3.9.0'] steps: - name: Run CVE scan uses: aquasecurity/trivy-action@6e7b7d1fd3e4fef0c5fa8cce1229c54b2c9bd0d8 # v0.24.0 diff --git a/.github/workflows/generate-reports.yml b/.github/workflows/generate-reports.yml index dee7094c27c15..d3ad9cfa7737b 100644 --- a/.github/workflows/generate-reports.yml +++ b/.github/workflows/generate-reports.yml @@ -20,6 +20,7 @@ on: schedule: - cron: '0 6 * * *' # Run daily at 6am UTC + jobs: flaky-test-report: name: Flaky Test Report @@ -32,12 +33,11 @@ jobs: env: GITHUB_CONTEXT: ${{ toJson(github) }} - name: Checkout code - uses: actions/checkout@v5 + uses: actions/checkout@v4 - name: Setup Python uses: ./.github/actions/setup-python - name: Run Report - if : ${{ ! github.event.repository.fork }} env: - DEVELOCITY_ACCESS_TOKEN: ${{ secrets.DV_API_ACCESS }} + GE_ACCESS_TOKEN: ${{ secrets.GE_ACCESS_TOKEN }} run: | - python ./.github/scripts/develocity_reports.py >> $GITHUB_STEP_SUMMARY + python ./.github/scripts/develocity_reports.py >> $GITHUB_STEP_SUMMARY \ No newline at end of file diff --git a/.github/workflows/pr-labeled.yml b/.github/workflows/pr-labeled.yml index b5695825861ff..49a677ff7f850 100644 --- a/.github/workflows/pr-labeled.yml +++ b/.github/workflows/pr-labeled.yml @@ -35,7 +35,7 @@ jobs: env: GITHUB_CONTEXT: ${{ toJson(github) }} - name: Checkout code - uses: actions/checkout@v5 + uses: actions/checkout@v4 with: persist-credentials: false @@ -65,4 +65,4 @@ jobs: repository: ${{ github.repository }} run_id: ${{ env.RUN_ID }} pr_number: ${{ env.PR_NUMBER }} - commit_sha: ${{ github.event.pull_request.head.sha }} + commit_sha: ${{ github.event.workflow_run.head_sha }} diff --git a/.github/workflows/pr-reviewed-trigger.yml b/.github/workflows/pr-reviewed-trigger.yml new file mode 100644 index 0000000000000..f089176ff4b23 --- /dev/null +++ b/.github/workflows/pr-reviewed-trigger.yml @@ -0,0 +1,42 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: Pull Request Reviewed + +on: + pull_request_review: + types: + - submitted + +jobs: + # This job is a workaround for the fact that pull_request_review lacks necessary permissions to modify PRs. + # Also, there is no pull_request_target analog to pull_request_review. The approach taken here is taken from + # https://securitylab.github.com/resources/github-actions-preventing-pwn-requests/. + pr-review-trigger: + name: Reviewed + runs-on: ubuntu-latest + steps: + - name: Env + run: printenv + env: + GITHUB_CONTEXT: ${{ toJson(github) }} + - name: Capture PR Number + run: + echo ${{ github.event.pull_request.number }} >> pr-number.txt + - name: Archive Event + uses: actions/upload-artifact@v4 + with: + name: pr-number.txt + path: pr-number.txt diff --git a/.github/workflows/pr-reviewed.yml b/.github/workflows/pr-reviewed.yml index 64636a6c2920f..ea2a35f58e8c4 100644 --- a/.github/workflows/pr-reviewed.yml +++ b/.github/workflows/pr-reviewed.yml @@ -13,30 +13,42 @@ # See the License for the specific language governing permissions and # limitations under the License. -name: Pull Request Reviewed +name: Remove Triage Label on: - pull_request_review: - types: [submitted, edited, dismissed] - branches: - - trunk - pull_request: - types: [opened, reopened, edited] - branches: - - trunk + workflow_run: + workflows: [Pull Request Reviewed] + types: + - completed jobs: - save-pr-number: - name: Save PR Number + # This job runs with elevated permissions and the ability to modify pull requests. The steps taken here + # should be limited to updating labels and adding comments to PRs. This approach is taken from + # https://securitylab.github.com/resources/github-actions-preventing-pwn-requests/. + remove-triage: + if: ${{ github.event.workflow_run.conclusion == 'success' }} runs-on: ubuntu-latest steps: - name: Env run: printenv env: GITHUB_CONTEXT: ${{ toJson(github) }} - - name: Save PR Number - run: echo ${{ github.event.pull_request.number }} > PR_NUMBER.txt - - uses: actions/upload-artifact@v4 + - uses: actions/download-artifact@v4 with: - name: PR_NUMBER.txt - path: PR_NUMBER.txt + github-token: ${{ github.token }} + run-id: ${{ github.event.workflow_run.id }} + name: pr-number.txt + - name: Remove label + uses: actions/github-script@v7 + continue-on-error: true + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + var fs = require('fs'); + var pr_number = Number(fs.readFileSync('./pr-number.txt')); + await github.rest.issues.removeLabel({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: pr_number, + name: 'triage' + }); diff --git a/.github/workflows/pr-update.yml b/.github/workflows/pr-update.yml index 7b45a15d19126..e1cd7214d6c36 100644 --- a/.github/workflows/pr-update.yml +++ b/.github/workflows/pr-update.yml @@ -37,8 +37,8 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout code - uses: actions/checkout@v5 - - uses: actions/labeler@v6 + uses: actions/checkout@v4 + - uses: actions/labeler@v5 with: configuration-path: .github/configs/labeler.yml - name: check small label diff --git a/.github/workflows/prepare_docker_official_image_source.yml b/.github/workflows/prepare_docker_official_image_source.yml index 82204b9b93597..32f21a0afd0bf 100644 --- a/.github/workflows/prepare_docker_official_image_source.yml +++ b/.github/workflows/prepare_docker_official_image_source.yml @@ -31,9 +31,9 @@ jobs: build: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v4 - name: Set up Python 3.10 - uses: actions/setup-python@v6 + uses: actions/setup-python@v5 with: python-version: "3.10" - name: Install dependencies diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 9382d4173e94c..6ceb074f62c10 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -35,6 +35,22 @@ permissions: pull-requests: write jobs: + needs-attention: + runs-on: ubuntu-latest + steps: + - uses: actions/stale@v9 + with: + debug-only: ${{ inputs.dryRun || false }} + operations-per-run: ${{ inputs.operationsPerRun || 500 }} + days-before-stale: 7 + days-before-close: -1 + ignore-pr-updates: true + only-pr-labels: 'triage' + stale-pr-label: 'needs-attention' + stale-pr-message: | + A label of 'needs-attention' was automatically added to this PR in order to raise the + attention of the committers. Once this issue has been triaged, the `triage` label + should be removed to prevent this automation from happening again. stale: runs-on: ubuntu-latest steps: diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000000000..a3774a8b1f9c9 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,41 @@ +FROM openjdk:11-jdk-slim + +# Install necessary tools +RUN apt-get update && apt-get install -y \ + wget \ + netcat \ + && rm -rf /var/lib/apt/lists/* + +# Set up working directory +WORKDIR /opt/kafka + +# Copy the entire Kafka source code +COPY . . + +# Build Kafka +RUN ./gradlew jar -PscalaVersion=2.13 + +# Create kafka bin directory structure +RUN mkdir -p /opt/kafka/bin /opt/kafka/config /opt/kafka/libs + +# Copy built JARs to libs +RUN find . -name "*.jar" -path "*/build/libs/*" -exec cp {} /opt/kafka/libs/ \; + +# Copy startup scripts +RUN cp bin/* /opt/kafka/bin/ || true + +# Copy default configurations +RUN cp config/* /opt/kafka/config/ || true + +# Make scripts executable +RUN chmod +x /opt/kafka/bin/*.sh || true + +# Set environment variables +ENV KAFKA_HOME=/opt/kafka +ENV PATH=$PATH:$KAFKA_HOME/bin + +# Expose ports +EXPOSE 9092 + +# Default command +CMD ["bash"] \ No newline at end of file diff --git a/LICENSE-binary b/LICENSE-binary index c8fa1e8207a95..030f62b96755f 100644 --- a/LICENSE-binary +++ b/LICENSE-binary @@ -205,54 +205,53 @@ This project bundles some components that are also licensed under the Apache License Version 2.0: -- caffeine-3.2.0 -- commons-beanutils-1.11.0 +- caffeine-3.1.1 +- commons-beanutils-1.9.4 - commons-collections-3.2.2 - commons-digester-2.1 -- commons-lang3-3.18.0 -- commons-logging-1.3.5 +- commons-lang3-3.12.0 +- commons-logging-1.3.2 - commons-validator-1.9.0 -- hash4j-0.22.0 -- jackson-annotations-2.19.0 -- jackson-core-2.19.0 -- jackson-databind-2.19.0 -- jackson-dataformat-csv-2.19.0 -- jackson-dataformat-yaml-2.19.0 -- jackson-datatype-jdk8-2.19.0 -- jackson-jakarta-rs-base-2.19.0 -- jackson-jakarta-rs-json-provider-2.19.0 -- jackson-module-blackbird-2.19.0 -- jackson-module-jakarta-xmlbind-annotations-2.19.0 +- error_prone_annotations-2.14.0 +- jackson-annotations-2.16.2 +- jackson-core-2.16.2 +- jackson-databind-2.16.2 +- jackson-dataformat-csv-2.16.2 +- jackson-dataformat-yaml-2.16.2 +- jackson-datatype-jdk8-2.16.2 +- jackson-jakarta-rs-base-2.16.2 +- jackson-jakarta-rs-json-provider-2.16.2 +- jackson-module-blackbird-2.16.2 +- jackson-module-jakarta-xmlbind-annotations-2.16.2 - jakarta.inject-api-2.0.1 - jakarta.validation-api-3.0.2 -- javassist-3.30.2-GA -- jetty-alpn-client-12.0.22 -- jetty-client-12.0.22 -- jetty-ee10-servlet-12.0.22 -- jetty-ee10-servlets-12.0.22 -- jetty-http-12.0.22 -- jetty-io-12.0.22 -- jetty-security-12.0.22 -- jetty-server-12.0.22 -- jetty-session-12.0.22 -- jetty-util-12.0.22 -- jose4j-0.9.6 -- jspecify-1.0.0 -- log4j-api-2.25.1 -- log4j-core-2.25.1 -- log4j-slf4j-impl-2.25.1 -- log4j-1.2-api-2.25.1 +- javassist-3.29.2-GA +- jetty-alpn-client-12.0.15 +- jetty-client-12.0.15 +- jetty-ee10-servlet-12.0.15 +- jetty-ee10-servlets-12.0.15 +- jetty-http-12.0.15 +- jetty-io-12.0.15 +- jetty-security-12.0.15 +- jetty-server-12.0.15 +- jetty-session-12.0.15 +- jetty-util-12.0.15 +- jose4j-0.9.4 +- log4j-api-2.24.3 +- log4j-core-2.24.3 +- log4j-slf4j-impl-2.24.3 +- log4j-1.2-api-2.24.3 - lz4-java-1.8.0 - maven-artifact-3.9.6 - metrics-core-2.2.0 -- opentelemetry-proto-1.3.2-alpha +- opentelemetry-proto-1.0.0-alpha - plexus-utils-3.5.1 -- rocksdbjni-10.1.3 -- scala-library-2.13.16 +- rocksdbjni-9.7.3 +- scala-library-2.13.15 - scala-logging_2.13-3.9.5 -- scala-reflect-2.13.16 -- snappy-java-1.1.10.7 -- snakeyaml-2.4 +- scala-reflect-2.13.15 +- snappy-java-1.1.10.5 +- snakeyaml-2.2 - swagger-annotations-2.2.25 =============================================================================== @@ -278,12 +277,12 @@ see: licenses/eclipse-public-license-2.0 - hk2-utils-3.0.6 - osgi-resource-locator-1.0.3 - aopalliance-repackaged-3.0.6 -- jersey-client-3.1.10 -- jersey-common-3.1.10 -- jersey-container-servlet-3.1.10 -- jersey-container-servlet-core-3.1.10 -- jersey-hk2-3.1.10 -- jersey-server-3.1.10 +- jersey-client-3.1.9 +- jersey-common-3.1.9 +- jersey-container-servlet-3.1.9 +- jersey-container-servlet-core-3.1.9 +- jersey-hk2-3.1.9 +- jersey-server-3.1.9 --------------------------------------- CDDL 1.1 + GPLv2 with classpath exception @@ -299,25 +298,25 @@ see: licenses/CDDL+GPL-1.1 MIT License - argparse4j-0.7.0, see: licenses/argparse-MIT -- classgraph-4.8.179, see: licenses/classgraph-MIT +- classgraph-4.8.173, see: licenses/classgraph-MIT - jopt-simple-5.0.4, see: licenses/jopt-simple-MIT - slf4j-api-1.7.36, see: licenses/slf4j-MIT -- pcollections-4.0.2, see: licenses/pcollections-MIT +- pcollections-4.0.1, see: licenses/pcollections-MIT --------------------------------------- BSD 2-Clause -- zstd-jni-1.5.6-10, see: licenses/zstd-jni-BSD-2-clause +- zstd-jni-1.5.6-6, see: licenses/zstd-jni-BSD-2-clause - HdrHistogram-2.2.2, see: licenses/hdrHistogram-BSD-2-clause --------------------------------------- BSD 3-Clause -- jline-3.30.4, see: licenses/jline-BSD-3-clause +- jline-3.25.1, see: licenses/jline-BSD-3-clause - protobuf-java-3.25.5, see: licenses/protobuf-java-BSD-3-clause - jakarta.activation-2.0.1, see: licenses/jakarta-BSD-3-clause --------------------------------------- Go License -- re2j-1.8, see: licenses/re2j-GO +- re2j-1.7, see: licenses/re2j-GO diff --git a/NOTICE b/NOTICE index 36f87db19a965..b59b5575a3454 100644 --- a/NOTICE +++ b/NOTICE @@ -15,5 +15,9 @@ The streams-scala (streams/streams-scala) module was donated by Lightbend and th Copyright (C) 2018 Lightbend Inc.
-
-
MAX_VALUE or zero, and use corresponding timeout parameters to control how long a client should retry a request." +
- " Setting a value greater than zero will cause the client to resend any request that fails with a potentially transient error." +
- " Setting a value of zero will lead to transient errors not being retried, and they will be propagated to the application to be handled.";
+ public static final String RETRIES_DOC = "Setting a value greater than zero will cause the client to resend any request that fails with a potentially transient error." +
+ " It is recommended to set the value to either zero or `MAX_VALUE` and use corresponding timeout parameters to control how long a client should retry a request.";
public static final String RETRY_BACKOFF_MS_CONFIG = "retry.backoff.ms";
public static final String RETRY_BACKOFF_MS_DOC = "The amount of time to wait before attempting to retry a failed request to a given topic partition. " +
@@ -126,9 +125,7 @@ public class CommonClientConfigs {
"\n" +
"TRACE level records all possible metrics, capturing every detail about the system's performance and operation. It's best for controlled environments where in-depth analysis is required, though it can introduce significant overhead.";
public static final String METRIC_REPORTER_CLASSES_CONFIG = "metric.reporters";
- public static final String METRIC_REPORTER_CLASSES_DOC = "A list of classes to use as metrics reporters. " +
- "Implementing the org.apache.kafka.common.metrics.MetricsReporter interface allows plugging in classes that will be notified of new metric creation. " +
- "When custom reporters are set and org.apache.kafka.common.metrics.JmxReporter is needed, it has to be explicitly added to the list.";
+ public static final String METRIC_REPORTER_CLASSES_DOC = "A list of classes to use as metrics reporters. Implementing the org.apache.kafka.common.metrics.MetricsReporter interface allows plugging in classes that will be notified of new metric creation.";
public static final String METRICS_CONTEXT_PREFIX = "metrics.context.";
@@ -195,8 +192,7 @@ public class CommonClientConfigs {
+ "is considered failed and the group will rebalance in order to reassign the partitions to another member. "
+ "For consumers using a non-null group.instance.id which reach this timeout, partitions will not be immediately reassigned. "
+ "Instead, the consumer will stop sending heartbeats and partitions will be reassigned "
- + "after expiration of the session timeout (defined by the client config session.timeout.ms if using the Classic rebalance protocol, or by the broker config group.consumer.session.timeout.ms if using the Consumer protocol). "
- + "This mirrors the behavior of a static consumer which has shutdown.";
+ + "after expiration of session.timeout.ms. This mirrors the behavior of a static consumer which has shutdown.";
public static final String REBALANCE_TIMEOUT_MS_CONFIG = "rebalance.timeout.ms";
public static final String REBALANCE_TIMEOUT_MS_DOC = "The maximum allowed time for each worker to join the group "
@@ -210,18 +206,15 @@ public class CommonClientConfigs {
+ "to the broker. If no heartbeats are received by the broker before the expiration of this session timeout, "
+ "then the broker will remove this client from the group and initiate a rebalance. Note that the value "
+ "must be in the allowable range as configured in the broker configuration by group.min.session.timeout.ms "
- + "and group.max.session.timeout.ms. Note that this client configuration is not supported when group.protocol "
- + "is set to \"consumer\". In that case, session timeout is controlled by the broker config group.consumer.session.timeout.ms.";
+ + "and group.max.session.timeout.ms. Note that this configuration is not supported when group.protocol "
+ + "is set to \"consumer\".";
public static final String HEARTBEAT_INTERVAL_MS_CONFIG = "heartbeat.interval.ms";
public static final String HEARTBEAT_INTERVAL_MS_DOC = "The expected time between heartbeats to the consumer "
+ "coordinator when using Kafka's group management facilities. Heartbeats are used to ensure that the "
+ "consumer's session stays active and to facilitate rebalancing when new consumers join or leave the group. "
- + "This config is only supported if group.protocol is set to \"classic\". In that case, "
- + "the value must be set lower than session.timeout.ms, but typically should be set no higher "
- + "than 1/3 of that value. It can be adjusted even lower to control the expected time for normal rebalances."
- + "If group.protocol is set to \"consumer\", this config is not supported, as "
- + "the heartbeat interval is controlled by the broker with group.consumer.heartbeat.interval.ms.";
+ + "The value must be set lower than session.timeout.ms, but typically should be set no higher "
+ + "than 1/3 of that value. It can be adjusted even lower to control the expected time for normal rebalances.";
public static final String DEFAULT_API_TIMEOUT_MS_CONFIG = "default.api.timeout.ms";
public static final String DEFAULT_API_TIMEOUT_MS_DOC = "Specifies the timeout (in milliseconds) for client APIs. " +
diff --git a/clients/src/main/java/org/apache/kafka/clients/GroupRebalanceConfig.java b/clients/src/main/java/org/apache/kafka/clients/GroupRebalanceConfig.java
index fce243ebc6461..4aff7c8c0a88f 100644
--- a/clients/src/main/java/org/apache/kafka/clients/GroupRebalanceConfig.java
+++ b/clients/src/main/java/org/apache/kafka/clients/GroupRebalanceConfig.java
@@ -43,7 +43,6 @@ public String toString() {
public final int heartbeatIntervalMs;
public final String groupId;
public final Optional- * If delete.topic.enable is set to false on the brokers, an exception will be returned to the client indicating - * that topic deletion is disabled. + * If delete.topic.enable is false on the brokers, deleteTopics will mark + * the topics for deletion, but not actually delete them. The futures will + * return successfully in this case. *
* When using topic IDs, this operation is supported by brokers with inter-broker protocol 2.8 or higher. * When using topic names, this operation is supported by brokers with version 0.10.1.0 or higher. @@ -344,9 +345,6 @@ default DescribeClusterResult describeCluster() { /** * Get information about the nodes in the cluster. - *
- * To obtain broker cluster information, you must configure {@link AdminClientConfig#BOOTSTRAP_SERVERS_CONFIG}.
- * To obtain controller cluster information, you must configure {@link AdminClientConfig#BOOTSTRAP_CONTROLLERS_CONFIG}.
*
* @param options The options to use when getting information about the cluster.
* @return The DescribeClusterResult.
@@ -475,9 +473,6 @@ default DescribeConfigsResult describeConfigs(Collection
- * Note that you cannot describe broker configs or broker logger using {@link AdminClientConfig#BOOTSTRAP_CONTROLLERS_CONFIG},
- * and you cannot describe controller configs or controller logger using {@link AdminClientConfig#BOOTSTRAP_SERVERS_CONFIG}.
- *
* This operation is supported by brokers with version 0.11.0.0 or higher.
*
* @param resources See relevant type {@link ConfigResource.Type}
@@ -878,12 +873,10 @@ default DescribeConsumerGroupsResult describeConsumerGroups(Collection
* This is a convenience method for {@link #listConsumerGroups(ListConsumerGroupsOptions)} with default options.
* See the overload for more details.
- * @deprecated Since 4.1. Use {@link Admin#listGroups(ListGroupsOptions)} instead.
*
* @return The ListConsumerGroupsResult.
*/
- @Deprecated(since = "4.1", forRemoval = true)
default ListConsumerGroupsResult listConsumerGroups() {
return listConsumerGroups(new ListConsumerGroupsOptions());
}
@@ -949,31 +940,6 @@ default ListConsumerGroupOffsetsResult listConsumerGroupOffsets(Map
- * This is a convenience method for
- * {@link #listStreamsGroupOffsets(Map, ListStreamsGroupOffsetsOptions)} with default options.
- *
- * @param groupSpecs Map of streams group ids to a spec that specifies the topic partitions of the group to list offsets for.
- * @return The ListStreamsGroupOffsetsResult.
- */
- default ListStreamsGroupOffsetsResult listStreamsGroupOffsets(Map Alters offsets for the specified group. In order to succeed, the group must be empty.
- *
- * This is a convenience method for {@link #alterStreamsGroupOffsets(String, Map, AlterStreamsGroupOffsetsOptions)} with default options.
- * See the overload for more details.
- *
- * @param groupId The group for which to alter offsets.
- * @param offsets A map of offsets by partition with associated metadata.
- * @return The AlterOffsetsResult.
- */
- default AlterStreamsGroupOffsetsResult alterStreamsGroupOffsets(String groupId, Map Alters offsets for the specified group. In order to succeed, the group must be empty.
- *
- * This operation is not transactional so it may succeed for some partitions while fail for others.
- *
- * Note: this method effectively does the same as the corresponding consumer group method {@link Admin#alterConsumerGroupOffsets} does.
- *
- * @param groupId The group for which to alter offsets.
- * @param offsets A map of offsets by partition with associated metadata. Partitions not specified in the map are ignored.
- * @param options The options to use when altering the offsets.
- * @return The AlterOffsetsResult.
- */
- AlterStreamsGroupOffsetsResult alterStreamsGroupOffsets(String groupId, Map List offset for the specified partitions and OffsetSpec. This operation enables to find
* the beginning offset, end offset as well as the offset matching a timestamp in partitions.
@@ -1775,36 +1662,12 @@ default FenceProducersResult fenceProducers(Collection
- * This is a convenience method for {@link #listConfigResources(Set, ListConfigResourcesOptions)}
- * with default options. See the overload for more details.
- *
- * @return The ListConfigurationResourcesResult.
- */
- default ListConfigResourcesResult listConfigResources() {
- return listConfigResources(Set.of(), new ListConfigResourcesOptions());
- }
-
/**
* List the client metrics configuration resources available in the cluster.
*
* @param options The options to use when listing the client metrics resources.
* @return The ListClientMetricsResourcesResult.
- * @deprecated Since 4.1. Use {@link #listConfigResources(Set, ListConfigResourcesOptions)} instead.
*/
- @Deprecated(since = "4.1", forRemoval = true)
ListClientMetricsResourcesResult listClientMetricsResources(ListClientMetricsResourcesOptions options);
/**
@@ -1814,9 +1677,7 @@ default ListConfigResourcesResult listConfigResources() {
* with default options. See the overload for more details.
*
* @return The ListClientMetricsResourcesResult.
- * @deprecated Since 4.1. Use {@link #listConfigResources()} instead.
*/
- @Deprecated(since = "4.1", forRemoval = true)
default ListClientMetricsResourcesResult listClientMetricsResources() {
return listClientMetricsResources(new ListClientMetricsResourcesOptions());
}
@@ -1927,121 +1788,6 @@ default DescribeShareGroupsResult describeShareGroups(Collection This operation is not transactional, so it may succeed for some partitions while fail for others.
- *
- * @param groupId The group for which to alter offsets.
- * @param offsets A map of offsets by partition. Partitions not specified in the map are ignored.
- * @param options The options to use when altering the offsets.
- * @return The AlterShareGroupOffsetsResult.
- */
- AlterShareGroupOffsetsResult alterShareGroupOffsets(String groupId, Map This is a convenience method for {@link #alterShareGroupOffsets(String, Map, AlterShareGroupOffsetsOptions)} with default options.
- * See the overload for more details.
- *
- * @param groupId The group for which to alter offsets.
- * @param offsets A map of offsets by partition.
- * @return The AlterShareGroupOffsetsResult.
- */
- default AlterShareGroupOffsetsResult alterShareGroupOffsets(String groupId, Map This is a convenience method for {@link #listShareGroupOffsets(Map, ListShareGroupOffsetsOptions)}
- * to list offsets of all partitions for the specified share groups with default options.
- *
- * @param groupSpecs Map of share group ids to a spec that specifies the topic partitions of the group to list offsets for.
- * @return The ListShareGroupOffsetsResult
- */
- default ListShareGroupOffsetsResult listShareGroupOffsets(Map
- * This is a convenience method for {@link #deleteShareGroupOffsets(String, Set, DeleteShareGroupOffsetsOptions)} with default options.
- * See the overload for more details.
- *
- * @param groupId The group for which to delete offsets.
- * @param topics The topics for which to delete offsets.
- * @return The DeleteShareGroupOffsetsResult.
- */
- default DeleteShareGroupOffsetsResult deleteShareGroupOffsets(String groupId, Set
- * This is a convenience method for {@link #describeStreamsGroups(Collection, DescribeStreamsGroupsOptions)}
- * with default options. See the overload for more details.
- *
- * @param groupIds The IDs of the groups to describe.
- * @return The DescribeStreamsGroupsResult.
- */
- default DescribeStreamsGroupsResult describeStreamsGroups(Collection
- * This is a convenience method for {@link #forceTerminateTransaction(String, TerminateTransactionOptions)}
- * with default options.
- *
- * @param transactionalId The ID of the transaction to terminate.
- * @return The TerminateTransactionResult.
- */
- default TerminateTransactionResult forceTerminateTransaction(String transactionalId) {
- return forceTerminateTransaction(transactionalId, new TerminateTransactionOptions());
- }
-
- /**
- * Force terminate a transaction for the given transactional ID.
- * This operation aborts any ongoing transaction associated with the transactional ID.
- * It's similar to fenceProducers but only targets a single transactional ID to handle
- * long-running transactions when 2PC is enabled.
- *
- * @param transactionalId The ID of the transaction to terminate.
- * @param options The options to use when terminating the transaction.
- * @return The TerminateTransactionResult.
- */
- TerminateTransactionResult forceTerminateTransaction(String transactionalId,
- TerminateTransactionOptions options);
}
diff --git a/clients/src/main/java/org/apache/kafka/clients/admin/AdminClientConfig.java b/clients/src/main/java/org/apache/kafka/clients/admin/AdminClientConfig.java
index 471d3916cfb55..a87af6be154a5 100644
--- a/clients/src/main/java/org/apache/kafka/clients/admin/AdminClientConfig.java
+++ b/clients/src/main/java/org/apache/kafka/clients/admin/AdminClientConfig.java
@@ -30,7 +30,6 @@
import org.apache.kafka.common.security.auth.SecurityProtocol;
import org.apache.kafka.common.utils.Utils;
-import java.util.List;
import java.util.Map;
import java.util.Set;
@@ -155,14 +154,12 @@ public class AdminClientConfig extends AbstractConfig {
static {
CONFIG = new ConfigDef().define(BOOTSTRAP_SERVERS_CONFIG,
Type.LIST,
- List.of(),
- ConfigDef.ValidList.anyNonDuplicateValues(true, false),
+ "",
Importance.HIGH,
BOOTSTRAP_SERVERS_DOC).
define(BOOTSTRAP_CONTROLLERS_CONFIG,
Type.LIST,
- List.of(),
- ConfigDef.ValidList.anyNonDuplicateValues(true, false),
+ "",
Importance.HIGH,
BOOTSTRAP_CONTROLLERS_DOC)
.define(CLIENT_ID_CONFIG, Type.STRING, "", Importance.MEDIUM, CLIENT_ID_DOC)
@@ -241,7 +238,6 @@ public class AdminClientConfig extends AbstractConfig {
.define(METRIC_REPORTER_CLASSES_CONFIG,
Type.LIST,
JmxReporter.class.getName(),
- ConfigDef.ValidList.anyNonDuplicateValues(true, false),
Importance.LOW,
METRIC_REPORTER_CLASSES_DOC)
.define(METRICS_RECORDING_LEVEL_CONFIG,
@@ -284,13 +280,7 @@ public class AdminClientConfig extends AbstractConfig {
DEFAULT_METADATA_RECOVERY_REBOOTSTRAP_TRIGGER_MS,
atLeast(0),
Importance.LOW,
- METADATA_RECOVERY_REBOOTSTRAP_TRIGGER_MS_DOC)
- .define(CONFIG_PROVIDERS_CONFIG,
- ConfigDef.Type.LIST,
- List.of(),
- ConfigDef.ValidList.anyNonDuplicateValues(true, false),
- ConfigDef.Importance.LOW,
- CONFIG_PROVIDERS_DOC);
+ METADATA_RECOVERY_REBOOTSTRAP_TRIGGER_MS_DOC);
}
@Override
diff --git a/clients/src/main/java/org/apache/kafka/clients/admin/AlterClientQuotasResult.java b/clients/src/main/java/org/apache/kafka/clients/admin/AlterClientQuotasResult.java
index 4906184b3c925..f232c107f9407 100644
--- a/clients/src/main/java/org/apache/kafka/clients/admin/AlterClientQuotasResult.java
+++ b/clients/src/main/java/org/apache/kafka/clients/admin/AlterClientQuotasResult.java
@@ -50,6 +50,6 @@ public Map
- * Note for Broker Logger Configuration:
- * Example:
- *
- * When using {@link AdminClientConfig#BOOTSTRAP_SERVERS_CONFIG}, the controller refer to a random broker.
- * When using {@link AdminClientConfig#BOOTSTRAP_CONTROLLERS_CONFIG}, it refers to the current voter leader.
+ * Returns a future which yields the current controller id.
+ * Note that this may yield null, if the controller ID is not yet known.
*/
public KafkaFuture
- * This option:
- *
+ *
* Depending on what the exception is and how many times we have already tried, we may choose to
* fail the Call, or retry it. It is important to print the stack traces here in some cases,
* since they are not necessarily preserved in ApiVersionException objects.
*
- * @param now The current time in milliseconds.
- * @param throwable The failure exception.
+ * @param now The current time in milliseconds.
+ * @param throwable The failure exception.
*/
final void fail(long now, Throwable throwable) {
if (curNode != null) {
@@ -913,7 +940,7 @@ final void fail(long now, Throwable throwable) {
// protocol downgrade will not count against the total number of retries we get for
// this RPC. That is why 'tries' is not incremented.
if ((throwable instanceof UnsupportedVersionException) &&
- handleUnsupportedVersionException((UnsupportedVersionException) throwable)) {
+ handleUnsupportedVersionException((UnsupportedVersionException) throwable)) {
log.debug("{} attempting protocol downgrade and then retry.", this);
runnable.pendingCalls.add(this);
return;
@@ -967,14 +994,16 @@ private void handleTimeoutFailure(long now, Throwable cause) {
* Create an AbstractRequest.Builder for this Call.
*
* @param timeoutMs The timeout in milliseconds.
- * @return The AbstractRequest builder.
+ *
+ * @return The AbstractRequest builder.
*/
abstract AbstractRequest.Builder createRequest(int timeoutMs);
/**
* Process the call response.
*
- * @param abstractResponse The AbstractResponse.
+ * @param abstractResponse The AbstractResponse.
+ *
*/
abstract void handleResponse(AbstractResponse abstractResponse);
@@ -982,15 +1011,16 @@ private void handleTimeoutFailure(long now, Throwable cause) {
* Handle a failure. This will only be called if the failure exception was not
* retriable, or if we hit a timeout.
*
- * @param throwable The exception.
+ * @param throwable The exception.
*/
abstract void handleFailure(Throwable throwable);
/**
* Handle an UnsupportedVersionException.
*
- * @param exception The exception.
- * @return True if the exception can be handled; false otherwise.
+ * @param exception The exception.
+ *
+ * @return True if the exception can be handled; false otherwise.
*/
boolean handleUnsupportedVersionException(UnsupportedVersionException exception) {
return false;
@@ -1027,7 +1057,7 @@ static class TimeoutProcessor {
/**
* Create a new timeout processor.
*
- * @param now The current time in milliseconds since the epoch.
+ * @param now The current time in milliseconds since the epoch.
*/
TimeoutProcessor(long now) {
this.now = now;
@@ -1039,8 +1069,9 @@ static class TimeoutProcessor {
* Timed out calls will be removed and failed.
* The remaining milliseconds until the next timeout will be updated.
*
- * @param calls The collection of calls.
- * @return The number of calls which were timed out.
+ * @param calls The collection of calls.
+ *
+ * @return The number of calls which were timed out.
*/
int handleTimeouts(Collection
+ *
* This function holds the lock for the minimum amount of time, to avoid blocking
* users of AdminClient who will also take the lock to add new calls.
*/
@@ -1161,7 +1193,7 @@ private synchronized void drainNewCalls() {
* Add some calls to pendingCalls, and then clear the input list.
* Also clears Call#curNode.
*
- * @param calls The calls to add.
+ * @param calls The calls to add.
*/
private void transitionToPendingAndClearList(List
+ *
* Calls that are in flight may have been partially or completely sent over the wire. They may
* even be in the process of being processed by the remote server. At the moment, our only option
* to time them out is to close the entire connection.
*
- * @param processor The timeout processor.
+ * @param processor The timeout processor.
*/
private void timeoutCallsInFlight(TimeoutProcessor processor) {
int numTimedOut = 0;
@@ -1338,8 +1370,8 @@ private void timeoutCallsInFlight(TimeoutProcessor processor) {
/**
* Handle responses from the server.
*
- * @param now The current time in milliseconds.
- * @param responses The latest responses from KafkaClient.
+ * @param now The current time in milliseconds.
+ * @param responses The latest responses from KafkaClient.
*/
private void handleResponses(long now, List
+ *
* If the AdminClient thread has exited, this will fail. Otherwise, it will succeed (even
* if the AdminClient is shutting down). This function should called when retrying an
* existing call.
*
- * @param call The new call object.
- * @param now The current time in milliseconds.
+ * @param call The new call object.
+ * @param now The current time in milliseconds.
*/
void enqueue(Call call, long now) {
if (call.tries > maxRetries) {
@@ -1576,18 +1608,18 @@ void enqueue(Call call, long now) {
/**
* Initiate a new call.
- *
+ *
* This will fail if the AdminClient is scheduled to shut down.
*
- * @param call The new call object.
- * @param now The current time in milliseconds.
+ * @param call The new call object.
+ * @param now The current time in milliseconds.
*/
void call(Call call, long now) {
if (hardShutdownTimeMs.get() != INVALID_SHUTDOWN_TIME) {
log.debug("Cannot accept new call {} when AdminClient is closing.", call);
call.handleFailure(new IllegalStateException("Cannot accept new calls when AdminClient is closing."));
} else if (metadataManager.usingBootstrapControllers() &&
- (!call.nodeProvider.supportsUseControllers())) {
+ (!call.nodeProvider.supportsUseControllers())) {
call.fail(now, new UnsupportedEndpointTypeException("This Admin API is not " +
"yet supported when communicating directly with the controller quorum."));
} else {
@@ -1609,7 +1641,7 @@ private Call makeMetadataCall(long now) {
private Call makeControllerMetadataCall(long now) {
// Use DescribeCluster here, as specified by KIP-919.
return new Call(true, "describeCluster", calcDeadlineMs(now, requestTimeoutMs),
- new MetadataUpdateNodeIdProvider()) {
+ new MetadataUpdateNodeIdProvider()) {
@Override
public DescribeClusterRequest.Builder createRequest(int timeoutMs) {
return new DescribeClusterRequest.Builder(new DescribeClusterRequestData()
@@ -1652,7 +1684,7 @@ private Call makeBrokerMetadataCall(long now) {
// We use MetadataRequest here so that we can continue to support brokers that are too
// old to handle DescribeCluster.
return new Call(true, "fetchMetadata", calcDeadlineMs(now, requestTimeoutMs),
- new MetadataUpdateNodeIdProvider()) {
+ new MetadataUpdateNodeIdProvider()) {
@Override
public MetadataRequest.Builder createRequest(int timeoutMs) {
// Since this only requests node information, it's safe to pass true
@@ -1741,10 +1773,10 @@ int numPendingCalls() {
* Used when a response handler expected a result for some entity but no result was present.
*/
private static
- * When altering broker logger levels (using {@link org.apache.kafka.common.config.ConfigResource.Type#BROKER_LOGGER}),
- * it is strongly recommended to use log level constants from {@link org.apache.kafka.common.config.LogLevelConfig} instead of string literals.
- * This ensures compatibility with Kafka's log level validation and avoids potential configuration errors.
- *
- * Recommended approach:
- * new AlterConfigOp(new ConfigEntry(loggerName, LogLevelConfig.DEBUG_LOG_LEVEL), OpType.SET)
- *
- * Avoid this:
- * new AlterConfigOp(new ConfigEntry(loggerName, "DEBUG"), OpType.SET)
- *
*/
public class AlterConfigOp {
diff --git a/clients/src/main/java/org/apache/kafka/clients/admin/AlterConfigsResult.java b/clients/src/main/java/org/apache/kafka/clients/admin/AlterConfigsResult.java
index cd9279300de84..22851e39592de 100644
--- a/clients/src/main/java/org/apache/kafka/clients/admin/AlterConfigsResult.java
+++ b/clients/src/main/java/org/apache/kafka/clients/admin/AlterConfigsResult.java
@@ -44,7 +44,7 @@ public Map
- *
- *
- * @param partitionSizeLimitPerResponse the maximum number of partitions per response
- */
+ // Note that, partitionSizeLimitPerResponse will not be effective if it is larger than the config
+ // max.request.partition.size.limit on the server side.
public DescribeTopicsOptions partitionSizeLimitPerResponse(int partitionSizeLimitPerResponse) {
this.partitionSizeLimitPerResponse = partitionSizeLimitPerResponse;
return this;
diff --git a/clients/src/main/java/org/apache/kafka/clients/admin/DescribeTopicsResult.java b/clients/src/main/java/org/apache/kafka/clients/admin/DescribeTopicsResult.java
index 300b67f90829f..d744f3cc8b876 100644
--- a/clients/src/main/java/org/apache/kafka/clients/admin/DescribeTopicsResult.java
+++ b/clients/src/main/java/org/apache/kafka/clients/admin/DescribeTopicsResult.java
@@ -96,7 +96,7 @@ public KafkaFuture