docs: add logging section for control/data planes & DNS #2198
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dascole
requested review from
johncowen and
lobkovilya
and removed request for
a team
✅ Deploy Preview for kuma ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
bartsmykla
requested changes
Mar 7, 2025
Contributor
bartsmykla
left a comment
bartsmykla
left a comment
There was a problem hiding this comment.
tabs needs to be adjusted here after: #2216
dascole
force-pushed
the
feat/add-troubleshooting-guide
branch
from
f620d8a to
883d9cf
Compare
* feat(tf): render tf tab Signed-off-by: slonka <[email protected]> * feat(tf): arrays sort of work Signed-off-by: slonka <[email protected]> * feat(tf): commas in arrays work Signed-off-by: slonka <[email protected]> * feat(tf): seems to render quite correctly now Signed-off-by: slonka <[email protected]> * feat(tf): top part looks good Signed-off-by: slonka <[email protected]> * feat(tf): render from uni style Signed-off-by: slonka <[email protected]> * feat(tf): render only when not kuma Signed-off-by: slonka <[email protected]> * feat(tf): update golden files Signed-off-by: slonka <[email protected]> * feat(tf): make all keys snake_case Signed-off-by: slonka <[email protected]> * feat(tf): use snake_case fn everywhere Signed-off-by: slonka <[email protected]> * feat(tf): no need to if else on tf tab Signed-off-by: slonka <[email protected]> * feat(tf): add a guard for 2.10.x onwards Signed-off-by: slonka <[email protected]> --------- Signed-off-by: slonka <[email protected]> Signed-off-by: dascole <[email protected]>
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 <[email protected]>
Resolve lint errors in troubleshooting.md Signed-off-by: dascole <[email protected]>
Address the linting issue from 'Adjusting Logging Levels for Kuma-DP' Signed-off-by: dascole <[email protected]>
Address 'Adjusting Logging Levels for Kuma-DP' Signed-off-by: dascole <[email protected]>
Signed-off-by: dascole <[email protected]>
dascole
force-pushed
the
feat/add-troubleshooting-guide
branch
from
76c24ec to
4b1d4cc
Compare
Signed-off-by: dascole <[email protected]>
Contributor
Author
|
Tabs have been adjusted to align with #2216 |
Signed-off-by: Lukasz Dziedziak <[email protected]>
Signed-off-by: dascole <[email protected]>
Signed-off-by: dascole <[email protected]>
jijiechen
reviewed
Apr 22, 2025
| metadata: | ||
| annotations: | ||
| kuma.io/envoy-log-level: debug | ||
| kuma.io/envoy-component-log-level: dns:debug |
Member
There was a problem hiding this comment.
this line is not for "all components"
Suggested change
| kuma.io/envoy-component-log-level: dns:debug |
jijiechen
reviewed
Apr 22, 2025
Co-authored-by: Jay Jijie Chen <[email protected]> Signed-off-by: dascole <[email protected]>
jijiechen
reviewed
Apr 22, 2025
| {% endtab %} | ||
| {% tab Universal %} | ||
|
|
||
| In Universal mode, logging can be enabled by setting the environment variable `KUMA_RUNTIME_KUBERNETES_INJECTOR_BUILTIN_DNS_LOGGING`. |
Member
There was a problem hiding this comment.
Universal DPs use KUMA_DNS_ENABLE_LOGGING, insead of KUMA_RUNTIME_KUBERNETES_INJECTOR_BUILTIN_DNS_LOGGING
jijiechen
reviewed
Apr 22, 2025
Member
jijiechen
left a comment
jijiechen
left a comment
There was a problem hiding this comment.
Thanks for the contribution and I think we do need docs helping people diagnostic the mesh.
|
|
||
| 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 |
Member
There was a problem hiding this comment.
this change is not needed, right?
| ```yaml | ||
| containers: | ||
| - name: control-plane | ||
| image: "docker.io/kong/kuma-cp:2.9.3" |
Member
There was a problem hiding this comment.
the image field is not correct for kuma. We may just remove it.
Member
There was a problem hiding this comment.
The same suggestion applys to other code snippets underneath.
jijiechen
reviewed
Apr 22, 2025
| group: true | ||
| items: | ||
| - text: Logging | ||
| url: /guides/logging |
Member
There was a problem hiding this comment.
I think it's better to put it under "Using Kuma". WDYT @bartsmykla ?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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?