docs: add EdgeCore logging guide#795
Conversation
kubeedge-bot
added
kind/documentation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
kubeedge-bot
added
the
size/L
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new troubleshooting guide for EdgeCore logs, detailing diagnostic steps for various deployment modes and common failure scenarios. The review identified two technical inaccuracies: the nc command for connectivity checks was missing a port, and the documentation for mqttMode configuration values was incorrect. Both issues have been addressed with actionable suggestions.
This adds a comprehensive troubleshooting guide for checking EdgeCore logs during installation failures or runtime issues. This provides symmetry with the existing CloudCore logging documentation and helps users quickly diagnose edge-side problems like certificate mismatches, MQTT broker errors, and container runtime failures. Signed-off-by: Gurkaran Singh <gurkaranbirsingh@example.com>
Gurkaran18
force-pushed
the
docs/edgecore-logs-issue-6704
branch
from
940c6c7 to
939bd83
Compare
kubeedge-bot
removed
the
do-not-merge/invalid-commit-message
- Update nc command to check both 10000 and 10002 ports - Correct mqttMode configuration value to 0 for internal broker - Copy English docs to zh i18n directory to resolve broken Docusaurus links Signed-off-by: Gurkaran Singh <gurkaranbirsingh@example.com>
kubeedge-bot
added
size/XL
|
@anvithks @edisonxiang Gentle ping! All the CI checks are green and the code review suggestions from the bot have been resolved. Could you please take a look when you have a moment? Thank you! |
| @@ -0,0 +1,354 @@ | |||
| --- | |||
There was a problem hiding this comment.
is this supposed to be Chinese? cz this is under i18n/zh???
| @@ -0,0 +1,270 @@ | |||
| --- | |||
There was a problem hiding this comment.
same here, why we have duplicated edgecore-logs.md where is supposed to be Chinese doc?
| @@ -0,0 +1,270 @@ | |||
| --- | |||
There was a problem hiding this comment.
IMO this is very helpful information for end users once something happens to kubeedge system.
my suggestion is we probably improve https://github.com/kubeedge/website/blob/master/docs/faq/setup.md#how-to-check-edgecore-logs with new structure like this PR, instead of creating the whole new section.
3 participants
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This PR introduces the "Checking EdgeCore Logs" troubleshooting guide to the user documentation.
Currently, there is a comprehensive guide for diagnosing CloudCore issues, but users lack a centralized reference for troubleshooting edge-side log anomalies. This document provides symmetry to the documentation by detailing:
journaldvs container runtimes).x509certificate errors, WebSocket issues), internal MQTT broker (EventBus) failures, and Container Runtime CRI errors.Which issue(s) this PR fixes:
Fixes #6704
Special notes for your reviewer:
The formatting and tone strictly mirror the recently added
cloudcore-logs.mdguide to maintain consistency across the troubleshooting section.