Skip to content

Commit 1b9ca9e

Browse files
marciocloudflarethomasgauvin
authored andcommitted
[MNM] Docs maintenance (#23850)
* corrected h3 to h4 * corrected spaces * refined text * corrected link * corrected link * refined text * refined text * created auto adv notif * added rule auto adv partial
1 parent d512d87 commit 1b9ca9e

File tree

6 files changed

+28
-17
lines changed

6 files changed

+28
-17
lines changed

src/content/docs/magic-network-monitoring/rules/dynamic-threshold.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ A dynamic threshold rule can only be configured via [Cloudflare's Magic Network
2323
| **Rule type** | zscore |
2424
| **Target** | Can be defined in either bits per second or packets per second. |
2525
| **Sensitivity** | Z-Score sensitivity has three values: low, medium, and high. |
26-
| **Auto-advertisement** | If you are a [Magic Transit On Demand](/magic-transit/on-demand) customer, you can enable this feature to automatically enable Magic Transit if the rule's dynamic threshold is triggered. Magic Network Monitoring supports Magic Transit's supernet capability. To learn more refer to [Auto-Advertisement section](/magic-network-monitoring/rules/rule-notifications/#rule-auto-advertisement-notifications). |
26+
| **Auto-advertisement** | If you are a [Magic Transit On Demand](/magic-transit/on-demand) customer, you can enable this feature to automatically enable Magic Transit if the rule's dynamic threshold is triggered. Magic Network Monitoring supports Magic Transit's supernet capability. To learn more refer to [Auto-Advertisement section](/magic-network-monitoring/rules/#rule-auto-advertisement). |
2727
| **Rule IP prefix** | The IP prefix associated with the rule for monitoring traffic volume. Must be a CIDR range such as `160.168.0.1/24`. The maximum is 5,000 unique CIDR entries. To learn more and review an example, refer to the [Rule IP prefixes](/magic-network-monitoring/rules/#rule-ip-prefixes). |
2828

2929
## API documentation
3030

31-
to review an example API configuration call using CURL and the expected output for a successful response, go to [Magic Network Monitoring](/api/resources/magic_network_monitoring/) in [developers.cloudflare.com/api/](/api/) and expand the [Rules](/api/resources/magic_network_monitoring/subresources/rules/) section.
31+
To review an example API configuration call using CURL and the expected output for a successful response, go to the [Rules](/api/resources/magic_network_monitoring/subresources/rules/) section in the Magic Network Monitoring API documentation.
3232

3333
## How the dynamic rule threshold is calculated
3434

src/content/docs/magic-network-monitoring/rules/index.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ sidebar:
66
order: 4
77

88
---
9+
import { Render } from "~/components"
910

1011
Magic Network Monitoring rules allow you to monitor your network traffic for DDoS attacks on specific IP addresses or IP prefixes within your network. If the network traffic that is monitored by a rule exceeds the rule's threshold or contains a DDoS attack fingerprint, then you will receive an alert.
1112

@@ -66,11 +67,15 @@ If you are an Enterprise customer using [Magic Transit On Demand](/magic-transit
6667

6768
Follow the previous steps to [create](#create-rules-in-the-dashboard) or [edit](#edit-rules-in-the-dashboard) a rule. Then, enable **Auto-Advertisement**.
6869

70+
#### Rule Auto-Advertisement notifications
71+
72+
<Render file="mnm-auto-advertisement-notifications" product="networking-services" />
73+
6974
### Rule IP prefixes
7075

7176
Each rule must include a group of IP prefixes in its definition. All IP prefixes inside a rule are evaluated as a whole, and you should set up a rule with multiple IP prefixes when you want the IP prefixes' aggregated traffic to trigger an alert or advertisement. For thresholds on singular IP prefixes or IP addresses, you can create an individual rule with one prefix and the desired rule parameters.
7277

73-
### Rule IP prefixes example
78+
#### Rule IP prefixes example
7479

7580
For a rule with two prefix CIDRs and a `packet_threshold` of `10000` as shown below, the rule will be flagged if the joint packet traffic of `192.168.0.0/24` and `172.118.0.0/24` is greater than `10000`. This also means that Cloudflare attempts to auto advertise both CIDRs if the rule has the auto advertisement flag enabled. Customers can also [configure Rule IP prefixes at scale via Cloudflare's API](https://developers.cloudflare.com/api/resources/magic_network_monitoring/subresources/rules/).
7681

src/content/docs/magic-network-monitoring/rules/rule-notifications.mdx

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ pcx_content_type: how-to
44
sidebar:
55
order: 4
66
---
7+
import { Render } from "~/components"
78

89
After configuring one or multiple rule types in Magic Network Monitoring, customers can also choose to receive notifications via email, webhook, or PagerDuty when a rule is triggered.
910

@@ -28,16 +29,7 @@ You can read [Cloudflare's Notifications documentation](/notifications/) for mor
2829

2930
## Rule Auto-Advertisement notifications
3031

31-
Webhook, PagerDuty, and email notifications are sent following an auto-advertisement attempt for all prefixes inside the flagged rule.
32-
33-
You will receive the status of the advertisement for each prefix with the following available statuses:
34-
35-
- **Advertised**: The prefix was successfully advertised.
36-
- **Already Advertised**: The prefix was advertised prior to the auto advertisement attempt.
37-
- **Delayed**: The prefix cannot currently be advertised but will attempt advertisement. After the prefix can be advertised, a new notification is sent with the updated status.
38-
- **Locked**: The prefix is locked and cannot be advertised.
39-
- **Could not Advertise**: Cloudflare was unable to advertise the prefix. This status can occur for multiple reasons, but usually occurs when you are not allowed to advertise a prefix.
40-
- **Error**: A general error occurred during prefix advertisement.
32+
<Render file="mnm-auto-advertisement-notifications" product="networking-services" />
4133

4234
## Configure static threshold notifications
4335

src/content/docs/magic-network-monitoring/rules/s-flow-ddos-attack.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ Customers can export sFlow data of their network traffic to Cloudflare via Magic
2424
| **Rule name** | Must be unique and cannot contain spaces. Supports characters `A-Z`, `a-z`, `0-9`, underscore (`_`), dash (`-`), period (`.`), and tilde (`~`). Maximum of 256 characters. |
2525
| **Rule type** | advanced_ddos |
2626
| **Prefix Match** | The field `prefix_match` determines how IP matches are handled. <ul><li>**Recommended**</li><ul><li>**Subnet**: Automatically advertise if the attacked IPs are within a subnet of a public IP prefix that can be advertised by Magic Transit.</li></ul><li>**Other prefix match options**</li><ul><li>**Exact**: Automatically advertise if the attacked IPs are an exact match with a public IP prefix that can be advertised by Magic Transit.</li><li>**Supernet**: Automatically advertise if the attacked IPs are a supernet of a public IP prefix that can be advertised by Magic Transit.</li></ul></ul> |
27-
| **Auto-advertisement** | If you are a [Magic Transit On Demand](/magic-transit/on-demand) customer, you can enable this feature to automatically enable Magic Transit if the rule's dynamic threshold is triggered. To learn more refer to [Auto-Advertisement section](/magic-network-monitoring/rules/rule-notifications/#rule-auto-advertisement-notifications). |
27+
| **Auto-advertisement** | If you are a [Magic Transit On Demand](/magic-transit/on-demand) customer, you can enable this feature to automatically enable Magic Transit if the rule's dynamic threshold is triggered. To learn more refer to [Auto-Advertisement section](/magic-network-monitoring/rules/#rule-auto-advertisement). |
2828
| **Rule IP prefix** | The IP prefix associated with the rule for monitoring traffic volume. Must be a CIDR range such as `160.168.0.1/24`. The maximum is 5,000 unique CIDR entries. To learn more and see an example, view the [Rule IP prefixes](/magic-network-monitoring/rules/#rule-ip-prefixes). |
2929

3030
## API documentation
3131

32-
You can visit [developers.cloudflare.com/api/](/api/), navigate to [Magic Network Monitoring](/api/resources/magic_network_monitoring/), and expand the [Rules](/api/resources/magic_network_monitoring/subresources/rules/) section to see an example API configuration call using CURL and the expected output for a successful response.
32+
Go to the [Rules](/api/resources/magic_network_monitoring/subresources/rules/) section in the Magic Network Monitoring's API documentation to review an example API configuration call using CURL and the expected output for a successful response.
3333

3434
## Tune the sFlow DDoS alert thresholds
3535

src/content/docs/magic-network-monitoring/rules/static-threshold.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar:
77

88
A static threshold rule allows you to define a constant numeric threshold, in terms of bits or packets, for DDoS traffic monitoring. The total traffic across all IP prefixes and IP addresses in the rule is compared to the static rule threshold. If the total traffic exceeds the static rule threshold for the duration of the rule, then an alert is sent.
99

10-
Customers that send NetFlow and / or sFlow data to Cloudflare can configure static threshold rules.
10+
Customers that send NetFlow and/or sFlow data to Cloudflare can configure static threshold rules.
1111

1212
## Rule configuration fields
1313

@@ -18,7 +18,7 @@ Customers that send NetFlow and / or sFlow data to Cloudflare can configure stat
1818
| **Rule threshold type** | Can be defined in either bits per second or packets per second. |
1919
| **Rule threshold** | The number of bits per second or packets per second for the rule alert. When this value is exceeded for the rule duration, an alert notification is sent. Minimum of `1` and no maximum. |
2020
| **Rule duration** | The amount of time in minutes the rule threshold must exceed to send an alert notification. Choose from the following values: `1`, `5`, `10`, `15`, `20`, `30`, `45`, or `60` minutes. |
21-
| **Auto-advertisement** | If you are a [Magic Transit On Demand](/magic-transit/on-demand) customer, you can enable this feature to automatically enable Magic Transit if the rule alert is triggered. Magic Network Monitoring supports Magic Transit's supernet capability. To learn more refer to [Auto-Advertisement section](/magic-network-monitoring/rules/rule-notifications/#rule-auto-advertisement-notifications). |
21+
| **Auto-advertisement** | If you are a [Magic Transit On Demand](/magic-transit/on-demand) customer, you can enable this feature to automatically enable Magic Transit if the rule alert is triggered. Magic Network Monitoring supports Magic Transit's supernet capability. To learn more refer to [Auto-Advertisement section](/magic-network-monitoring/rules/#rule-auto-advertisement). |
2222
| **Rule IP prefix** | The IP prefix associated with the rule for monitoring traffic volume. Must be a CIDR range such as `160.168.0.1/24`. Max is 5,000 unique CIDR entries. To learn more and see an example, view the [Rule IP prefixes](/magic-network-monitoring/rules/#rule-ip-prefixes) section. |
2323

2424
## API documentation
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
{}
3+
---
4+
5+
Webhook, PagerDuty, and email notifications are sent following an auto-advertisement attempt for all prefixes inside the flagged rule.
6+
7+
You will receive the status of the advertisement for each prefix with the following available statuses:
8+
9+
- **Advertised**: The prefix was successfully advertised.
10+
- **Already Advertised**: The prefix was advertised prior to the auto advertisement attempt.
11+
- **Delayed**: The prefix cannot currently be advertised but will attempt advertisement. After the prefix can be advertised, a new notification is sent with the updated status.
12+
- **Locked**: The prefix is locked and cannot be advertised.
13+
- **Could not Advertise**: Cloudflare was unable to advertise the prefix. This status can occur for multiple reasons, but usually occurs when you are not allowed to advertise a prefix.
14+
- **Error**: A general error occurred during prefix advertisement.

0 commit comments

Comments
 (0)