From cb4811c22bc6aa2ea5dd8a833ca24c8dce4d3fc6 Mon Sep 17 00:00:00 2001
From: Ranbel Sun <ranbel@cloudflare.com>
Date: Thu, 10 Oct 2024 17:01:28 -0400
Subject: [PATCH] add warp-diag files

---
 .../warp/troubleshooting/warp-logs.mdx        | 71 ++++++++++---------
 1 file changed, 39 insertions(+), 32 deletions(-)

diff --git a/src/content/docs/cloudflare-one/connections/connect-devices/warp/troubleshooting/warp-logs.mdx b/src/content/docs/cloudflare-one/connections/connect-devices/warp/troubleshooting/warp-logs.mdx
index e05e6028ee3c3d..0bb873a0e95d38 100644
--- a/src/content/docs/cloudflare-one/connections/connect-devices/warp/troubleshooting/warp-logs.mdx
+++ b/src/content/docs/cloudflare-one/connections/connect-devices/warp/troubleshooting/warp-logs.mdx
@@ -57,68 +57,75 @@ The `warp-debugging-info-<date>-<time>.zip` archive contains the following files
 
 | File name  | Description   |
 | --- | --- |
-| `alternate-networks-check.txt` | |
+| `.qlog`| QLog files used to debug MASQUE connection issues.|
+| `.pcap` | Packet capture (PCAP) files that were manually generated using `warp-cli debug pcap` commands. |
+| `alternate-networks-check.txt` | Connectivity status for each [managed network](/cloudflare-one/connections/connect-devices/warp/configure-warp/managed-networks/). |
 | `boringtun.log` | Log for the WARP tunnel that serves traffic from the device to Cloudflare's global network. |
-| `bound-dns-ports.txt` | |
-| `captive-portal-hotspot-detect.txt` | |
-| `connectivity.txt`  | DNS resolution and HTTP trace requests to [validate a successful connection](/cloudflare-one/connections/connect-devices/warp/deployment/firewall/#connectivity-check).|
-| `daemon_dns.log` | Contains detailed DNS logs if **Log DNS queries** was enabled on WARP.  |
+| `bound-dns-ports.txt` | Active processes on port `53`.  |
+| `captive-portal-hotspot-detect.txt` | HTTP response of `captive.apple.com`|
+| `connectivity.txt`  | DNS resolution and HTTP trace requests to [validate a successful connection](/cloudflare-one/connections/connect-devices/warp/deployment/firewall/#connectivity-check). Can be used to determine whether traffic is routing through the WARP tunnel. |
+| `daemon_dns.log` | Contains detailed DNS logs if **Log DNS queries** is enabled in the WARP client. |
 | `daemon.log`                                                                                        | Detailed log of all actions performed by the WARP client, including all communication between the device and Cloudflare's global network. **Note:** This is the most useful debug log.   |
 | `date.txt`  | Date and time (UTC) when you ran the `warp-diag` command.  |
-| `dex.log`  |  |
-| `dhcp-lease-plists.txt`  |  |
-| `dhcp-lease.txt`  |  |
-| `dig.txt`  |  |
+| `dex.log`  | ? |
+| `dhcp-lease-plists.txt`  | DHCP lease information from `/var/db/dhcpclient/leases/` for each interface that has a DHCP lease. |
+| `dhcp-lease.txt`  | DHCP lease information from `ipconfig` (macOS) or `nmcli` (Linux). |
+| `dig.txt`  | DNS lookup query output for `cloudflare.com` and `apple.com`. |
 | `dns_stats.log`  | Statistics on the DNS queries received and resolved by WARP, generated every two minutes.  |
 | `dns-check.txt` | Verifies that the WARP DNS servers are set as system default. For [operating modes](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/) where DNS filtering is enabled, this file contains the IPs of the local WARP DNS proxy (`127.0.2.2:0`, `127.0.2.3:0`, `[fd01:db8:1111::2]:0`, and `[fd01:db8:1111::3]:0`). |
-| `dynamic.log` | |
+| `dynamic.log` | ? |
 | `etc-hosts.txt`  | Static DNS config of device.  |
-| `firewall-pfctl-all.txt` | |
-| `firewall-rules.txt` | |
-| `gui-launcher.log` | macOS console log showing application launch  |
+| `firewall-pfctl-all.txt` | Packet filter (pf) firewall configuration (macOS only). |
+| `firewall-rules.txt` | The [system firewall rules](/cloudflare-one/connections/connect-devices/warp/configure-warp/route-traffic/warp-architecture/#system-firewall) configured by WARP. |
+| `gui-launcher.log` | macOS console log showing application launch.  |
 | `gui-log.log`  | Log file for the GUI app that users interact with. |
 | `hostname.txt` | Name of the device.  |
 | `ifconfig.txt` <br/> `ipconfig.txt`  | IP configuration of each network interface.  |
-| `installed_applications.text` | |
-| `installed_cert.pem` | |
-| `installer.log` <br/> `InstallHistory.plist` <br/> `msi-installer.log` <br/> `macos_installer.log` | MSI or PKG installation logs  |
-| `ipc.log` | |
-| `lauchd-dumpstate.txt` | |
-| `local_policy.redacted.txt` | [Managed deployment parameters](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/) on the device. |
+| `installed_applications.text` | List of installed applications. |
+| `installed_cert.pem` | [Root certificate](/cloudflare-one/connections/connect-devices/warp/user-side-certificates/) installed on the system. |
+| `installer.log` <br/> `msi-installer.log` | MSI or PKG installation log.|
+| `InstallHistory.plist` <br/> `macos_installer.log` | macOS software installation logs. |
+| `ipc.log` | Logs IPC communication between the GUI and daemon. Useful for situations where the GUI crashes or is unable to communicate with the daemon. |
+| `kernel-modules.txt` | List of loaded kernel modules (macOS and Linux) or drivers (Windows).|
+| `launchd-dumpstate.txt` | Current state of the macOS `launchd system` including the loaded jobs, their status, and dependencies. |
+| `local_policy.redacted.txt`<br/> `mdm.plist` <br/> `mdm.xml`| [Managed deployment parameters](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/parameters/) on the device. |
+| `lsb-release.txt` |  Output from the `lsb_release` command (Linux only). |
 | `netstat.txt` <br/> `routetable.txt` | Routing table used by the device.  |
 | `netstat-v6.txt` | IPv6 routing table (Linux only). |
 | `platform.txt` | Operating system of the device.  |
 | `ps.txt` <br/> `processes.txt` | List of all active processes on the device when `warp-diag` was run.  |
 | `resolv.conf` | The contents of the `/etc/resolv.conf` file on Mac/Linux, where system DNS servers are configured. |
 | `route.txt` | Output from the `ip route get` command, used to verify that network traffic is going over the correct interface. You can optionally use the `warp-diag --enable-all-routes` flag to include tests for all IPs and domains in your Split Tunnel configuration. |
-| `scutil-dns.txt` | DNS configuration on Mac/Linux (available in `ipconfig.txt` on Windows).  |
-| `scutil-networkinfo.txt` | ? (available in `interfaces-config.txt` on Windows). |
-| `scutil-proxy.txt` | Proxy configuration on Mac/Linux (available in `ipconfig.txt` on Windows).  |
-| `snapshots-collection.log` | |
+| `scutil-dns.txt` | DNS configuration on macOS/Linux (available in `ipconfig.txt` on Windows).  |
+| `scutil-networkinfo.txt` | IPv4 and IPv6 network interface configuration on macOS (available in `interfaces-config.txt` on Windows). |
+| `scutil-proxy.txt` | Proxy configuration on macOS/Linux (available in `ipconfig.txt` on Windows).  |
+| `snapshots-collection.log` | Logs generated when collecting `snapshots/*.log`. Used to debug why WARP failed to collect a snapshot. |
+| `snapshots/*.log` | Diagnostics generated when an error occurs. |
 | `stats.log`  | Uptime and throughput stats for the WARP tunnel, generated every two minutes.  |
 | `sw-vers.txt`  | Operating system of the device.  |
 | `sysinfo.json` | CPU and memory usage when `warp-diag` was run. This information is useful for determining whether slow speeds are due to heavy system load.  |
-| `system-extension-diagnostics.txt` | |
+| `system-extension-diagnostics.txt` | Status and health of loaded system extensions (macOS only). |
 | `systeminfo.txt` <br/> `system-profile.txt` | System software overview.  |
-| `taskdump.log` | |
+| `System.evtx` | Windows system event log. |
+| `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/connections/connect-devices/warp/deployment/firewall/#warp-ingress-ip) showing the path from the device to Cloudflare's global network. |
 | `uname.txt`  | Linux-only system information including kernel version. |
 | `v4interfaces.txt` <br/> `v4subinterfaces.txt` <br/> `v6interfaces.txt` <br/> `v6subinterfaces.txt` | IPv4 and IPv6 network configuration on Windows.   |
 | `version.txt`  | [WARP client version](/cloudflare-one/connections/connect-devices/warp/download-warp/) installed on the device. |
 | `warp-account.txt` | WARP client device enrollment information.  |
-| `warp-bus-metrics.txt` | |
-| `warp-device-posture.txt` | [Device posture data](/cloudflare-one/identity/devices/warp-client-checks/) obtained by the WARP client. |
-| `warp-dex-data.txt` | |
-| `warp-dns-fallbacks.txt` | |
-| `warp-dns-lock.json` | |
+| `warp-bus-metrics.txt` | Metrics for the internal message bus framework used by the WARP client. |
+| `warp-device-posture.txt` | Current [device posture](/cloudflare-one/identity/devices/warp-client-checks/) status. |
+| `warp-dex-data.txt` | Currently configured [DEX tests](/cloudflare-one/insights/dex/tests/) and their most recent statuses. |
+| `warp-dns-fallbacks.txt` | List of default DNS fallbacks used by the WARP DNS proxy. |
+| `warp-dns-lock.json` | Default DNS providers and network interface information. |
 | `warp-dns-stats.txt` | Summary of recent DNS queries on the device since `dns-stats.log` was generated.  |
 | `warp-network.txt` | Network settings on the device detected by WARP.  |
 | `warp-settings.txt`  | [WARP client settings](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-settings/) applied to the device.  |
 | `warp-stats.txt` | Uptime and throughput of the WARP tunnel since `stats.log` was generated. |
 | `warp-status.txt` | Status of WARP switch (`Connected` or `Disconnected`). |
-| `wdutil-info.txt` | |
-| `xpc-launchd.log` | |
+| `wdutil-info.txt` | Wi-Fi diagnostics (macOS only). |
+| `xpc-launchd.log` | Most recent log file for the `launchd` process on macOS. |
 
 #### Multiple versions of the same log