diff --git a/src/content/docs/magic-transit/how-to/configure-magic-tunnel-alerts.mdx b/src/content/docs/magic-transit/how-to/configure-magic-tunnel-alerts.mdx index 9ac342cc699dd4..6adf8fde3c3a8b 100644 --- a/src/content/docs/magic-transit/how-to/configure-magic-tunnel-alerts.mdx +++ b/src/content/docs/magic-transit/how-to/configure-magic-tunnel-alerts.mdx @@ -5,113 +5,16 @@ head: [] description: Use the API to set up and configure Magic Tunnel health alerts --- -import { APIRequest, Render, Tabs, TabItem } from "~/components"; +import { Render } from "~/components"; - -## Set up Magic Tunnel health alerts - - - - - - - -:::note -Refer to the [documentation for Notifications](/notifications/get-started/) to learn about specific permissions you need to access the service via the API. -::: - -Send a [`POST` request](/api/resources/alerting/subresources/policies/methods/create/) to create a Magic Transit tunnel health alert. You can set tunnel health alerts with any SLO value between `0` and `99.99`. - -", - "enabled": true, - "filters": { - "slo": [ - "99.9" - ] - }, - "mechanisms": { - "email": [ - { - "id": "EMAIL_ADDRESS" - } - ]}, - "name": "" - - }} -/> - -```json output -{ - "result": [ - { - "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", - "name": "", - "description": "", - "enabled": true, - "alert_type": "magic_tunnel_health_check_event", - "mechanisms": { - "email": [ - { - "id": "" - } - ] - }, - "created": "2024-09-11T14:13:29.585658Z", - "modified": "2024-09-11T14:13:29.585658Z", - "conditions": { - "and": [ - { - "or": [ - { - "<=": [ - { - "var": "slo" - }, - "99.9" - ] - } - ] - } - ] - }, - "filters": { - "slo": ["99.9"] - } - } - ], - "success": true, - "errors": [], - "messages": [] -} -``` - - - - +/> \ No newline at end of file diff --git a/src/content/docs/magic-wan/configuration/common-settings/configure-magic-tunnel-alerts.mdx b/src/content/docs/magic-wan/configuration/common-settings/configure-magic-tunnel-alerts.mdx index 18225a334e292b..aead353517d948 100644 --- a/src/content/docs/magic-wan/configuration/common-settings/configure-magic-tunnel-alerts.mdx +++ b/src/content/docs/magic-wan/configuration/common-settings/configure-magic-tunnel-alerts.mdx @@ -5,110 +5,15 @@ head: [] description: Use the API to set up and configure Magic Tunnel health alerts --- -import { APIRequest, Render, Tabs, TabItem } from "~/components"; +import { Render } from "~/components"; - -## Set up Magic Tunnel health alerts - - - - - - - -:::note -Refer to the [documentation for Notifications](/notifications/get-started/) to learn about specific permissions you need to access the service via the API. -::: - -Send a [`POST` request](/api/resources/alerting/subresources/policies/methods/create/) to create a Magic WAN tunnel health alert. You can set tunnel health alerts with any SLO value between `0` and `99.99`. - -", - "enabled": true, - "filters": { - "slo": [ - "99.9" - ] - }, - "mechanisms": { - "email": [ - { - "id": "EMAIL_ADDRESS" - } - ]}, - "name": "" - }} -/> - -```json output -{ - "result": [ - { - "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", - "name": "", - "description": "", - "enabled": true, - "alert_type": "magic_wan_tunnel_health", - "mechanisms": { - "email": [ - { - "id": "" - } - ] - }, - "created": "2024-09-11T14:13:29.585658Z", - "modified": "2024-09-11T14:13:29.585658Z", - "conditions": { - "and": [ - { - "or": [ - { - "<=": [ - { - "var": "slo" - }, - "99.9" - ] - } - ] - } - ] - }, - "filters": { - "slo": ["99.9"] - } - } - ], - "success": true, - "errors": [], - "messages": [] -} -``` - - - - +/> \ No newline at end of file diff --git a/src/content/partials/magic-wan/magic-tunnel-health-alerts/magic-tunnel-health-alerts.mdx b/src/content/partials/magic-wan/magic-tunnel-health-alerts/magic-tunnel-health-alerts.mdx index a25069db9ddbf0..9e8f9accd87796 100644 --- a/src/content/partials/magic-wan/magic-tunnel-health-alerts/magic-tunnel-health-alerts.mdx +++ b/src/content/partials/magic-wan/magic-tunnel-health-alerts/magic-tunnel-health-alerts.mdx @@ -1,10 +1,13 @@ --- params: + - magicWord - productName - backgroundInfoPath + - networkAnalyticsPath + - healthChecks --- -import { GlossaryTooltip, Markdown, TabItem, Tabs } from "~/components"; +import { APIRequest, Code, GlossaryTooltip, Render, Tabs, TabItem } from "~/components"; {props.productName} customers can configure Magic Tunnel health alerts to receive email, webhook, and PagerDuty notifications when the percentage of successful health checks for a Magic Tunnel drops below the selected service-level objective (SLO). @@ -22,3 +25,200 @@ If a Magic Tunnel health alert is fired, customers can expect the following data - Tunnel status - Alert SLO - Timestamp + +## Set up Magic Tunnel health alerts + + + +1. Log in to your [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account. +2. Select **Notifications** > **Add**. +3. Select **{props.productName}** > **Magic Tunnel Health Check Alert** > **Select** to add a notification. +4. Enter a name and description for the notification. +5. Add webhooks or an email address for the person who should receive the notification, and select **Next**. +6. Choose the tunnels you want to receive alerts for. +7. Select the **Alert Sensitivity Level** threshold. It is predefined for _Medium_, but you can choose between _High_, _Medium_, and _Low_. If you need more than three sensitivity levels, use the API. +8. Select **Create** when you are done. + + + +:::note +Refer to the [documentation for Notifications](/notifications/get-started/) to learn about specific permissions you need to access the service via the API. +::: + +Send a [`POST` request](/api/resources/alerting/subresources/policies/methods/create/) to create a {props.productName} tunnel health alert. You can set tunnel health alerts with any SLO value between `0` and `99.99`. + + +{ props.magicWord === "Magic Transit" && ( + <> + ", + "enabled": true, + "filters": { + "slo": [ + "99.9" + ] + }, + "mechanisms": { + "email": [ + { + "id": "EMAIL_ADDRESS" + } + ]}, + "name": "" + + }} + /> + + ", + "description": "", + "enabled": true, + "alert_type": "magic_tunnel_health_check_event", + "mechanisms": { + "email": [ + { + "id": "" + } + ] + }, + "created": "2024-09-11T14:13:29.585658Z", + "modified": "2024-09-11T14:13:29.585658Z", + "conditions": { + "and": [ + { + "or": [ + { + "<=": [ + { + "var": "slo" + }, + "99.9" + ] + } + ] + } + ] + }, + "filters": { + "slo": ["99.9"] + } + } + ], + "success": true, + "errors": [], + "messages": [] + } + `} /> + + ) +} + +{ props.magicWord === "Magic WAN" && ( + <> + ", + "enabled": true, + "filters": { + "slo": [ + "99.9" + ] + }, + "mechanisms": { + "email": [ + { + "id": "EMAIL_ADDRESS" + } + ]}, + "name": "" + }} + /> + + ", + "description": "", + "enabled": true, + "alert_type": "magic_wan_tunnel_health", + "mechanisms": { + "email": [ + { + "id": "" + } + ] + }, + "created": "2024-09-11T14:13:29.585658Z", + "modified": "2024-09-11T14:13:29.585658Z", + "conditions": { + "and": [ + { + "or": [ + { + "<=": [ + { + "var": "slo" + }, + "99.9" + ] + } + ] + } + ] + }, + "filters": { + "slo": ["99.9"] + } + } + ], + "success": true, + "errors": [], + "messages": [] + } + `} /> + + + + ) +} + + + +## Recommended SLO thresholds + +Currently, there are three SLO threshold values that are supported by the API. The SLO threshold for Magic Tunnel health alerts can be defined as the percentage of health checks that must be successful for each of the Magic Tunnel(s) included in the alert: + +| Alert Sensitivity Level | Recommended SLO threshold | +| ----------------------- | ------------------------- | +| High | 99.0 | +| Medium | 98.0 | +| Low | 97.0 | + +With these settings, at 100% failure Cloudflare will send alerts at the following time frames, after a problem is detected: + +- **High sensitivity**: First alert within 10 minutes. +- **Medium sensitivity**: First alert within 20 minutes. +- **Low sensitivity**: First alert within 30 minutes. + +Refer to the Magic tunnels background information page for more information on this topic. + +## Test SLOs + +To test whether a specific alert sensitivity level works for your use case: + +1. [Create an alert](#set-up-magic-tunnel-health-alerts) with a specific sensitivity level for a tunnel with active traffic within the past six hours. If you are not sure of what tunnels to choose, refer to Network Analytics to learn how you can view real-time and historical data about your network. +2. Disable the tunnel you are testing, so there is 100% health check failure. +3. The time it takes for Cloudflare to send you an alert will depend on the sensitivity you chose for your alerts (High, Medium or Low). diff --git a/src/content/partials/magic-wan/magic-tunnel-health-alerts/recommended-slo.mdx b/src/content/partials/magic-wan/magic-tunnel-health-alerts/recommended-slo.mdx deleted file mode 100644 index 6000342adad781..00000000000000 --- a/src/content/partials/magic-wan/magic-tunnel-health-alerts/recommended-slo.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -params: - - backgroundInfoPath - - networkAnalyticsPath - - healthChecks ---- - -## Recommended SLO thresholds - -Currently, there are three SLO threshold values that are supported by the API. The SLO threshold for Magic Tunnel health alerts can be defined as the percentage of health checks that must be successful for each of the Magic Tunnel(s) included in the alert: - -| Alert Sensitivity Level | Recommended SLO threshold | -| ----------------------- | ------------------------- | -| High | 99.0 | -| Medium | 98.0 | -| Low | 97.0 | - -With these settings, at 100% failure Cloudflare will send alerts at the following time frames, after a problem is detected: - -- **High sensitivity**: First alert within 10 minutes. -- **Medium sensitivity**: First alert within 20 minutes. -- **Low sensitivity**: First alert within 30 minutes. - -Refer to the Magic tunnels background information page for more information on this topic. - -## Test SLOs - -To test whether a specific alert sensitivity level works for your use case: - -1. [Create an alert](#set-up-magic-tunnel-health-alerts) with a specific sensitivity level for a tunnel with active traffic within the past six hours. If you are not sure of what tunnels to choose, refer to Network Analytics to learn how you can view real-time and historical data about your network. -2. Disable the tunnel you are testing, so there is 100% health check failure. -3. The time it takes for Cloudflare to send you an alert will depend on the sensitivity you chose for your alerts (High, Medium or Low). diff --git a/src/content/partials/magic-wan/magic-tunnel-health-alerts/setup-magic-tunnels-dash.mdx b/src/content/partials/magic-wan/magic-tunnel-health-alerts/setup-magic-tunnels-dash.mdx deleted file mode 100644 index 0f2f0fe935879c..00000000000000 --- a/src/content/partials/magic-wan/magic-tunnel-health-alerts/setup-magic-tunnels-dash.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -params: - - productName ---- - -1. Log in to your [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account. -2. Select **Notifications** > **Add**. -3. Select **{props.productName}** > **Magic Tunnel Health Check Alert** > **Select** to add a notification. -4. Enter a name and description for the notification. -5. Add webhooks or an email address for the person who should receive the notification, and select **Next**. -6. Choose the tunnels you want to receive alerts for. -7. Select the **Alert Sensitivity Level** threshold. It is predefined for _Medium_, but you can choose between _High_, _Medium_, and _Low_. If you need more than three sensitivity levels, use the API. -8. Select **Create** when you are done.