[Nexthop] Documentation for debugging utilities#929
Open
anna-nexthop wants to merge 1 commit intofacebook:mainfrom
Open
[Nexthop] Documentation for debugging utilities#929anna-nexthop wants to merge 1 commit intofacebook:mainfrom
anna-nexthop wants to merge 1 commit intofacebook:mainfrom
Conversation
This PR adds comprehensive debugging documentation for FBOSS when the CLI is not available, typically when the hardware agent (`fboss_hw_agent`) is down or not responding. The new documentation covers: - Checking FBOSS service status with systemd - Viewing service logs with journalctl - Additional log file locations (boot history, snapshots) - Service dependency tree - Crash dump locations and analysis - Core dump management with coredumpctl - Using gdb for debugging - `wedge_qsfp_util` - Transceiver debugging with `--direct-i2c` - `weutil` - EEPROM information - `fw_util` - Firmware versions - `fixmyfboss` - Automated diagnostic tool - `showtech` - System information collection with `--details` options - Other diagnostic utilities - Configuration files - Platform information (including `dmidecode` for system info) - Warm boot state - SDK dumps - Building with debug symbols - Using debug builds with gdb - Attaching to running processes - Debugging core dumps - Hardware agent won't start - Service crashes immediately - No logs available - Verified all commands on actual FBOSS device - Tested documentation rendering in Docusaurus dev server - Confirmed all internal links work correctly - Validated that generic examples don't expose real hardware identifiers
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Pre-submission checklist
pip install -r requirements-dev.txt && pre-commit installpre-commit runSummary
This PR adds comprehensive debugging documentation for FBOSS when the CLI is not available, typically when the hardware agent (
fboss_hw_agent) is down or not responding.The new documentation covers:
Service Status and Logs
Crash Dumps and State Files
Direct Hardware Access Utilities
wedge_qsfp_util- Transceiver debugging with--direct-i2cweutil- EEPROM informationfw_util- Firmware versionsfixmyfboss- Automated diagnostic toolshowtech- System information collection with--detailsoptionsImportant Runtime Files and Directories
dmidecodefor system info)Debug Builds
GDB Debugging
Common Troubleshooting Scenarios
Test Plan