Skip to content

Commit

Permalink
kic: add /debug/config/raw-error mention for KIC 3.4+ (#8247)
Browse files Browse the repository at this point in the history
kic: add /debug/config/raw-error mention
  • Loading branch information
pmalek authored Dec 13, 2024
1 parent 4cf9630 commit 2e7d3d0
Showing 1 changed file with 13 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -200,10 +200,9 @@ successfully, reviewing the generated configuration manually and/or applying it
in a test environment can help locate potential causes.

Under normal operation, the controller does not store generated configuration;
it is only sent to Kong's Admin API. The `--dump-config` flag enables a
diagnostic mode where the controller also saves generated configuration to a
temporary file. You can retrieve this file via the web interface of the diagnostic
server at `host:10256/debug/config`.
it is only sent to Kong's Admin API.
The `--dump-config` flag enables a diagnostic mode where the controller also saves generated configuration and {{ site.base_gateway }} responses to memory.
You can retrieve these via the web interface of the diagnostic server at `host:10256/debug/config`.
To use the diagnostic mode:
Expand Down Expand Up @@ -232,6 +231,14 @@ To use the diagnostic mode:
curl -svo last_good.json localhost:10256/debug/config/successful
curl -svo last_bad.json localhost:10256/debug/config/failed
```
{% if_version gte:3.4.x %}
1. Retrieve the last error response body received from {{ site.base_gateway }}:
```bash
curl -svo raw_error_body.json localhost:10256/debug/config/raw-error
```
{% endif_version %}

### Using dumped configuration

Once you have dumped configuration, take one of the following
approaches to isolate issues:
Expand All @@ -251,6 +258,8 @@ approaches to isolate issues:
Once this image is running, run `curl http://localhost:8001/config @last_bad.json`
to try applying the configuration and see any errors.

You can also analyze the returned error response body from {{ site.base_gateway }} to understand the issue.

## Inspecting network traffic with a tcpdump sidecar

Inspecting network traffic allows you to review traffic between the ingress
Expand Down

0 comments on commit 2e7d3d0

Please sign in to comment.