Skip to content

feat(gateway): Kafka upstream detailed errors #5625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lena-larionova merged 2 commits into from
Jun 18, 2026
+15 −0
Merged

feat(gateway): Kafka upstream detailed errors #5625

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8ad2c0
add debugging section on kafka upstream plugin
lena-larionova Jun 18, 2026
3b507b1
minor edit for clarity
lena-larionova Jun 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions app/_kong_plugins/kafka-upstream/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,21 @@ When encoding request bodies, several things happen:

{% include_cached /plugins/confluent-kafka-consume/schema-registry.md name=page.name slug=page.slug workflow='producer' %}

## Debugging {% new_in 3.15 %}

By default, when producing a message fails, the plugin returns a generic error to the HTTP client and logs the real cause in the {{site.base_gateway}} logs:

```json
{"message": "Bad Gateway", "error": "could not send message to topic"}
```

To include the detailed Kafka client error in the response instead, set [`config.error_handling.return_error_message`](/plugins/kafka-upstream/reference/#schema--config-error-handling-return-error-message) to `true` (`false` by default).
This lets you see the exact broker rejection (for example, `TopicAuthorizationFailed`) without checking the {{site.base_gateway}} logs.

{:.warning}
> **Warning**: Do not enable this in production.
> The detailed error may expose internal details like topic names and ACL denials.

## Known issues and limitations

Known limitations:
Expand Down
Loading