Skip to content

Commit c20a695

Browse files
ranbelranbel
authored
[ZT] warp-diag summary and detections (#24750)
* dex partials * update warp-diag page * create partial * fix link * edit intro
1 parent aae52c7 commit c20a695

File tree

7 files changed

+113
-43
lines changed

7 files changed

+113
-43
lines changed

‎src/content/docs/cloudflare-one/connections/connect-devices/warp/configure-warp/device-profiles.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ warp-cli settings
127127

128128
The device profile UUID is shown in the `Profile ID` field.
129129

130-
Alternatively, if you do not have access to the CLI, you can use [DEX remote captures](/cloudflare-one/insights/dex/remote-captures/) to generate a WARP diagnostic log. The `warp-settings.txt` log file will contain the output of `warp-cli settings`.
130+
Alternatively, if you do not have access to the CLI, you can use [DEX remote captures](/cloudflare-one/insights/dex/remote-captures/) to collect WARP diagnostic logs from the Zero Trust dashboard. The device profile UUID is shown in your [WARP diagnostics summary](/cloudflare-one/insights/dex/remote-captures/#view-warp-diagnostics-summary-beta) under `Profile ID`.
131131

132132
## Selectors
133133

‎src/content/docs/cloudflare-one/connections/connect-devices/warp/troubleshooting/warp-logs.mdx‎

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar:
66
label: Diagnostic logs
77
---
88

9-
import { TabItem, Tabs, Stream } from "~/components";
9+
import { TabItem, Tabs, Render, Stream } from "~/components";
1010

1111
The WARP client provides diagnostic logs that you can use to troubleshoot connectivity issues on a device.
1212

@@ -29,9 +29,9 @@ The WARP client provides diagnostic logs that you can use to troubleshoot connec
2929

3030
## macOS/Windows/Linux
3131

32-
### Retrieve logs
32+
### Collect logs via the CLI
3333

34-
To view WARP logs on desktop devices:
34+
To collect WARP diagnostic logs on your desktop:
3535

3636
<Tabs> <TabItem label="macOS">
3737

@@ -65,9 +65,21 @@ This will place a `warp-debugging-info-<date>-<time>.zip` in the same folder you
6565

6666
</TabItem> </Tabs>
6767

68-
:::note
69-
You can also use Digital Experience Monitoring to run `warp-diag` commands on remote devices. For more information, refer to [Remote captures](/cloudflare-one/insights/dex/remote-captures/).
70-
:::
68+
### Collect logs via the dashboard
69+
70+
<Render file="dex/pcaps-run-availability" product="cloudflare-one" />
71+
72+
You can collect WARP diagnostic logs remotely from the Zero Trust dashboard by using Digital Experience Monitoring (DEX) [remote captures](/cloudflare-one/insights/dex/remote-captures/).
73+
74+
<Render file="dex/pcaps-run" product="cloudflare-one" />
75+
76+
#### Download remote captures
77+
78+
<Render file="dex/pcaps-download" product="cloudflare-one" />
79+
80+
#### View WARP diagnostics summary (beta)
81+
82+
<Render file="dex/pcaps-view-warp-diag" product="cloudflare-one" />
7183

7284
### `warp-diag` logs
7385

@@ -172,7 +184,7 @@ Always check the timestamps at the end of each log file to verify the time range
172184

173185
## iOS/Android/ChromeOS
174186

175-
### Retrieve logs
187+
### Collect logs
176188

177189
To view WARP logs on mobile devices:
178190

‎src/content/docs/cloudflare-one/insights/dex/remote-captures.mdx‎

Lines changed: 8 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -5,42 +5,15 @@ sidebar:
55
order: 5
66
---
77

8-
import { Details } from "~/components";
8+
import { Details, Render } from "~/components";
99

10-
<Details header="Feature availability">
11-
12-
| [WARP modes](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/) | [Zero Trust plans](https://www.cloudflare.com/teams-pricing/) |
13-
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
14-
| <ul> <li> Gateway with WARP </li> <li> Secure Web Gateway without DNS Filtering </li> </ul> | All plans |
15-
16-
| System | Availability | Minimum WARP version |
17-
| -------- | ------------ | -------------------- |
18-
| Windows | ✅ | 2024.12.492.0 |
19-
| macOS | ✅ | 2024.12.492.0 |
20-
| Linux | ✅ | 2024.12.492.0 |
21-
| iOS | ❌ | |
22-
| Android | ❌ | |
23-
| ChromeOS | ❌ | |
24-
25-
</Details>
10+
<Render file="dex/pcaps-run-availability" product="cloudflare-one" />
2611

2712
Remote captures allow administrators to collect packet captures (PCAPs) and WARP diagnostic logs directly from end user devices. This data can be used to troubleshoot network problems, investigate security incidents, and identify performance bottlenecks.
2813

2914
## Start a remote capture
3015

31-
To capture data from a remote device:
32-
33-
1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **DEX** > **Remote captures**.
34-
2. Select up to 10 devices that you want to run a capture on. Devices must be [registered](/cloudflare-one/connections/connect-devices/warp/deployment/) in your Zero Trust organization.
35-
3. Configure the types of captures to run.
36-
- **PCAP**: Performs packet captures for traffic outside of the WARP tunnel (default network interface) and traffic inside of the WARP tunnel ([WARP virtual interface](/cloudflare-one/connections/connect-devices/warp/configure-warp/route-traffic/warp-architecture/#ip-traffic)).
37-
- **WARP Diagnostics Logs**: Generates a [WARP diagnostic log](/cloudflare-one/connections/connect-devices/warp/troubleshooting/warp-logs/#warp-diag-logs) of the past 96 hours. To include a routing test for all IPs and domains in your [Split Tunnel configuration](/cloudflare-one/connections/connect-devices/warp/configure-warp/route-traffic/split-tunnels/), select **Test all routes**.
38-
:::note
39-
**Test all routes** will extend the time for diagnostics to run and may temporarily impact device performance during the test.
40-
:::
41-
4. Select **Start a capture**.
42-
43-
DEX will now send capture requests to the configured devices. If the WARP client is disconnected, the capture will time out after 10 minutes.
16+
<Render file="dex/pcaps-run" product="cloudflare-one" />
4417

4518
## Check remote capture status
4619

@@ -53,11 +26,7 @@ To view a list of captures, go to **DEX** > **Remote captures**. The **Status**
5326

5427
## Download remote captures
5528

56-
1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **DEX** > **Remote captures**.
57-
2. Find a successful capture.
58-
3. Select the three-dot menu and select **Download**.
59-
60-
This will download a ZIP file to your local machine called `<capture-id>.zip`. DEX will store capture data according to our [log retention policy](/cloudflare-one/insights/logs/#log-retention).
29+
<Render file="dex/pcaps-download" product="cloudflare-one" />
6130

6231
### Device PCAP contents
6332

@@ -73,6 +42,10 @@ You can analyze `.pcap` files using Wireshark or another third-party packet capt
7342

7443
Refer to [WARP diagnostic logs](/cloudflare-one/connections/connect-devices/warp/troubleshooting/warp-logs/#warp-diag-logs) for a description of each file.
7544

45+
## View WARP diagnostics summary (beta)
46+
47+
<Render file="dex/pcaps-view-warp-diag" product="cloudflare-one" />
48+
7649
## Limitations
7750

7851
- Packet captures are subject to the following limits:

‎src/content/partials/cloudflare-one/dex/pcaps-download.mdx‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
{}
3+
---
4+
5+
1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **DEX** > **Remote captures**.
6+
2. Find a successful capture.
7+
3. Select the three-dot menu and select **Download**.
8+
9+
This will download a ZIP file to your local machine called `<capture-id>.zip`. DEX will store capture data according to our [log retention policy](/cloudflare-one/insights/logs/#log-retention).

‎src/content/partials/cloudflare-one/dex/pcaps-run-availability.mdx‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
{}
3+
---
4+
5+
import { Details } from "~/components";
6+
7+
<Details header="Feature availability">
8+
9+
| [WARP modes](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/) | [Zero Trust plans](https://www.cloudflare.com/teams-pricing/) |
10+
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
11+
| <ul> <li> Gateway with WARP </li> <li> Secure Web Gateway without DNS Filtering </li> </ul> | All plans |
12+
13+
| System | Availability | Minimum WARP version |
14+
| -------- | ------------ | -------------------- |
15+
| Windows | ✅ | 2024.12.492.0 |
16+
| macOS | ✅ | 2024.12.492.0 |
17+
| Linux | ✅ | 2024.12.492.0 |
18+
| iOS | ❌ | |
19+
| Android | ❌ | |
20+
| ChromeOS | ❌ | |
21+
22+
</Details>

‎src/content/partials/cloudflare-one/dex/pcaps-run.mdx‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
inputParameters: bestPractice
3+
---
4+
5+
import { Render } from "~/components";
6+
7+
Devices must be actively connected to the Internet for remote captures to run.
8+
9+
To capture data from a remote device:
10+
11+
1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **DEX** > **Remote captures**.
12+
2. Select up to 10 devices that you want to run a capture on. Devices must be [registered](/cloudflare-one/connections/connect-devices/warp/deployment/) in your Zero Trust organization.
13+
3. Configure the types of captures to run.
14+
- **Packet captures (PCAP)**: Performs packet captures for traffic outside of the WARP tunnel (default network interface) and traffic inside of the WARP tunnel ([WARP virtual interface](/cloudflare-one/connections/connect-devices/warp/configure-warp/route-traffic/warp-architecture/#ip-traffic)).
15+
- **WARP Diagnostics Logs**: Generates a [WARP diagnostic log](/cloudflare-one/connections/connect-devices/warp/troubleshooting/warp-logs/#warp-diag-logs) of the past 96 hours. To include a routing test for all IPs and domains in your [Split Tunnel configuration](/cloudflare-one/connections/connect-devices/warp/configure-warp/route-traffic/split-tunnels/), select **Test all routes**.
16+
:::note
17+
**Test all routes** will extend the time for diagnostics to run and may temporarily impact device performance during the test.
18+
:::
19+
{props.bestPractice}
20+
4. Select **Run diagnostics**.
21+
22+
DEX will now send capture requests to the configured devices. If the WARP client is disconnected, the capture will time out after 10 minutes.

‎src/content/partials/cloudflare-one/dex/pcaps-view-warp-diag.mdx‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
{}
3+
---
4+
5+
import { Details } from "~/components";
6+
7+
The WARP diagnostics summary highlights what Cloudflare determines to be the most important detection events in a `warp-diag` log. You can use the WARP diagnostic summary to help analyze your [log files](/cloudflare-one/connections/connect-devices/warp/troubleshooting/warp-logs/#warp-diag-logs) and identify the root cause of client issues. WARP diagnostic summaries are only available for logs [collected via the dashboard](#collect-logs-via-the-dashboard).
8+
9+
To access your WARP diagnostic summary:
10+
11+
1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **DEX** > **Remote captures**.
12+
2. Locate an existing `warp-diag` log from the list or select **Run diagnostics** to generate a new `warp-diag` log.
13+
3. Select the three dots for the `warp-diag` log that you want to analyze, then select **View WARP Diag**.
14+
15+
The **Overview** tab will display an AI-generated summary of the results, a list of detection events, and basic device information.
16+
<Details header="Explanation of the fields">
17+
| Field | Description |
18+
| ----- | ----------- |
19+
| Detection type | A common WARP issue that can appear in the diagnostic logs. |
20+
| Occurences | Number of times an issue was detected in the logs. |
21+
| Severity level | Indicates the impact of the issue on WARP client functionality. The severity levels are: <ul> <li> **Critical**: Issue causes complete loss of functionality. </li> <li> **Warning**: Issue causes degraded functionality but core features should still work. </li> <li> **No detection**: Issue was not detected in the logs. </li> </ul> |
22+
| Operating system | OS and OS version of the device. |
23+
| WARP version | [WARP release version](/cloudflare-one/connections/connect-devices/warp/download-warp/) |
24+
| Profile ID | [WARP device profile](/cloudflare-one/connections/connect-devices/warp/configure-warp/device-profiles/) UUID|
25+
| Service mode | [WARP mode](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/) |
26+
| Configuration name | Name of the [Zero Trust organization](/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/switch-organizations/) that WARP is connected to. |
27+
| Device ID | ID generated by the WARP client. |
28+
29+
</Details>
30+
4. Select a detection type for more information about the event and recommended next steps.
31+
32+
Cloudflare will store the `warp-diag` log and its summary per our [log retention policy](/cloudflare-one/insights/logs/#log-retention). To save a copy onto your local machine, [download the log file](#download-remote-captures) and go to the **JSON file** tab to copy the summary in JSON format.

0 commit comments

Comments
 (0)