Skip to content
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

Jump to bottom

Update: Add additional warning on debug-request #7949

Merged
merged 1 commit into from
Sep 20, 2024
Merged

Update: Add additional warning on debug-request #7949

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion app/_src/gateway/production/debug-request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ Request debugging provides the following insights:
{:.note}
> **Note:** This feature is meant for live debugging. The JSON schema of the header containing the timing should never be considered static and is always subject to change.

{:.warning}
> **Warning:** Debug requests originating from loopback addresses are not secured by `X-Kong-Request-Debug-Token`. Deploying {{site.base_gateway}} behind other proxies will be dangerous for exposing the debug interface to the public without any authentication.

## Enable request debugging

Request debugging is enabled by default and has the following configurations in [`kong.conf`](/gateway/{{page.release}}/reference/configuration/):
Expand Down Expand Up @@ -57,7 +60,7 @@ If the `X-Kong-Request-Debug-Log` header is set to true, timing information will

### X-Kong-Request-Debug-Token header

The `X-Kong-Request-Debug-Token` is a token for authenticating the client and making the debug request to prevent abuse. Debug requests originating from loopback addresses don't require this header.
The `X-Kong-Request-Debug-Token` is a token for authenticating the client and making the debug request to prevent abuse. **Debug requests originating from loopback addresses don't require this header.**

{% if_version gte:3.5.x %}
### X-Kong-Request-Id header
Expand Down