Add information about extra debug logging#30993
Conversation
|
/bonk review |
|
|
||
| ### Extra debug logging | ||
|
|
||
| Enable extra debug logging with the command `warp-cli debug extra start`. Extra debug logging times out after 10 minutes unless you manually stop it with `warp-cli debug extra stop`. |
There was a problem hiding this comment.
Availability version would be good here. Can use 2026.5.0 as the min for now
…extra debug logging
|
Posted a review on PR #30993. What I found:
I also reminded the author to address the 3 outstanding review comments that haven't been pushed yet: availability version (2026.5.0), missing table rows for TCPIP/WFP traces, and the Windows ETL pcap note. |
Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>
|
/bonk review |
There was a problem hiding this comment.
Thanks for addressing the earlier feedback. The section is well-structured and the content looks accurate. A few remaining items from previous reviewers and minor style nits:
- cfzhixon's suggestion to add rows in the big table for TCPIP and WFP traces is still outstanding. The current
.etl/.xmlrow groups them together without specifying which trace type each file corresponds to. - csujedihy's comment about noting a single ETL for pcaps on Windows could be clearer. The current parenthetical mentions the ETL file but doesn't explicitly state that there is just one.
- Minor casing inconsistency:
.ETLin the bullet should be lowercase.etlto match the table.
|
Posted a review on PR #30993. What I found:
|
|
/bonk review |
1 similar comment
|
/bonk review |
There was a problem hiding this comment.
Nice work addressing the earlier rounds of feedback. The new Extra debug logging section is well-structured and the table updates cover the new file types well.
A few remaining items to tighten up:
-
.etlvs.xmldescriptions overlap. Line 66 says the.etlfile contains WFP captures, but line 67 says.xmlis also WFP trace files. It's unclear how these relate — is.xmlmetadata for the WFP capture inside.etl, or a separate trace format? cfzhixon previously noted they would split these up; the current descriptions still group things together in a way that's hard to follow. -
Terminology mismatch between table and bullet. The
*-traceroute-*.txtrow (line 121) refers to "edge API endpoint" while the bullet list (line 166) calls it "Device API endpoint." Please use the same name in both places. -
ETL retention phrasing. Line 159 is clearer than earlier iterations, but the subject of "retains" is still implicit. Consider:
- Packet captures (PCAPs) on all interfaces (on Windows, the original `.etl` file is preserved; normally it is converted to `.pcap` and then removed)
|
Posted a review on PR #30993. What I found:
|
|
/bonk review |
|
Posted a review on PR #30993. What I found:
|
…udflare-one-client/troubleshooting/diagnostic-logs.mdx Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>
|
/bonk review |
There was a problem hiding this comment.
The content is accurate and well-structured after the previous review rounds. I found two remaining style/consistency items in the Extra debug logging section:
- A minor grammar fix in the
.pcaptable row. - Capitalization and terminology alignment between the
*-traceroute-*.txttable row and the bullet list below it.
| | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | `.qlog` | QLog files used to debug MASQUE connection issues. | | ||
| | `.pcap` | Packet capture (PCAP) files that were manually generated using `warp-cli debug pcap` commands. | | ||
| | `.pcap` | Packet capture (PCAP) files manually generated using `warp-cli debug pcap` commands, or automatically with [extra debug logging](#extra-debug-logging). | |
There was a problem hiding this comment.
Minor grammar fix: use via instead of with so the verb carries through:
| | `.pcap` | Packet capture (PCAP) files manually generated using `warp-cli debug pcap` commands, or automatically with [extra debug logging](#extra-debug-logging). | | |
| | `.pcap` | Packet capture (PCAP) files manually generated using `warp-cli debug pcap` commands, or automatically generated via [extra debug logging](#extra-debug-logging). | |
| | `taskdump.log` | If the daemon hangs, this file will contain a dump of the currently running processes. This is helpful in debugging hangs, deadlocks, and tasks. | | ||
| | `timezone.txt` | Local timezone of the device specified as a UTC offset. | | ||
| | `traceroute.txt` | Traceroute to the [WARP ingress IPs](/cloudflare-one/team-and-resources/devices/cloudflare-one-client/deployment/firewall/#warp-ingress-ip) showing the path from the device to Cloudflare's global network. | | ||
| | `*-traceroute-*.txt` | One-shot traceroute to WARP ingress IPs, device API endpoint hostname and IPs, and DoH resolver hostname and IPs; started when [extra debug logging](#extra-debug-logging) is first enabled. | |
There was a problem hiding this comment.
Capitalize Device to match the bullet list (line 166):
| | `*-traceroute-*.txt` | One-shot traceroute to WARP ingress IPs, device API endpoint hostname and IPs, and DoH resolver hostname and IPs; started when [extra debug logging](#extra-debug-logging) is first enabled. | | |
| | `*-traceroute-*.txt` | One-shot traceroute to WARP ingress IPs, Device API endpoint hostname and IPs, and DoH resolver hostname and IPs; started when [extra debug logging](#extra-debug-logging) is first enabled. | |
Also, please align terminology with the bullet list (lines 164–168):
- WARP ingress IPs (table) vs Tunnel edge connection IPs (line 168). Use the same term in both places if they refer to the same thing.
- DoH resolver (table) vs DNS resolver (lines 164–165). Use the same term in both places.
|
Posted a review on PR #30993. What I found:
|
|
/bonk review |
There was a problem hiding this comment.
After multiple rounds of thorough review, the content is accurate, well-structured, and all prior feedback appears to be fully addressed.
What was resolved since earlier rounds:
- Version availability (2026.5.0) is noted.
.etland.xmltable rows clearly distinguish WFP/TCPIP trace content.- WFP is spelled out on first use in the
.etlrow. - Terminology is aligned between the table (
*-traceroute-*.txt) and bullet list (Device API endpoint, DNS resolver, Tunnel edge connection IPs). - The Windows
.etlretention note is technically accurate per cfzhixon. - Grammar in the
.pcaptable row is correct (“automatically generated via”).
No new MDX syntax or style-guide issues found. LGTM.
|
Posted an approving review on PR #30993. What I found after thorough analysis: All feedback from the previous six review rounds has been fully addressed in the current version of
No new MDX syntax issues, style-guide violations, or content inaccuracies were found. |
Summary
Adds information about
warp-cli debug extracommands, and about new diagnostic files collected by those commands.Documentation checklist