feat: Request Debug Header docs for Kong Gateway 3.5 #6475

cloudjumpercat · 2023-11-06T22:00:02Z

Description

I added docs for the new request debug header to the Gateway docs based on the draft from Engineering. It explains how the feature works as well as provides and example configuration.

DOCU-3475

Testing instructions

Preview link: https://deploy-preview-6475--kongdocs.netlify.app/gateway/latest/production/debug-request/

Checklist

Review label added
PR pointed to correct branch (main for immediate publishing, or a release branch: e.g. release/gateway-3.2, release/deck-1.17)

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

netlify · 2023-11-06T22:00:07Z

✅ Deploy Preview for kongdocs ready!

Name	Link
🔨 Latest commit	`421a3ea`
🔍 Latest deploy log	https://app.netlify.com/sites/kongdocs/deploys/654ba0811663d30008b98d07
😎 Deploy Preview	https://deploy-preview-6475--kongdocs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	9 paths audited Performance: 92 (🟢 up 2 from production) Accessibility: 80 (no change from production) Best Practices: 98 (🟢 up 8 from production) SEO: 90 (no change from production) PWA: - View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

cloudjumpercat · 2023-11-06T22:00:31Z

app/_data/docs_nav_gateway_3.5.x.yml

@@ -228,6 +228,8 @@ items:
        url: /production/logging
      - text: Configure a gRPC service
        url: /production/configuring-a-grpc-service
+      - text: Debug Requests


❗ For reviewers: I couldn't think of a great place for this to go. Does this work?

I wonder if we should put Logging and Debug together in their own section? See how Mulesoft does it: https://docs.mulesoft.com/mule-runtime/4.5/logging-and-debugging

cloudjumpercat · 2023-11-06T22:02:06Z

app/_src/gateway/production/debug-request.md

+This will return something like the following:
+
+```bash
+X-Kong-Request-Id: a1a1530f8ddb6f6f2462916ae002b715


❗ For reviewers: The example output for this example and the following ones didn't match the previous one in the draft doc. I left them as-is just to get this out the door quickly. Should we make them match the first one or is this okay?

We should format it. They just copy/pasted the output without any formatting.

cloudjumpercat · 2023-11-06T22:04:08Z

app/gateway/changelog.md

@@ -12,6 +12,11 @@ For product versions that have reached the end of sunset support, see the [chang
 ## 3.5.0.0
 **Release Date** TBD

+### Features


❗ For reviewers: I think they said this will be backported into 2.8 and other supported versions, but I think the backport is happening in 2.8.4.5 (as marked on the KAG ticket), but that version isn't released yet and I'm not sure when it will be released and was wondering if anyone knew. I'm guessing we'll need to make a Jira ticket to back port this in our docs if it's not released at the same time as 3.5.

cloudjumpercat · 2023-11-07T14:18:55Z

app/_src/gateway/production/debug-request.md

@@ -0,0 +1,162 @@
+---
+title: Debug requests


❗ For reviewers: I did not test the examples because of the short turn around time. I can make a ticket for post-release to test these unless you think testing these is a blocker for docs release.

I think we should definitely test this guide, but we can publish for now and revisit - as long as we don't forget to do it.

Okay, made a Jira ticket for the week of the 13th to test this

app/_src/gateway/production/debug-request.md

lena-larionova · 2023-11-07T17:17:48Z

app/_src/gateway/production/debug-request.md

+This will return something like the following:
+
+```bash
+X-Kong-Request-Id: a1a1530f8ddb6f6f2462916ae002b715


We should format it. They just copy/pasted the output without any formatting.

app/_src/gateway/production/debug-request.md

lena-larionova · 2023-11-07T17:20:56Z

app/gateway/changelog.md

@@ -12,6 +12,11 @@ For product versions that have reached the end of sunset support, see the [chang
 ## 3.5.0.0
 **Release Date** TBD

+### Features
+#### Enterprise


Can you please remove this entry. I'll add it to #6471 instead to avoid conflicts.

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

cloudjumpercat · 2023-11-07T21:52:44Z

@lena-larionova Made changes based on your feedback, if you don't mind reviewing again

app/_data/docs_nav_gateway_3.5.x.yml

lena-larionova · 2023-11-07T22:20:53Z

app/_src/gateway/production/logging/debug-request.md

+
+If the `X-Kong-Request-Debug` header is set to `*`, timing information will be collected and exported for the current request.
+
+In {{site.ee_product_name}}, you can also specify a list of filters, separated by commas, to filter the scope of the time information that is collected. Each filters specifies which phase to collect timing information from. The following filters are supported:


In {{site.ee_product_name}}

Are filters an enterprise-specific feature?

@lena-larionova Yep, from what the Google doc said:

"(EE only) You can also specify a list of filters, separated by commas, to filter the scope of the time information that is collected. The following filters are supported:"

lena-larionova

LGTM with some minor edits. I'll let you make them and merge whenever you're ready :)

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* create 3.5 pages and bump version * feat(opentelemetry): propagate GCP trace header (#5829) feat(opentelemetry): propagate GCP header * feat(request-id): introduce Request ID (#6163) * feat(request-id): introduce Request ID Docs for Kong/kong#11624 where the Request ID is introduced. Few minor changes to the log serializer as well to make mapping between IDs easier. * fix if statement * fix if statement in other plugin --------- Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> * update submodule for 3.5 placeholders * feat(labels): add on premise dp labels (#6173) * Update plugin submodule to Lena's placeholder branch Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * feat(oidc): certificate bound access tokens (#6284) * feat(oidc): certificate bound access tokens Docs for: Kong/kong-ee#6446 * Apply copyedits and some minor formatting Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> --------- Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * GW 3.5 Self-hosted Portal and Vitals Sustaining Mode (#6341) * test * more deprecation * spelling on redirects * shot scraper * shot scraper * Feat: Add /schemas/vaults/:name endpoint [skip-ci] (#6347) Add 3.5 specs and schema vault endpoint * docs(vaults): add docs for Azure Key Vault support in Kong Gateway (#6215) * docs(vaults): add docs for Azure Key Vault support in Kong Gateway Signed-off-by: Joshua Schmid <jaiks@posteo.de> * fixes Signed-off-by: Joshua Schmid <jaiks@posteo.de> * nav bar * copy edits * style --------- Signed-off-by: Joshua Schmid <jaiks@posteo.de> Co-authored-by: Angel <Guaris@users.noreply.github.com> Co-authored-by: Angel <angel.guarisma@konghq.com> * feat: kong gateway's aws vault backend now supports automatic IAM credential fetch and role assuming (#6181) * feat: kong gateway's aws vault backend now supports automatic IAM credential fetch and role assuming * apply suggestions * update docs Co-authored-by: Hans Hübner <hans.huebner@gmail.com> * copy edit --------- Co-authored-by: Hans Hübner <hans.huebner@gmail.com> Co-authored-by: Angel <angel.guarisma@konghq.com> Co-authored-by: Angel <Guaris@users.noreply.github.com> * fix: cert bound access token conditional rendering (#6349) Add conditional rendering for cert-bound access tokens, fix note formatting Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * feat: Kong Manager forced workspace deletion (#6327) * Update workspace deletion instructions, add changelog entry about forced KM workspace deletion Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * Consolidate delete workspace sections, fix changelog formatting Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * Add missing API option to auto delete entities Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * Fix kong-plugin submodule sha Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> * Fix step formatting, clarify what entities are deleted Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * Add conditional rendering Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * Conditionally render the delete workspace section, remove Portal CLI from 3.5 instructions Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> --------- Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> * Feat: Rename Kong Enterprise to Kong Gateway Enterprise (#6372) * kong enterprise rename * update product name and use variables wherever possible * feature tables alignment with longer name * add some missing enterprise badges; use correct variables on gateway overview * appease vale * remove broken links * update the admin_gui_auth_conf of the OIDC (#6331) * update the admin_gui_auth_conf of the OIDC * fix vale error * Update app/_src/gateway/kong-manager/auth/oidc/configure.md Co-authored-by: Makito <sumimakito@hotmail.com> * Update app/_src/gateway/kong-manager/auth/oidc/configure.md Co-authored-by: Makito <sumimakito@hotmail.com> * Add conditional rendering, revise the table, make copy edits Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> --------- Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> Co-authored-by: Makito <sumimakito@hotmail.com> Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * feat: aws lambda plugin now supports more IAM-based authentication scenarios (#6002) * feat: aws lambda plugin now supports more IAM-based authentication scenarios * Add to vale dictionary, fix conditional rendering, copyedits Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> --------- Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * feat(license_report): update description of licensing report (#6307) * feat(license_report): update description of licensing report * version the source file * comment out 3.4 source file until 3.4 patch goes out --------- Co-authored-by: lena.larionova <yelena.larionova@gmail.com> Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> * feat: dedicated config processing (#6442) * feat: dedicated config processing Signed-off-by: Joshua Schmid <jaiks@posteo.de> * minor formatting edits * remove backticks from around hybrid --------- Signed-off-by: Joshua Schmid <jaiks@posteo.de> Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> * feat(openid-connect): cert-bound tokens doc edits (#6441) feat(openid-connect): cert-bound tokens typos few typos and rewording of the openid-connect certificate-bound tokens feature * chore: Update Gateway config reference for 3.5 (#6445) update config reference for 3.5 * chore: Remove performance testing framework from 3.5 (#6452) remove performance testing framework from 3.5 * chore: Copy over nav changes from 3.4 to 3.5 (#6455) * copy over nav changes from 3.4 to 3.5 * use better url for consumer groups * Gateway 3.5 Autodocs (#6419) * Autodocs * update spec * Chore: Support matrix updates for Gateway 3.5 (#6470) add EOL date for 3.5; update PG supported versions * chore: Replace mockbin with httpbin/httpbun (#6453) * replace mockbin with httpbin/httpbun * Update app/_src/gateway/get-started/proxy-caching.md Co-authored-by: Angel <Guaris@users.noreply.github.com> --------- Co-authored-by: Angel <Guaris@users.noreply.github.com> * chore: add compatibility updates for Gateway 3.5 release (#6474) * chore: add compatibility updates for Gateway 3.5 release Adds version compatibility issues for gateway v3.5. Rewords "data plane" -> "data plane node". * fix: formatting and names * change single quote to backtick --------- Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> * docs(plugins): add docs about `plugin:configure` handler (#6463) * docs(plugins): add docs about `plugin:configure` handler ### Summary In Kong 3.5 we added `plugin:configure` as an additional handler that is called each time there is a change in Kong plugin iterator. This commit adds documentation for it. Signed-off-by: Aapo Talvensaari <aapo.talvensaari@gmail.com> * if_version + cleanup --------- Signed-off-by: Aapo Talvensaari <aapo.talvensaari@gmail.com> Co-authored-by: Angel <angel.guarisma@konghq.com> * Add wasm filter config schema document (#6459) * Add wasm filter config schema document * fix indents & add missing chapter metadata * Apply suggestions from code review Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> * revert some unintentional whitespace changes * relocate draft-4 disclaimer * rework request/response format --------- Co-authored-by: lena.larionova <yelena.larionova@gmail.com> Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> * chore: Dev Portal broken links (#6484) * fix redirects * re-add deleted redirects --------- Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> * Release 3.5 Changelog (#6471) * save * changelog * formatting and cleanup; rephrase the Dev Portal and Vitals entry + add to breaking changes * copyedit changelog and add plugin changelog entries to plugin changelogs * add fix entry for oidc plugin in 3.5 * backport missing plugin changelog entries to 3.4 * add a couple of entries to breaking changes * add links to docs * Apply suggestions from code review Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * add some more links; apply reviewer feedback --------- Co-authored-by: lena.larionova <yelena.larionova@gmail.com> Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * Chore: update upgrade paths for Gateway 3.5 (#6482) * Add 3.5 upgrade path to table, remove duplicate links to general upgrade instructions Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * Update based on LTS versions Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> --------- Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * feat: Request Debug Header docs for Kong Gateway 3.5 (#6475) * Add request debug header page to 3.5 as well as changelog Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> * Remove changelog entry Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * Move debug request to logging section Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * Move debug request doc to logging folder, reformat json examples Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> * Move debug request file to stop test from failing Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> --------- Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> --------- Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> Signed-off-by: Joshua Schmid <jaiks@posteo.de> Signed-off-by: Aapo Talvensaari <aapo.talvensaari@gmail.com> Co-authored-by: lena.larionova <yelena.larionova@gmail.com> Co-authored-by: Jon Ruskin <jon.ruskin@gmail.com> Co-authored-by: Samuele <samuele@konghq.com> Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> Co-authored-by: Joshua Schmid <joshua.schmid@konghq.com> Co-authored-by: Qirui(Keery) Nie <windmgc@gmail.com> Co-authored-by: Hans Hübner <hans.huebner@gmail.com> Co-authored-by: Xiaoyan Rao <270668624@qq.com> Co-authored-by: Makito <sumimakito@hotmail.com> Co-authored-by: Michael Heap <m@michaelheap.com> Co-authored-by: Yufu Zhao <ms2008vip@gmail.com> Co-authored-by: Alex Gaesser <alex.gaesser@konghq.com> Co-authored-by: Aapo Talvensaari <aapo.talvensaari@gmail.com> Co-authored-by: Michael Martin <flrgh@protonmail.com>

Add request debug header page to 3.5 as well as changelog

ece3793

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

cloudjumpercat added the review:copyedit Request for writer review. label Nov 6, 2023

cloudjumpercat added this to the Gateway 3.5 milestone Nov 6, 2023

cloudjumpercat requested a review from a team as a code owner November 6, 2023 22:00

cloudjumpercat commented Nov 6, 2023

View reviewed changes

lena-larionova self-assigned this Nov 6, 2023

cloudjumpercat commented Nov 7, 2023

View reviewed changes

lena-larionova requested changes Nov 7, 2023

View reviewed changes

cloudjumpercat and others added 4 commits November 7, 2023 15:13

Apply suggestions from code review

a873a98

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

Remove changelog entry

16a8f2f

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

Move debug request to logging section

fa2802f

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

Move debug request doc to logging folder, reformat json examples

102bea0

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

cloudjumpercat requested a review from lena-larionova November 7, 2023 21:52

lena-larionova reviewed Nov 7, 2023

View reviewed changes

app/_data/docs_nav_gateway_3.5.x.yml Outdated Show resolved Hide resolved

lena-larionova reviewed Nov 7, 2023

View reviewed changes

lena-larionova approved these changes Nov 7, 2023

View reviewed changes

lena-larionova mentioned this pull request Nov 7, 2023

Release 3.5 Changelog #6471

Merged

cloudjumpercat and others added 2 commits November 8, 2023 08:40

Apply suggestions from code review

06afc4a

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

Move debug request file to stop test from failing

421a3ea

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

cloudjumpercat merged commit 0b4ff5a into release/gateway-3.5 Nov 8, 2023

cloudjumpercat deleted the feat/request-debug-header branch November 8, 2023 15:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Request Debug Header docs for Kong Gateway 3.5 #6475

feat: Request Debug Header docs for Kong Gateway 3.5 #6475

cloudjumpercat commented Nov 6, 2023 •

edited

Loading

netlify bot commented Nov 6, 2023 •

edited

Loading

cloudjumpercat Nov 6, 2023

lena-larionova Nov 7, 2023

cloudjumpercat Nov 6, 2023

lena-larionova Nov 7, 2023

cloudjumpercat Nov 6, 2023

cloudjumpercat Nov 7, 2023

lena-larionova Nov 7, 2023

cloudjumpercat Nov 7, 2023

lena-larionova Nov 7, 2023

lena-larionova Nov 7, 2023

cloudjumpercat commented Nov 7, 2023

lena-larionova Nov 7, 2023

cloudjumpercat Nov 8, 2023

lena-larionova left a comment


		If the `X-Kong-Request-Debug` header is set to `*`, timing information will be collected and exported for the current request.

		In {{site.ee_product_name}}, you can also specify a list of filters, separated by commas, to filter the scope of the time information that is collected. Each filters specifies which phase to collect timing information from. The following filters are supported:

feat: Request Debug Header docs for Kong Gateway 3.5 #6475

feat: Request Debug Header docs for Kong Gateway 3.5 #6475

Conversation

cloudjumpercat commented Nov 6, 2023 • edited Loading

Description

Testing instructions

Checklist

netlify bot commented Nov 6, 2023 • edited Loading

✅ Deploy Preview for kongdocs ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cloudjumpercat commented Nov 7, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lena-larionova left a comment

Choose a reason for hiding this comment

cloudjumpercat commented Nov 6, 2023 •

edited

Loading

netlify bot commented Nov 6, 2023 •

edited

Loading