Skip to content

[Magic] Consolidates tunnel alerts partials #21130

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.

Sign up for GitHub

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

Merged
merged 15 commits into from
Mar 25, 2025
Merged

[Magic] Consolidates tunnel alerts partials #21130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
f2811de
added setup dash
marciocloudflare Mar 25, 2025
21dc5c6
added api note
marciocloudflare Mar 25, 2025
26417af
imported comps
marciocloudflare Mar 25, 2025
341a450
added apirequest
marciocloudflare Mar 25, 2025
aa153c7
added json output to pre
marciocloudflare Mar 25, 2025
3239cda
added api
marciocloudflare Mar 25, 2025
8731770
removed api from pages
marciocloudflare Mar 25, 2025
af8791a
added recommended slos content
marciocloudflare Mar 25, 2025
0239aff
edited pages
marciocloudflare Mar 25, 2025
07c5c33
added magic word
marciocloudflare Mar 25, 2025
2da49cc
imported code comp
marciocloudflare Mar 25, 2025
4ee71b5
added Code to json output
marciocloudflare Mar 25, 2025
c6bc361
added code
marciocloudflare Mar 25, 2025
8942e29
removed old partials
marciocloudflare Mar 25, 2025
00c960b
removed markdown comp
marciocloudflare Mar 25, 2025
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
103 changes: 3 additions & 100 deletions src/content/docs/magic-transit/how-to/configure-magic-tunnel-alerts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";

<Render
file="magic-tunnel-health-alerts/magic-tunnel-health-alerts"
product="magic-wan"
params={{
magicWord: "Magic Transit",
productName: "Magic Transit",
backgroundInfoPath: "/magic-transit/reference/magic-tunnels/",
}}
/>

## Set up Magic Tunnel health alerts

<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">

<Render
file="magic-tunnel-health-alerts/setup-magic-tunnels-dash"
product="magic-wan"
params={{
productName: "Magic Transit",
}}
/>

</TabItem> <TabItem label="API">

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

<APIRequest
path="/accounts/{account_id}/alerting/v3/policies"
method="POST"
json={{
"alert_type": "magic_tunnel_health_check_event",
"description": "<DESCRIBE_POLICY>",
"enabled": true,
"filters": {
"slo": [
"99.9"
]
},
"mechanisms": {
"email": [
{
"id": "EMAIL_ADDRESS"
}
]},
"name": "<DESCRIBE_ALERT>"

}}
/>

```json output
{
"result": [
{
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"name": "<POLICY_NAME>",
"description": "<POLICY_DESCRIPTION>",
"enabled": true,
"alert_type": "magic_tunnel_health_check_event",
"mechanisms": {
"email": [
{
"id": "<YOUR_EMAIL>"
}
]
},
"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": []
}
```

</TabItem> </Tabs>

<Render
file="magic-tunnel-health-alerts/recommended-slo"
product="magic-wan"
params={{
backgroundInfoPath: "/magic-transit/reference/magic-tunnels/",
networkAnalyticsPath: "/magic-transit/analytics/network-analytics/",
healthChecks: "/magic-transit/reference/tunnel-health-checks/",
}}
/>
/>
101 changes: 3 additions & 98 deletions .../docs/magic-wan/configuration/common-settings/configure-magic-tunnel-alerts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";

<Render
file="magic-tunnel-health-alerts/magic-tunnel-health-alerts"
params={{
magicWord: "Magic WAN",
productName: "Magic WAN",
backgroundInfoPath: "/magic-wan/reference/magic-tunnels/",
}}
/>

## Set up Magic Tunnel health alerts

<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">

<Render
file="magic-tunnel-health-alerts/setup-magic-tunnels-dash"
params={{
productName: "Magic WAN",
}}
/>

</TabItem> <TabItem label="API">

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

<APIRequest
path="/accounts/{account_id}/alerting/v3/policies"
method="POST"
json={{
"alert_type": "magic_wan_tunnel_health",
"description": "<DESCRIBE_POLICY>",
"enabled": true,
"filters": {
"slo": [
"99.9"
]
},
"mechanisms": {
"email": [
{
"id": "EMAIL_ADDRESS"
}
]},
"name": "<DESCRIBE_ALERT>"
}}
/>

```json output
{
"result": [
{
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"name": "<POLICY_NAME>",
"description": "<POLICY_DESCRIPTION>",
"enabled": true,
"alert_type": "magic_wan_tunnel_health",
"mechanisms": {
"email": [
{
"id": "<YOUR_EMAIL>"
}
]
},
"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": []
}
```

</TabItem> </Tabs>

<Render
file="magic-tunnel-health-alerts/recommended-slo"
product="magic-wan"
params={{
backgroundInfoPath: "/magic-wan/reference/magic-tunnels/",
networkAnalyticsPath: "/magic-wan/analytics/network-analytics/",
healthChecks: "/magic-wan/reference/tunnel-health-checks/",
}}
/>
/>
Loading
Loading