Skip to content
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] rules docs #20256

Open
wants to merge 5 commits into
base: production
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/content/docs/cloudflare-one/insights/dex/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
pcx_content_type: navigation
title: Digital Experience Monitoring
sidebar:
order: 2
order: 1
---

import { DirectoryListing } from "~/components";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
pcx_content_type: reference
title: Monitoring
sidebar:
order: 1
order: 2
---

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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@
pcx_content_type: reference
title: Notifications
sidebar:
order: 5
order: 6
head:
- tag: title
content: DEX notifications

---

import { AvailableNotifications } from "~/components"
import { AvailableNotifications } from "~/components";

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
pcx_content_type: reference
title: Remote captures
sidebar:
order: 4
order: 5
---

import { Details } from "~/components";
Expand Down Expand Up @@ -45,7 +45,8 @@ DEX will now send capture requests to the configured devices. If the WARP client
## 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.

- **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).
Expand Down
76 changes: 76 additions & 0 deletions src/content/docs/cloudflare-one/insights/dex/rules.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
pcx_content_type: reference
title: Rules
sidebar:
order: 4
---

DEX rules allow you to create and manage testing policies for targeted user groups within your [fleet](/cloudflare-one/insights/dex/tests/). After creating a rule, you can use it to define the scope of a [test](/cloudflare-one/insights/dex/tests/) to specific groups such as departments (like finance or sales), devices, and/or users. You can apply and reuse rules on your desired tests.

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 more precise problem detection and resolution.

## Create a rule

To create a rule:

1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **DEX** > **Rules**.
2. Select **Add a rule**.
3. Give your rule a name and build your desired expressions.
4. Select **Create rule** to finalize your rule.

### Selectors

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.

Review the available selectors and their scope in the following list.

| Selector | Description |
| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| **User email** | For specifying [user emails](/cloudflare-one/policies/gateway/identity-selectors/#user-email). |
| **User group emails** | For specifying [group emails](/cloudflare-one/policies/gateway/identity-selectors/#user-group-email). |
| **User group IDs** | For specifying [group IDs](/cloudflare-one/policies/gateway/identity-selectors/#user-group-ids). |
| **User group names** | For specifying a [group name](/cloudflare-one/policies/gateway/identity-selectors/#user-group-names). |
| **Operating systems** | For specifying operating systems. |
| **Operating system version** | For specifying an operating system version (use Operator `in`) or versions (use Operator `is`). |
| **Managed network** | For specifying users accessing the network from the office (managed network) compared to those accessing remotely. |
| **SAML attributes** | For specifying a value from the [SAML Attribute Assertion](/cloudflare-one/policies/gateway/identity-selectors/#saml-attributes). |
| **Colos** | For specifying a Cloudflare data center location users are connected to. |

## Add a rule to a test

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.

To add a rule to a test:

1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **DEX** > **Tests**.
2. Choose an existing test and select **Edit**, or select **Add a test** to make a new test.
3. Under **Select DEX rules**, select the rule you would like to apply.
4. Select **Save test** for an existing rule or **Add rule** for the new test.

:::note
Existing tests may take 24 hours to apply or remove a new rule.
:::

To view which tests a rule is being applied to:

1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **DEX** > **Rules**.
2. Select a rule > **Edit**.
3. Select the **DEX tests** tab and review the list of tests that include your selected rule.

## Create a test using a rule

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.

To create a new test using a rule from DEX rules:

1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **DEX** > **Rules**.
2. Select a rule > **Edit**.
3. Select the **DEX tests** tab.
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**.
5. Enter all required information, making sure that the box next to your rule name is checked.
6. Select **Add test**.

## Related resources

- [DEX HTTP test](/cloudflare-one/insights/dex/tests/http/) - Assess the accessibility of a web application.
- [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.
31 changes: 16 additions & 15 deletions src/content/docs/cloudflare-one/insights/dex/tests/http.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,9 @@ pcx_content_type: reference
title: HTTP test
sidebar:
order: 1

---


import { Details } from "~/components"
import { Details } from "~/components";

<Details header="Feature availability">

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

| System | Availability | Minimum WARP version |
| -------- | ------------ | -------------------- |
| Windows || 2023.3.381 |
| macOS || 2023.3.381 |
| Linux || 2023.3.398 |
| iOS || |
| Android || 1.0 |
| ChromeOS || 1.0 |

| Windows || 2023.3.381 |
| macOS || 2023.3.381 |
| Linux || 2023.3.398 |
| iOS || |
| Android || 1.0 |
| ChromeOS || 1.0 |

</Details>

Expand All @@ -36,11 +33,11 @@ To set up an HTTP test for an application:
1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **DEX** > **Tests**.
2. Select **Add a Test**.
3. Fill in the following fields:
* **Name**: Enter any name for the test.
* **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.
* **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.
* **Test type**: Select *HTTP Get*.
* **Test frequency**: Specify how often the test will run. Input a minute value between 5 and 60.
- **Name**: Enter any name for the test.
- **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.
- **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.
- **Test type**: Select _HTTP Get_.
- **Test frequency**: Specify how often the test will run. Input a minute value between 5 and 60.
4. Select **Add test**.

Next, [view the results](/cloudflare-one/insights/dex/tests/view-results/) of your test.
Expand All @@ -55,3 +52,7 @@ An HTTP test measures the following data:
| Server response time | Round-trip time for the device to receive a response from the target. |
| DNS response time | Round-trip time for the DNS query to resolve. |
| HTTP status codes | [Status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status) returned by the target. |

## Related resources

- [DEX rules](/cloudflare-one/insights/dex/rules/) - Specify the target group of a test.
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,15 @@
pcx_content_type: navigation
title: Tests
sidebar:
order: 2
order: 3
---

import { DirectoryListing } from "~/components";

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.
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.

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.

To specify the target group of a test, use [DEX rules](/cloudflare-one/insights/dex/rules/).

<DirectoryListing />
Loading
Loading