rishi-rana opened a new pull request, #23465:
URL: https://github.com/apache/kafka/pull/23465

   ## Summary
   
   Follow-up to #23444 (KAFKA-21076), which fixed the error code returned when 
a client's decompressed telemetry payload exceeds `telemetry.max.bytes`. The 
original report also asked to document this behavior, which #23444 didn't cover:
   
   > Document the decompressed bound in telemetry.max.bytes or add a separate 
configuration, and mention the behavior change in the upgrade notes.
   
   This PR addresses the documentation half. A *separate* configuration for the 
decompressed bound (as opposed to documenting the existing one) would be a new 
public interface and needs its own KIP, so it's intentionally left out of scope 
here.
   
   ## Changes
   
   - `MetricConfigs.CLIENT_TELEMETRY_MAX_BYTES_DOC`: the doc string only 
described `telemetry.max.bytes` as a compressed wire-size limit (KIP-714's 
original definition). It's been bounding the decompressed payload size too 
since 4.3.1 (#22327), so the doc string was stale. Updated it to say so, and 
that exceeding it returns `TELEMETRY_TOO_LARGE`.
   - `docs/getting-started/upgrade.md`: added a bullet under "Notable changes 
in 4.4.0" (matching the existing `KAFKA-20609`/`KAFKA-20843` bullet style) 
explaining the behavior change and pointing operators at raising 
`telemetry.max.bytes` if they hit it after upgrading.
   
   ## Test plan
   
   Documentation-only change (a Java doc-string constant and a markdown file). 
Verified `./gradlew :server:compileJava :server:checkstyleMain 
:server:spotlessCheck` stays clean.
   
   ## AI assistance disclosure
   
   Per `AI_POLICY`/`CONTRIBUTING.md`: Claude Code (Sonnet 5) was used to draft 
both doc changes in 
`server/src/main/java/org/apache/kafka/server/metrics/MetricConfigs.java` and 
`docs/getting-started/upgrade.md`. Reviewed by me before submission.
   
   🤖 Generated with [Claude Code](https://claude.com/claude-code)
   
   https://claude.ai/code/session_01K4B9PPesZhXHiWr5Ak1PNz


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to