Skip to content

Commit

Permalink
Update: Add additional warning on debug-request
Browse files Browse the repository at this point in the history
  • Loading branch information
@Oyami-Srk
Oyami-Srk committed Sep 20, 2024
1 parent 7c86f39 commit 37f3764
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion app/_src/gateway/production/debug-request.md
View file
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 Kong Gateway behind other proxies will be dangerous for exposing the debug interface to the public without any authentication.

Check failure on line 17 in app/_src/gateway/production/debug-request.md

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[kong.kongterms] Use '{{site.base_gateway}}' instead of 'Kong Gateway'.

Raw Output:
{"message": "[kong.kongterms] Use '{{site.base_gateway}}' instead of 'Kong Gateway'.", "location": {"path": "app/_src/gateway/production/debug-request.md", "range": {"start": {"line": 17, "column": 126}}}, "severity": "ERROR"}
## 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

0 comments on commit 37f3764

Please sign in to comment.