Skip to content

Commit 31f4ae0

Browse files
[DEX] rules docs
1 parent 2a03256 commit 31f4ae0

File tree

9 files changed

+139
-52
lines changed

9 files changed

+139
-52
lines changed

src/content/docs/cloudflare-one/insights/dex/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
pcx_content_type: navigation
33
title: Digital Experience Monitoring
44
sidebar:
5-
order: 2
5+
order: 1
66
---
77

88
import { DirectoryListing } from "~/components";

src/content/docs/cloudflare-one/insights/dex/monitoring.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
pcx_content_type: reference
33
title: Monitoring
44
sidebar:
5-
order: 1
5+
order: 2
66
---
77

88
Monitor performance and network status for your organization's [fleet](/cloudflare-one/insights/dex/monitoring/#fleet-status) or individual [user devices](/cloudflare-one/insights/dex/monitoring/#device-monitoring).

src/content/docs/cloudflare-one/insights/dex/notifications.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,13 @@
22
pcx_content_type: reference
33
title: Notifications
44
sidebar:
5-
order: 5
5+
order: 6
66
head:
77
- tag: title
88
content: DEX notifications
9-
109
---
1110

12-
import { AvailableNotifications } from "~/components"
11+
import { AvailableNotifications } from "~/components";
1312

1413
Administrators can receive alerts when Cloudflare detects connectivity issues with the WARP client or degraded application performance. Notifications can be delivered via email, webhook, and third-party services.
1514

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
pcx_content_type: reference
33
title: Remote captures
44
sidebar:
5-
order: 4
5+
order: 5
66
---
77

88
import { Details } from "~/components";
@@ -45,7 +45,8 @@ DEX will now send capture requests to the configured devices. If the WARP client
4545
## Check remote capture status
4646

4747
To view a list of captures, go to **DEX** > **Remote captures**. The **Status** column displays one of the following options:
48-
- **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.
48+
49+
- **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.
4950
- **Running**: The capture is in progress on the device.
5051
- **Pending Upload**: The capture is complete but not yet ready for download.
5152
- **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).
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
pcx_content_type: reference
3+
title: Rules
4+
sidebar:
5+
order: 4
6+
---
7+
8+
DEX rules allow you to create and manage testing policies for targeted user groups within your [fleet](/cloudflare-one/insights/dex/tests/). When you create a rule, you define the scope of a test to specific selectors such as departments (like finance or sales), devices, and/or users. You can apply and reuse rules on your desired [tests](/cloudflare-one/insights/dex/tests/).
9+
10+
DEX rules are ideal for admin who want to define the scope of a test to a specific group within their fleet to allow for efficient problem detection and resolution.
11+
12+
## Create a rule
13+
14+
To create a rule:
15+
16+
1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **DEX** > **Rules**.
17+
2. Select **Add a rule**.
18+
3. Give your rule a name and build your desired expressions.
19+
4. Select **Create rule** to finalize your rule.
20+
21+
### Selectors
22+
23+
Selectors are required categories in a DEX rule expression that define a group within a fleet. The selector(s) you have defined in a rule will determine which group a test will impact.
24+
25+
Review the available selectors and their scope in the following list.
26+
27+
| Selector | Description |
28+
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------ |
29+
| **User email** | For specifying user emails. |
30+
| **User group emails** | |
31+
| **User group IDs** | |
32+
| **User group names** | |
33+
| **Operating systems** | For specifying operating systems. |
34+
| **Operating system version** | For specifying an operating system version (use Operator `in`) or versions (use Operator `is`). |
35+
| **Managed network** | For specifying users accessing the network from the office (managed network) compared to those accessing remotely. |
36+
| **SAML attributes** | For advanced customization by leveraging SAML attributes. |
37+
| **Colos** | For specifying a specific Cloudflare data center location. |
38+
39+
## Add a rule to a test
40+
41+
After you have created a rule, you can add it to a test. If you do not add a rule to a test, the test will run on your entire device fleet.
42+
43+
To add a rule to a test:
44+
45+
1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **DEX** > **Tests**.
46+
2. Choose an existing test and select **Edit**, or select **Add a test** to make a new test.
47+
3. Under **Select DEX rules**, select the rule you would like to apply.
48+
4. Select **Save test** for an existing rule or **Add rule** for the new test.
49+
50+
:::note
51+
Existing tests may take 24 hours to apply or remove a new rule.
52+
:::
53+
54+
To view which tests a rule is being applied to:
55+
56+
1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **DEX** > **Rules**.
57+
2. Select a rule > **Edit**.
58+
3. Select the **DEX tests** tab and review the list of tests that include your selected rule.
59+
60+
## Create a test using a rule
61+
62+
You can create a new test from the [DEX test dashboard as described above](/cloudflare-one/insights/dex/rules/#add-a-rule-to-a-test) or directly from the DEX rules dashboard.
63+
64+
To create a new test using a rule from DEX rules:
65+
66+
1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **DEX** > **Rules**.
67+
2. Select a rule > **Edit**.
68+
3. Select the **DEX tests** tab.
69+
4. You will be able to review all the tests that currently include this rule. To create a new rule, select **Create a test using this rule**.
70+
5. Enter all required information, making sure that the box next to your rule name is checked.
71+
6. Select **Add test**.
72+
73+
## Related resources
74+
75+
- [DEX HTTP test](/cloudflare-one/insights/dex/tests/http/) - Assess the accessibility of a web application.
76+
- [DEX Traceroute test](/cloudflare-one/insights/dex/tests/traceroute/) - Measure the network path of an IP packet from an end-user device to a server.

src/content/docs/cloudflare-one/insights/dex/tests/http.mdx

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,9 @@ pcx_content_type: reference
33
title: HTTP test
44
sidebar:
55
order: 1
6-
76
---
87

9-
10-
import { Details } from "~/components"
8+
import { Details } from "~/components";
119

1210
<Details header="Feature availability">
1311

@@ -17,13 +15,12 @@ import { Details } from "~/components"
1715

1816
| System | Availability | Minimum WARP version |
1917
| -------- | ------------ | -------------------- |
20-
| Windows || 2023.3.381 |
21-
| macOS || 2023.3.381 |
22-
| Linux || 2023.3.398 |
23-
| iOS || |
24-
| Android || 1.0 |
25-
| ChromeOS || 1.0 |
26-
18+
| Windows || 2023.3.381 |
19+
| macOS || 2023.3.381 |
20+
| Linux || 2023.3.398 |
21+
| iOS || |
22+
| Android || 1.0 |
23+
| ChromeOS || 1.0 |
2724

2825
</Details>
2926

@@ -36,11 +33,11 @@ To set up an HTTP test for an application:
3633
1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **DEX** > **Tests**.
3734
2. Select **Add a Test**.
3835
3. Fill in the following fields:
39-
* **Name**: Enter any name for the test.
40-
* **Target**: Enter the URL of the website or application that you want to test (for example, `https://jira.site.com`). Both public and private hostnames are supported. If testing a private hostname, ensure that the domain is on your [local domain fallback](/cloudflare-one/connections/connect-devices/warp/configure-warp/route-traffic/local-domains/) list.
41-
* **Source device profiles**: (Optional) Select the [WARP device profiles](/cloudflare-one/connections/connect-devices/warp/configure-warp/device-profiles/) that you want to run the test on. If no profiles are selected, the test will run on all supported devices connected to your Zero Trust organization.
42-
* **Test type**: Select *HTTP Get*.
43-
* **Test frequency**: Specify how often the test will run. Input a minute value between 5 and 60.
36+
- **Name**: Enter any name for the test.
37+
- **Target**: Enter the URL of the website or application that you want to test (for example, `https://jira.site.com`). Both public and private hostnames are supported. If testing a private hostname, ensure that the domain is on your [local domain fallback](/cloudflare-one/connections/connect-devices/warp/configure-warp/route-traffic/local-domains/) list.
38+
- **Source device profiles**: (Optional) Select the [WARP device profiles](/cloudflare-one/connections/connect-devices/warp/configure-warp/device-profiles/) that you want to run the test on. If no profiles are selected, the test will run on all supported devices connected to your Zero Trust organization.
39+
- **Test type**: Select _HTTP Get_.
40+
- **Test frequency**: Specify how often the test will run. Input a minute value between 5 and 60.
4441
4. Select **Add test**.
4542

4643
Next, [view the results](/cloudflare-one/insights/dex/tests/view-results/) of your test.
@@ -55,3 +52,7 @@ An HTTP test measures the following data:
5552
| Server response time | Round-trip time for the device to receive a response from the target. |
5653
| DNS response time | Round-trip time for the DNS query to resolve. |
5754
| HTTP status codes | [Status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status) returned by the target. |
55+
56+
## Related resources
57+
58+
- [DEX rules](/cloudflare-one/insights/dex/rules/) - Specify the target group of a test.

src/content/docs/cloudflare-one/insights/dex/tests/index.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,15 @@
22
pcx_content_type: navigation
33
title: Tests
44
sidebar:
5-
order: 2
5+
order: 3
66
---
77

88
import { DirectoryListing } from "~/components";
99

10-
With Digital Experience Monitoring (DEX), you can test if your devices can connect to a private or public endpoint through the WARP client. This tool allows you to monitor availability for a given application and investigate performance issues reported by your end users. DEX tests will only run when the WARP client is turned on, whereas [fleet status](/cloudflare-one/insights/dex/monitoring/#fleet-status) metrics are always available.
10+
With Digital Experience Monitoring (DEX), you can test if your devices can connect to a private or public endpoint through the WARP client. Tests allow you to monitor availability for a given application and investigate performance issues reported by your end users.
11+
12+
DEX tests will only run when the WARP client is turned on, whereas [fleet status](/cloudflare-one/insights/dex/monitoring/#fleet-status) metrics are always available.
13+
14+
You can specify the target group of a test using [DEX rules](/cloudflare-one/insights/dex/rules/).
1115

1216
<DirectoryListing />

0 commit comments

Comments
 (0)