Skip to content

Commit 7cdcb2d

Browse files
final edits to first draft
1 parent 08bafe8 commit 7cdcb2d

File tree

2 files changed

+76
-54
lines changed

2 files changed

+76
-54
lines changed

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

Lines changed: 72 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ This guide helps you diagnose and resolve common issues with the Cloudflare WARP
1111

1212
1. **Before you start**: [Prerequisites](#prequisites), permissions, [version control](#check-your-warp-version) and WARP basics.
1313
2. **Collect logs**: Through the [dashboard]() (with DEX remote capture) or the [command-line interface](#option-b-collect-logs-via-the-cli) (CLI) (`warp-diag`).
14-
3. **Review logs**: [Status](#check-warp-status), [settings](#check-warp-settings), [profile ID](#wrong-profile-id), [split tunnel](#wrong-split-tunnel-configuration) configuration.
15-
4. **Fix common misconfigurations**: Profile mismatch, split tunnel issues, managed network issues.
16-
5. **File a support ticket**: What to include to solve your issue faster.
14+
3. **Review logs**: [Status](#check-warp-status), [settings](#check-warp-settings), [profile ID](#profile-id), [split tunnel](#exclude-mode-with-hostsips) configuration.
15+
4. **Fix common misconfigurations**: [Profile mismatch](#wrong-profile-id), [split tunnel issues](#wrong-split-tunnel-configuration), [managed network issues](#review-your-managed-network-settings).
16+
5. **File a support ticket**: [How to file a ticket](#file-a-support-ticket) after you have exhausted your troubleshooting options.
1717

1818
## 1. Before you start
1919

@@ -29,6 +29,16 @@ Many troubleshooting issues are caused by outdated client versions. For the best
2929

3030
After updating the WARP client, monitor the issue to see if it recurs. If the issue persists, continue with the troubleshooting guide.
3131

32+
:::tip[Check the device's WARP version]
33+
34+
To a device's WARP version:
35+
36+
1. Open the WARP GUI on the desktop.
37+
2. Select the gear icon.
38+
3. Select **About WARP**.
39+
40+
:::
41+
3242
### WARP basics
3343

3444
Review the WARP client’s architecture, installation paths, and modes to help you diagnose issues with greater accuracy.
@@ -49,31 +59,28 @@ WARP operates in several modes, each with different traffic handling capabilitie
4959

5060
## 2. Collect diagnostic logs
5161

52-
You can collect diagnostic logs in two ways: the [Cloudflare dashboard](#option-a-collect-logs-via-the-cloudflare-dashboard) or the [`warp-diag`]() command-line interface (CLI).
62+
You can collect diagnostic logs in two ways: the [Cloudflare dashboard](#option-a-collect-logs-via-the-cloudflare-dashboard) or the [`warp-diag`](#option-b-collect-logs-via-the-cli) command-line interface (CLI).
5363

5464
### Option A: Collect logs via the Cloudflare dashboard
5565

5666
For WARP client versions higher than `2024.12.492.0`, you can collect diagnostic logs remotely from the Zero Trust dashboard by using Digital Experience Monitoring's (DEX) remote captures.
5767

5868
#### Start a remote capture
5969

60-
<Render file="dex/pcaps-run" />
61-
6270
:::tip[Best practice]
6371

64-
To troubleshoot effectively, Cloudflare recommends that you recreate the steps where your issue emerges when capturing logs. Though recreating the issue may not be possible in all cases, the following troubleshooting regimen will ensure the most accurate capture of the state of WARP:
65-
66-
1. In **Zero Trust** > **DEX** > **Remote captures**, select **WARP diagnostic logs** and **Packet captures (PCAP)**. You can leave **Test all routes** unselected.
67-
2. Select **Run diagnostics**.
68-
3. While the diagnostics are running on the target device, recreate the steps that cause the problem.
72+
To troubleshoot effectively, Cloudflare recommends reproducing the issue and noting your timestamps immediately before collecting logs. Though recreating the issue may not be possible in all cases, reproducing the issue right before WARP diag collection or during the window that a PCAP is running will help you troubleshoot with greater visibility.
6973

70-
If you set your **Time limit** on the **Remote captures** page to five minutes, recreate the steps that cause the problem on the target device in that five minute window before logs are generated. Keep timestamps of when you executed your steps to successfully review logs later.
74+
Refer to [WARP log retention window](/cloudflare-one/connections/connect-devices/warp/troubleshooting/warp-logs/#log-retention-window) to learn more.
75+
:::
7176

72-
4. [Check the status](/cloudflare-one/connections/connect-devices/warp/troubleshooting/troubleshooting-guide/#check-remote-capture-status) of your remote capture to verify its readiness.
73-
5. [Download the remote captures](/cloudflare-one/connections/connect-devices/warp/troubleshooting/troubleshooting-guide/#check-remote-capture-status) when they have finished running.
77+
<Render
78+
file="dex/pcaps-run"
79+
params={{
80+
bestPractice: 'You must select WARP Diagnostic Logs. You can also choose to run a PCAP and reproduce the issue in the window the PCAP is running to gain further network insight. The scope of this troubleshooting covers only WARP diagnostic logs. If not choosing PCAPs, reproduce the right issue before running diagnostics.'
81+
}}
82+
/>
7483

75-
By following these steps, you will ensure that your WARP diagnostic logs have captured WARP activity relevant to your issue.
76-
:::
7784

7885
#### Check remote capture status
7986

@@ -99,9 +106,9 @@ To troubleshoot effectively, Cloudflare recommends that you recreate the steps w
99106

100107
After you have your diagnostic files, go to [Review diagnostic logs](/cloudflare-one/connections/connect-devices/warp/troubleshooting/troubleshooting-guide/#2-review-diagnostics-logs) to continue troubleshooting.
101108

102-
## 2. Review diagnostics logs
109+
## 3. Review key files
103110

104-
WARP diagnostic logs display WARP information relevant to the target device after all MDM and other software operations have been applied, allowing you to determine whether WARP is misconfigured or behaving in an unexpected way. After downloading the WARP diagnostic logs, you will review key files to check that WARP is operating as intended. You will check the device's WARP status, its applied profile ID, and its split tunnel configuration.
111+
WARP diagnostic logs capture the final WARP configuration and status on a device after all MDM policies and other software settings have been applied. Reviewing these logs can help you identify misconfigurations or unexpected behavior.
105112

106113
### Check WARP status
107114

@@ -129,7 +136,7 @@ Merged configuration:
129136
(network policy) WARP tunnel protocol: WireGuard
130137
(default) Disabled for Wifi: false
131138
(default) Disabled for Ethernet: false
132-
(reg defaults) Resolve via: 1xx0x1011xx000000000f0x00000x11.cloudflare-gateway.com @ [1xx.1xx.1x.1, 1x01:1x00:1x00::1xx1] <- The SNI Cloudflare will use and the IP address for DNS-over-HTTP (DoH) requests
139+
(reg defaults) Resolve via: 1xx0x1011xx000000000f0x00000x11.cloudflare-gateway.com @ [1xx.1xx.1x.1, 1x01:1x00:1x00::1xx1] # The SNI Cloudflare will use and the IP address for DNS-over-HTTP (DoH) requests
133140
(user set) qlog logging: Enabled
134141
(default) Onboarding: true # If true, the user sees a onboarding prompt when they first install the WARP client
135142
(network policy) Exclude mode, with hosts/ips: # Split tunnel configuration
@@ -146,11 +153,11 @@ Merged configuration:
146153
(network policy) Captive Portal: 180
147154
(network policy) Support URL: my-organizations-support-portal.com # Your organization's support portal or IT help desk
148155
(user set) Organization: Organization-Name
149-
(network policy) Allow Mode Switch: true # The user is allowed to switch between WARP with configurations (DoH -> Gateway Mode)
150-
(network policy) Allow Updates: false <------- Will the client perform the update checks, doesn't necessarily mean they'll be able to install them (depends on user permissions)
151-
(network policy) Allowed to Leave Org: true <-- Is the button in the GUI grayed out or not. Note, it'll always be grayed out if they have an MDM file
156+
(network policy) Allow Mode Switch: true # The user is allowed to switch between WARP modes
157+
(network policy) Allow Updates: false # WARP client will not perform update checks
158+
(network policy) Allowed to Leave Org: true
152159
(api defaults) Known apple connectivity check IPs: xx.xxx.0.0/16;
153-
(network policy) LAN Access Settings: Allowed until reconnect on a /24 subnet <-- The maximum size of network that will be allowed when Access Lan is clicked.
160+
(network policy) LAN Access Settings: Allowed until reconnect on a /24 subnet # The maximum size of network that will be allowed when Access Lan is clicked.
154161
(network policy) Profile ID: 000000x1-00x1-1xx0-1xx1-11101x1axx11
155162
```
156163

@@ -251,7 +258,7 @@ Refers to the [Device profile](/cloudflare-one/connections/connect-devices/warp/
251258
Profile ID: 000000x1-00x1-1xx0-1xx1-11101x1axx11
252259
```
253260

254-
## Common misconfiguration issues and solutions
261+
## 4. Fix common misconfigurations
255262

256263
To verify that WARP is configured and working properly, review the following:
257264

@@ -264,7 +271,7 @@ A profile ID is a unique identifier assigned to each [device profile]((/cloudfla
264271

265272
If your organization has multiple device profiles defined in the Zero Trust dashboard, a device may be matched to an unexpected profile due to lack of precise matcing rules or how profile precedence is configured.
266273

267-
:::tip[WARP evaluates profile IDs according to chronological order in the dashboard]
274+
:::note[WARP evaluates profile IDs according to chronological order in the dashboard]
268275

269276
<Render file="warp/device-profile-order-of-precedence" />
270277

@@ -312,12 +319,6 @@ When troubleshooting a managed network, check these things:
312319

313320
To simplify management and prevent errors, avoid creating multiple managed network profiles for the same location. For example, if you have multiple TLS endpoints in one office, link them all to a single device profile. This reduces the risk of a device matching an unintended profile due to a configuration error.
314321

315-
// are 2 and 3 saying the same thing //
316-
317-
3. Ensure the device can only reach one managed network.
318-
319-
If a device can reach more than one managed network simultaneously, WARP cannot determine which profile to apply, leading to unpredictable results. Make sure the managed network configuration is unique to each location.
320-
321322
### Wrong split tunnel configuration
322323

323324
<Render file="warp/split-tunnel-intro" />
@@ -350,15 +351,15 @@ If your dashboard split tunnel configuration does not match your `warp-settings.
350351

351352
If your `warp-settings.txt` split tunnel configuration is not matching what is in the dashboard, you can force the WARP client to fetch the latest configuration to resolve the discrepancy. You can either instruct the end user to toggle WARP off and on, reset their encryption keys, or force the fetch as an admin. All three options will result in the WARP client fetching the latest data.
352353

353-
##### Toggle WARP off and back on
354+
##### Option A: Toggle WARP off and back on
354355

355356
On the end user device, open the WARP GUI and toggle WARP on and off.
356357

357358
If the end user's WARP switch is locked, they will need an admin override code to be able to toggle the WARP switch.
358359

359360
After you toggle WARP back on, the WARP client will fetch new settings when it reconnects.
360361

361-
##### Reset the encryption keys
362+
##### Option B: Reset the encryption keys
362363

363364
To reset the encyrption keys on an end user's desktop:
364365

@@ -368,35 +369,53 @@ To reset the encyrption keys on an end user's desktop:
368369

369370
Resetting the encryption keys forces the WARP client to reestablish its tunnel and retrieve the latest configuration.
370371

371-
##### Revoke the user session
372-
373-
An administrator can revoke the user's session to force a complete reenrollment.
372+
##### Option C: Revoke the user session
374373

375-
1. In the Zero Trust dashboard, go to My Team > Users.
374+
An administrator can revoke the user's session from the Cloudflare dashboard to force a complete reenrollment.
376375

376+
1. In the Zero Trust dashboard, go to **My Team** > **Users**.
377377
2. Select the checkbox next to the user's name.
378-
379-
3. Select Action > Revoke access.
378+
3. Select **Action** > **Revoke access**.
380379

381380
Revoking access will prompt the user to log back in. The WARP client will then perform a new registration and fetch the latest settings from the dashboard.
382381

383382
To debug quickly that the Split Tunnels settings have been updated, run `warp-cli settings` on the device and review the configuration again.
384383

385-
## File a support ticket
386-
387-
To ensure faster resolution when contacting support, include as much relevant detail as possible in your ticket. Make sure your ticket includes:
388-
389-
`[]` Context: Briefly describe the scenario or use case (for example, where the user was, what they were trying to do).
390-
`[]` Steps taken so far: Outline any troubleshooting or changes already attempted.
391-
`[]` Timestamps: Be specific — include the exact time and time zone when the issue occurred.
392-
393-
For example:
384+
## 5. File a support ticket
385+
386+
To ensure efficient resolution when [contacting support](/support/contacting-cloudflare-support/), include as much relevant detail as possible in your ticket:
387+
388+
<ul>
389+
<li>
390+
<label>
391+
<input type="checkbox" /> Context: Briefly describe the scenario or use case (for example, where the user was, what they were trying to do).
392+
</label>
393+
</li>
394+
<li>
395+
<label>
396+
<input type="checkbox" /> Steps taken so far: Outline any troubleshooting or changes already attempted.
397+
</label>
398+
</li>
399+
<li>
400+
<label>
401+
<input type="checkbox" /> Timestamps: Be specific and include the exact time and time zone when the issue occurred.
402+
</label>
403+
</li>
404+
<li>
405+
<label>
406+
<input type="checkbox" /> WARP diagnostics logs: Include the WARP diag you downloaded from the dashboard or through the CLI.
407+
</label>
408+
</li>
409+
</ul>
410+
411+
:::danger[Avoid vague ticket descriptions]
412+
Refer to the following example of a vague ticket description:
394413

395-
❌ Avoid:
396414
Ken was on the train and had captive portal issues. `warp-diag` is attached.
415+
:::
397416

398-
✅ More helpful:
399-
Karen was on a train on July 17, 2025, at approximately 1:00 PM Central Time. She attempted to connect to a captive portal but received the following error message in Chrome: `error_message_details`. A warp-diag was collected immediately after and is attached.
400-
401-
417+
:::tip[Include scenario, timestamps, and steps taken to troubleshoot the issue]
418+
Refer to the following example of an ideal ticket description:
402419

420+
Karen was on a train on July 17, 2025, at approximately 1:00 PM Central Time. She attempted to connect to a captive portal but received the following error message in Chrome: `error_message_details`. A warp-diag was collected immediately after and is attached.
421+
:::

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
2-
{}
2+
inputParameters: bestPractice
33
---
44

5+
import { Render } from "~/components";
6+
57
To capture data from a remote device:
68

79
1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **DEX** > **Remote captures**.
@@ -12,6 +14,7 @@ To capture data from a remote device:
1214
:::note
1315
**Test all routes** will extend the time for diagnostics to run and may temporarily impact device performance during the test.
1416
:::
17+
{props.bestPractice}
1518
4. Select **Run diagnostics**.
1619

1720
DEX will now send capture requests to the configured devices. If the WARP client is disconnected, the capture will time out after 10 minutes.

0 commit comments

Comments
 (0)