-
Notifications
You must be signed in to change notification settings - Fork 10.4k
[DEX] device monitoring #19388
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DEX] device monitoring #19388
Changes from 4 commits
61fb5e0
d49418e
ede25cc
a8d3fb9
26c5b59
c62293e
2ab8508
1e3b1d1
9743397
c4d74fb
bd60664
f101a02
d56fae3
0d78296
d546e77
e84040b
d64ccb4
a2ff467
22a7e2a
447b619
dd3ecc4
0318e39
933d3fa
3e6421e
f72511a
9a62366
393fc3b
e64b85b
945ca5a
3050f51
a5461ff
040e3c5
877bc1a
ccdcfe7
f0d1a30
adff48f
d577839
e513050
efb3c65
7d6843f
1f04cd4
16e1eb0
1431c71
0de7277
8a4641d
978b721
121ac23
8d6f73b
5efb3f7
e8fc5ae
9924ce3
aa85897
ce942b5
ebfa7fb
23f5fe6
8b4afc3
26bc22c
cc64576
4e83a8d
77b8f1f
566109d
ff40a5e
f70fd32
0737d5b
06b44d9
3a67d34
7ce9119
23daf72
3dd4b6a
b4ddb33
75b9599
47b4ea0
32bd768
a6b42c9
5a5b1a4
3b78203
29c5543
d446cd5
bc3e186
75e4b70
a3a6dd8
9b14d0f
8e8261c
fe394d3
26c0e78
2929ff6
826e29f
b6bb13a
be357cc
fce447c
4e77862
cb34739
dc9725f
9ca479f
7035ed2
87a9aee
b3986b8
7559497
86ee4dd
9fdb4ac
9aeb7ee
7593026
e3932ce
2df401e
7176f04
093a41b
0950040
b582388
513dc7a
688ac88
8df3fd9
ec948ed
28f23a4
9443f6a
50d3bd6
d5bbe06
38fbc54
16c18cd
3b1d6fd
954ee52
2c9b394
d24363e
b4a18a4
b611cea
dc68133
5f8028d
f12788b
26c5761
8f83043
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| --- | ||
| pcx_content_type: reference | ||
| title: Monitoring | ||
| sidebar: | ||
| order: 1 | ||
| --- | ||
|
|
||
| Monitor your organization's [fleet status](/cloudflare-one/insights/dex/monitoring/#fleet-status) as well as performance and network status for individual [user devices](/cloudflare-one/insights/dex/monitoring/#device-monitoring). | ||
|
|
||
| ## Fleet status | ||
|
|
||
| A fleet is a collection of user devices. All devices in a fleet have WARP installed and are connected to a [Cloudflare Zero Trust organization](/cloudflare-one/setup/#create-a-zero-trust-organization). | ||
|
|
||
| To view fleet status and an overview of all enrolled devices: | ||
|
|
||
| 1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **DEX** > **Monitoring**. | ||
| 2. In **DEX Monitoring**, review the information under the **Fleet Status** tab. | ||
|
|
||
| ### View fleet metrics | ||
|
|
||
| The **Fleet Status** tab will show real-time and historical connectivity metrics for all devices in your organization. | ||
|
|
||
| To view analytics on a per-device level, go to [Device monitoring](/cloudflare-one/insights/dex/monitoring/#device-monitoring). | ||
|
|
||
| ### Available fleet metrics | ||
|
|
||
| - **Devices connected by colo**: Number of devices that are connected to a given [Cloudflare data center](https://www.cloudflarestatus.com/). | ||
|
|
||
| - **Connectivity status**: Percentage of devices in a given WARP client state. | ||
|
|
||
| | Status | Description | | ||
| | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | Connected | WARP has successfully established a connection to the Cloudflare global network. | | ||
| | Disconnected | WARP has been intentionally or unintentionally disconnected from the Cloudflare global network. | | ||
| | Paused | A user or administrator has taken an explicit action to temporarily turn off WARP, for example by entering an [Admin Override](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-settings/#admin-override) code. Paused clients will [auto-connect](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-settings/#auto-connect) after a timeout period. | | ||
| | Connecting | WARP is pending connection, but is actively trying to establish a connection to the Cloudflare global network. | | ||
|
|
||
| - **Mode**: [WARP mode](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-modes/) deployed on the device. | ||
|
|
||
| - **Colo**: Percentage of devices connected to a given Cloudflare data center. | ||
|
|
||
| - **Platform**: Operating system of the device. | ||
|
|
||
| - **Major Version**: WARP client version installed on the device. | ||
|
|
||
| - **Device Status Over Time**: WARP client connection status over the selected time period. | ||
|
|
||
| - **Connection Methods Over Time**: WARP mode used by the device over the selected time period. | ||
|
|
||
| ## Device monitoring | ||
|
|
||
| Review network and device performance for a device enrolled in your fleet. | ||
|
|
||
| Network and device performance data helps IT administrators to troubleshoot performance issues, investigate network connectivity problems, and monitor device health. | ||
|
|
||
| ### View a device's performance | ||
|
|
||
| To view a device's network and device performance metrics: | ||
|
|
||
| 1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **My team** > **Devices**. | ||
| 2. Select a device > **View details**. | ||
| 3. Select the **DEX** tab > in **Device Monitoring**, scroll down to **Network performance** and **Device Performance**. | ||
|
|
||
| ### Network and device performance metrics | ||
|
|
||
| #### Network performance metrics | ||
|
|
||
| - **Unique networks over time**: How many unique SSIDs the device was connected to. | ||
|
|
||
| - **Network I/O**: How much data has been transferred (uploads and downloads) between the device and the network. | ||
|
|
||
| #### Device performance metrics | ||
|
|
||
| - **Battery percentage and cycles**: Compares battery percentage to battery health over time. Used to debug potential performance issues possibly related to power-saving measures that are triggered at low-battery levels. | ||
|
||
|
|
||
| - **CPU usage**: CPU utilization over time. Used to debug slow system performance due to high CPU usage. | ||
|
|
||
| - **Memory utilization**: Memory utilization over time. Used to debug performance issues related to an overtaxed memory. | ||
|
|
||
| - **Disk I/O**: Displays number of disk bytes read/write operations over time. Used to debug performance errors due to heavy disk operations. | ||
|
||
| Original file line number | Diff line number | Diff line change | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -5,7 +5,7 @@ sidebar: | |||||||||||||||
| order: 4 | ||||||||||||||||
| --- | ||||||||||||||||
|
|
||||||||||||||||
| import { Details } from "~/components" | ||||||||||||||||
| import { Details } from "~/components"; | ||||||||||||||||
|
|
||||||||||||||||
| <Details header="Feature availability"> | ||||||||||||||||
|
|
||||||||||||||||
|
|
@@ -15,12 +15,12 @@ import { Details } from "~/components" | |||||||||||||||
|
|
||||||||||||||||
| | System | Availability | Minimum WARP version | | ||||||||||||||||
| | -------- | ------------ | -------------------- | | ||||||||||||||||
| | Windows | ✅ | 2024.12.492.0 | | ||||||||||||||||
| | macOS | ✅ | 2024.12.492.0 | | ||||||||||||||||
| | Linux | ✅ | 2024.12.492.0 | | ||||||||||||||||
| | iOS | ❌ | | | ||||||||||||||||
| | Android | ❌ | | | ||||||||||||||||
| | ChromeOS | ❌ | | | ||||||||||||||||
| | Windows | ✅ | 2024.12.492.0 | | ||||||||||||||||
| | macOS | ✅ | 2024.12.492.0 | | ||||||||||||||||
| | Linux | ✅ | 2024.12.492.0 | | ||||||||||||||||
| | iOS | ❌ | | | ||||||||||||||||
| | Android | ❌ | | | ||||||||||||||||
| | ChromeOS | ❌ | | | ||||||||||||||||
|
|
||||||||||||||||
| </Details> | ||||||||||||||||
|
|
||||||||||||||||
|
|
@@ -33,22 +33,18 @@ To capture data from a remote device: | |||||||||||||||
| 1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **DEX** > **Remote captures**. | ||||||||||||||||
| 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. | ||||||||||||||||
| 3. Configure the types of captures to run. | ||||||||||||||||
| - **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)). | ||||||||||||||||
| - **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**. | ||||||||||||||||
| :::note | ||||||||||||||||
| **Test all routes** will extend the time for diagnostics to run and may temporarily impact device performance during the test. | ||||||||||||||||
| ::: | ||||||||||||||||
| - **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)). | ||||||||||||||||
| - **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**. | ||||||||||||||||
| :::note | ||||||||||||||||
| **Test all routes** will extend the time for diagnostics to run and may temporarily impact device performance during the test. | ||||||||||||||||
| ::: | ||||||||||||||||
| 4. Select **Start a capture**. | ||||||||||||||||
|
|
||||||||||||||||
| DEX will now send capture requests to the configured devices. If the WARP client is disconnected, the capture will time out after 10 minutes. | ||||||||||||||||
|
|
||||||||||||||||
| ## Check remote capture status | ||||||||||||||||
|
|
||||||||||||||||
| To view a list of captures, go to **DEX** > **Remote captures**. The **Status** column displays one of the following options: | ||||||||||||||||
| - **Success**: The capture is complete and ready for download. Any partially successful captures will still upload to Cloudflare. For example, there could be a scenario where the PCAP succeeds on the primary network interface but fails on the WARP tunnel interface. You can [review PCAP results](/cloudflare-one/insights/dex/remote-captures/#download-remote-captures) to determine which PCAPs succeeded or failed. | ||||||||||||||||
| - **Running**: The capture is in progress on the device. | ||||||||||||||||
| - **Pending Upload**: The capture is complete but not yet ready for download. | ||||||||||||||||
| - **Failed**: The capture has either timed out or encountered an error. To retry the capture, check the WARP client version and [connectivity status](/cloudflare-one/insights/dex/fleet-status/), then start a [new capture](/cloudflare-one/insights/dex/remote-captures/#start-a-remote-capture). | ||||||||||||||||
| To view a list of captures, go to **DEX** > **Remote captures**. The **Status** column displays one of the following options: - **Success**: The capture is complete and ready for download. Any partially successful captures will still upload to Cloudflare. For example, there could be a scenario where the PCAP succeeds on the primary network interface but fails on the WARP tunnel interface. You can [review PCAP results](/cloudflare-one/insights/dex/remote-captures/#download-remote-captures) to determine which PCAPs succeeded or failed. - **Running**: The capture is in progress on the device. - **Pending Upload**: The capture is complete but not yet ready for download. - **Failed**: The capture has either timed out or encountered an error. To retry the capture, check the WARP client version and [connectivity status](/cloudflare-one/insights/dex/monitoring/#fleet-status), then start a [new capture](/cloudflare-one/insights/dex/remote-captures/#start-a-remote-capture). | ||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||
|
|
||||||||||||||||
| ## Download remote captures | ||||||||||||||||
|
|
||||||||||||||||
|
|
@@ -61,6 +57,7 @@ This will download a ZIP file to your local machine called `<capture-id>.zip`. D | |||||||||||||||
| ### Device PCAP contents | ||||||||||||||||
|
|
||||||||||||||||
| The downloaded PCAP folder contains three files: | ||||||||||||||||
|
|
||||||||||||||||
| - `capture-default.pcap`: Packet captures for the primary network interface. | ||||||||||||||||
| - `capture-tunnel.pcap`: Packet captures for traffic inside of the WARP tunnel. | ||||||||||||||||
| - `results.json`: Reports successful and failed packet captures. | ||||||||||||||||
|
|
@@ -74,8 +71,8 @@ Refer to [WARP diagnostic logs](/cloudflare-one/connections/connect-devices/warp | |||||||||||||||
| ## Limitations | ||||||||||||||||
|
|
||||||||||||||||
| - Packet captures are subject to the following limits: | ||||||||||||||||
| - **Maximum time limit**: 600 seconds | ||||||||||||||||
| - **Maximum file size**: 50 MB | ||||||||||||||||
| - **Maximum packet size**: 1500 bytes | ||||||||||||||||
| - **Maximum time limit**: 600 seconds | ||||||||||||||||
| - **Maximum file size**: 50 MB | ||||||||||||||||
| - **Maximum packet size**: 1500 bytes | ||||||||||||||||
| - WARP diagnostic logs have no file size limit, but files larger than 100 MB cannot be uploaded to Cloudflare and must be shared directly with the admin. | ||||||||||||||||
| - Windows devices do not support concurrent remote captures. If you start a remote capture while another is in progress, the second capture will fail immediately. | ||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we say something like
"How much data has been transferred (uploads and downloads) over the primary network interface."?