docs: add logging section for control/data planes & DNS by dascole · Pull Request #2198 · kumahq/kuma-website

dascole · 2025-02-25T15:59:12Z

This commit adds a new section to the troubleshooting guide for logging. It includes information on how to enable debug logging for the control and data planes, as well as how to enable debug logging for DNS.

This partially addresses issue #1302 by providing initial documentation for logging. Further work is needed to complete the full scope of the issue.

Did you sign your commit? Instructions
Have you read Contributing guidelines?

netlify · 2025-02-25T15:59:34Z

✅ Deploy Preview for kuma ready!

Name	Link
🔨 Latest commit	`0cf0701`
🔍 Latest deploy log	https://app.netlify.com/sites/kuma/deploys/6806fe66de937600088ddac4
😎 Deploy Preview	https://deploy-preview-2198--kuma.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 87 (🔴 down 10 from production) Accessibility: 90 (no change from production) Best Practices: 100 (no change from production) SEO: 92 (no change from production) PWA: 80 (no change from production) View the detailed breakdown and full score reports

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

bartsmykla

tabs needs to be adjusted here after: #2216

* feat(tf): render tf tab Signed-off-by: slonka <slonka@users.noreply.github.com> * feat(tf): arrays sort of work Signed-off-by: slonka <slonka@users.noreply.github.com> * feat(tf): commas in arrays work Signed-off-by: slonka <slonka@users.noreply.github.com> * feat(tf): seems to render quite correctly now Signed-off-by: slonka <slonka@users.noreply.github.com> * feat(tf): top part looks good Signed-off-by: slonka <slonka@users.noreply.github.com> * feat(tf): render from uni style Signed-off-by: slonka <slonka@users.noreply.github.com> * feat(tf): render only when not kuma Signed-off-by: slonka <slonka@users.noreply.github.com> * feat(tf): update golden files Signed-off-by: slonka <slonka@users.noreply.github.com> * feat(tf): make all keys snake_case Signed-off-by: slonka <slonka@users.noreply.github.com> * feat(tf): use snake_case fn everywhere Signed-off-by: slonka <slonka@users.noreply.github.com> * feat(tf): no need to if else on tf tab Signed-off-by: slonka <slonka@users.noreply.github.com> * feat(tf): add a guard for 2.10.x onwards Signed-off-by: slonka <slonka@users.noreply.github.com> --------- Signed-off-by: slonka <slonka@users.noreply.github.com> Signed-off-by: dascole <joe.dascole@konghq.com>

This commit adds a new section to the troubleshooting guide for logging. It includes information on how to enable debug logging for the control and data planes, as well as how to enable debug logging for DNS. This partially addresses issue kumahq#1302 by providing initial documentation for logging. Further work is needed to complete the full scope of the issue. Signed-off-by: dascole <joe.dascole@konghq.com>

Resolve lint errors in troubleshooting.md Signed-off-by: dascole <joe.dascole@konghq.com>

Address the linting issue from 'Adjusting Logging Levels for Kuma-DP' Signed-off-by: dascole <joe.dascole@konghq.com>

Address 'Adjusting Logging Levels for Kuma-DP' Signed-off-by: dascole <joe.dascole@konghq.com>

Signed-off-by: dascole <joe.dascole@konghq.com>

Signed-off-by: dascole <72866937+dascole@users.noreply.github.com>

dascole · 2025-03-12T16:26:38Z

Tabs have been adjusted to align with #2216

Signed-off-by: Lukasz Dziedziak <lukidzi@gmail.com>

Signed-off-by: dascole <72866937+dascole@users.noreply.github.com>

jijiechen · 2025-04-22T02:17:37Z

app/_src/guides/logging.md

+    metadata:
+      annotations:
+        kuma.io/envoy-log-level: debug
+        kuma.io/envoy-component-log-level: dns:debug


this line is not for "all components"

Suggested change

kuma.io/envoy-component-log-level: dns:debug

app/_src/guides/logging.md

Co-authored-by: Jay Jijie Chen <1180092+jijiechen@users.noreply.github.com> Signed-off-by: dascole <72866937+dascole@users.noreply.github.com>

jijiechen · 2025-04-22T02:25:34Z

app/_src/guides/logging.md

+{% endtab %}
+{% tab Universal %}
+
+In Universal mode, logging can be enabled by setting the environment variable `KUMA_RUNTIME_KUBERNETES_INJECTOR_BUILTIN_DNS_LOGGING`.


Universal DPs use KUMA_DNS_ENABLE_LOGGING, insead of KUMA_RUNTIME_KUBERNETES_INJECTOR_BUILTIN_DNS_LOGGING

jijiechen

Thanks for the contribution and I think we do need docs helping people diagnostic the mesh.

jijiechen · 2025-04-22T02:29:48Z

jekyll-kuma-plugins/lib/jekyll/kuma-plugins/liquid/tags/policyyaml.rb


            use_meshservice = @params["use_meshservice"] == "true" && Gem::Version.new(release.value.dup.sub "x", "0") >= TARGET_VERSION
+
+            show_tf = Gem::Version.new(release.value.dup.sub "x", "0") >= TARGET_VERSION


this change is not needed, right?

jijiechen · 2025-04-22T02:34:33Z

app/_src/guides/logging.md

+```yaml
+containers:
+  - name: control-plane
+    image: "docker.io/kong/kuma-cp:2.9.3"


the image field is not correct for kuma. We may just remove it.

The same suggestion applys to other code snippets underneath.

jijiechen · 2025-04-22T02:40:53Z

app/_data/docs_nav_kuma_2.10.x.yml

+        group: true
+        items:
+          - text: Logging
+            url: /guides/logging


I think it's better to put it under "Using Kuma". WDYT @bartsmykla ?

dascole requested a review from a team as a code owner February 25, 2025 15:59

dascole requested review from johncowen and lobkovilya and removed request for a team February 25, 2025 15:59

bartsmykla requested changes Mar 7, 2025

View reviewed changes

dascole force-pushed the feat/add-troubleshooting-guide branch from f620d8a to 883d9cf Compare March 12, 2025 16:05

slonka and others added 6 commits March 12, 2025 12:06

Fix: Linting issues

41ee043

Resolve lint errors in troubleshooting.md Signed-off-by: dascole <joe.dascole@konghq.com>

Fix: Linting issue for logging levels

73e16f1

Address the linting issue from 'Adjusting Logging Levels for Kuma-DP' Signed-off-by: dascole <joe.dascole@konghq.com>

Fix: Linting issues in logging.md

ad775d8

Address 'Adjusting Logging Levels for Kuma-DP' Signed-off-by: dascole <joe.dascole@konghq.com>

Fix: Adjust tabs layout after updates in kumahq#2216

4b1d4cc

Signed-off-by: dascole <joe.dascole@konghq.com>

dascole force-pushed the feat/add-troubleshooting-guide branch from 76c24ec to 4b1d4cc Compare March 12, 2025 16:06

Merge branch 'master' into feat/add-troubleshooting-guide

089a7a9

Signed-off-by: dascole <72866937+dascole@users.noreply.github.com>

lukidzi and others added 8 commits March 13, 2025 08:05

Merge branch 'master' into feat/add-troubleshooting-guide

17169f9

Signed-off-by: Lukasz Dziedziak <lukidzi@gmail.com>

Merge branch 'master' into feat/add-troubleshooting-guide

a41428f

Signed-off-by: dascole <72866937+dascole@users.noreply.github.com>

Merge branch 'master' into feat/add-troubleshooting-guide

232edc6

Merge branch 'master' into feat/add-troubleshooting-guide

8fb6b6f

Signed-off-by: dascole <72866937+dascole@users.noreply.github.com>

Merge branch 'master' into feat/add-troubleshooting-guide

972dc19

Merge branch 'master' into feat/add-troubleshooting-guide

df0315f

Merge branch 'master' into feat/add-troubleshooting-guide

1f361ea

Merge branch 'master' into feat/add-troubleshooting-guide

4e55e88

dascole requested a review from bartsmykla March 25, 2025 16:08

dascole added 4 commits March 31, 2025 20:52

Merge branch 'master' into feat/add-troubleshooting-guide

608164b

Merge branch 'master' into feat/add-troubleshooting-guide

d7c1ce9

Merge branch 'master' into feat/add-troubleshooting-guide

89c2870

Merge branch 'master' into feat/add-troubleshooting-guide

2a8f4c4

jijiechen reviewed Apr 22, 2025

View reviewed changes

app/_src/guides/logging.md Outdated Show resolved Hide resolved

Update app/_src/guides/logging.md

d78ce15

Co-authored-by: Jay Jijie Chen <1180092+jijiechen@users.noreply.github.com> Signed-off-by: dascole <72866937+dascole@users.noreply.github.com>

jijiechen reviewed Apr 22, 2025

View reviewed changes

Merge branch 'master' into feat/add-troubleshooting-guide

0cf0701

jijiechen reviewed Apr 22, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add logging section for control/data planes & DNS#2198

docs: add logging section for control/data planes & DNS#2198
dascole wants to merge 21 commits intokumahq:masterfrom
dascole:feat/add-troubleshooting-guide

dascole commented Feb 25, 2025

Uh oh!

netlify bot commented Feb 25, 2025 •

edited

Loading

Uh oh!

bartsmykla left a comment

Uh oh!

dascole commented Mar 12, 2025

Uh oh!

jijiechen Apr 22, 2025

Uh oh!

Uh oh!

jijiechen Apr 22, 2025

Uh oh!

jijiechen left a comment

Uh oh!

jijiechen Apr 22, 2025

Uh oh!

jijiechen Apr 22, 2025

Uh oh!

jijiechen Apr 22, 2025

Uh oh!

jijiechen Apr 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants


		use_meshservice = @params["use_meshservice"] == "true" && Gem::Version.new(release.value.dup.sub "x", "0") >= TARGET_VERSION

		show_tf = Gem::Version.new(release.value.dup.sub "x", "0") >= TARGET_VERSION

Conversation

dascole commented Feb 25, 2025

Uh oh!

netlify bot commented Feb 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for kuma ready!

Uh oh!

bartsmykla left a comment

Choose a reason for hiding this comment

Uh oh!

dascole commented Mar 12, 2025

Uh oh!

jijiechen Apr 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jijiechen Apr 22, 2025

Choose a reason for hiding this comment

Uh oh!

jijiechen left a comment

Choose a reason for hiding this comment

Uh oh!

jijiechen Apr 22, 2025

Choose a reason for hiding this comment

Uh oh!

jijiechen Apr 22, 2025

Choose a reason for hiding this comment

Uh oh!

jijiechen Apr 22, 2025

Choose a reason for hiding this comment

Uh oh!

jijiechen Apr 22, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

netlify bot commented Feb 25, 2025 •

edited

Loading