Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] kerberos debug instructions #15779

Merged
merged 7 commits into from
Jan 12, 2024
Merged

Conversation

kaisecheng
Copy link
Contributor

@kaisecheng kaisecheng commented Jan 10, 2024

add instructions to enable kerberos debug log

Fixes: #15802

@kaisecheng kaisecheng requested a review from jsvd January 10, 2024 14:19
@kaisecheng kaisecheng changed the title add kerberos debug instructions [Doc] kerberos debug instructions Jan 10, 2024
docs/static/troubleshoot/ts-kafka.asciidoc Outdated Show resolved Hide resolved
docs/static/troubleshoot/ts-kafka.asciidoc Show resolved Hide resolved
docs/static/troubleshoot/ts-kafka.asciidoc Outdated Show resolved Hide resolved
@jsvd jsvd requested a review from karenzone January 10, 2024 15:13
Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments inline for your consideration--one wrt formatting and one wrt next steps. Please let me know if you'd like to discuss or iterate.

docs/static/troubleshoot/ts-kafka.asciidoc Outdated Show resolved Hide resolved
@karenzone karenzone self-assigned this Jan 11, 2024
@karenzone
Copy link
Contributor

karenzone commented Jan 11, 2024

@kaisecheng , thanks for adding this! I added myself as an assignee fso that we can track this effort in platform-docs.

@kaisecheng
Copy link
Contributor Author

@karenzone Thanks for the review. I have accepted the suggestion and made a small change.

@@ -173,7 +173,7 @@ You can set up your machine to help you troubleshoot authentication failures in
+
[source,txt]
-----
`-Dsun.security.krb5.debug=true` to `jvm.options`
-Dsun.security.krb5.debug=true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching and fixing this, @kaisecheng :-D

Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left one more comment about aligning the section heading with content in the topic. Please consider it. Either way, LGTM. Thanks for adding this info!


NOTE: Logging entries for Kerberos are NOT sent through Log4j but go directly to the console.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The heading implies that we're giving steps for debugging, but we're only helping the user set up debugging. Can we provide more information, even something as simple as reworking the note to say, "Go to the console to see your log entries"?

Another approach would be to change the heading to "Setting up debugging for Kerberos SASL" to set expectations for what's in the topic.

@kaisecheng kaisecheng merged commit 081d8fc into main Jan 12, 2024
4 of 5 checks passed
@jsvd jsvd deleted the kaisecheng-doc-kerberos-log branch March 11, 2024 09:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc] add instructions on enabling Kerberos debug log
4 participants