feat(gateway): Kafka upstream detailed errors#5625
Open
lena-larionova wants to merge 1 commit into
Open
Conversation
✅ Deploy Preview for kongdeveloper ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
✅ Ready to approve
The change is documentation-only and looks correct overall, with only a minor wording nit identified.
Note: this review does not count toward required approvals for merging.
Pull request overview
This PR enhances the Kafka Upstream plugin documentation by adding a new debugging section describing how to return detailed Kafka client errors to the HTTP client using the new config.error_handling.return_error_message setting.
Changes:
- Added a Debugging section for Kafka Upstream documenting default error behavior and an example response payload.
- Documented how to enable detailed Kafka client errors in responses and added a production-safety warning.
File summaries
| File | Description |
|---|---|
| app/_kong_plugins/kafka-upstream/index.md | Adds a new debugging section for the Kafka Upstream plugin explaining the new detailed error response behavior and its risks. |
Copilot's findings
- Files reviewed: 1/1 changed files
- Comments generated: 1
Note
Your feedback helps us improve the quality of this feature.
Please use 👍 or 👎 to tell us whether this assessment is correct.
|
|
||
| ## Debugging {% new_in 3.15 %} | ||
|
|
||
| By default, produce failures return a generic error to the HTTP client and log the real cause in the {{site.base_gateway}} logs: |
tomek-labuk
approved these changes
Jun 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds a debugging section for the kafka upstream plugin with the new error handling setting. No plugin example since it's a one-param change, but it felt like having info about debugging the plugin might be useful (even if it's just one setting).
Based on https://github.com/Kong/kong-technical-enablement/tree/main/api-gateway/3.15/surface-kafka-upstream-errors
Preview Links