Skip to content

Commit b7a86be

Browse files
nerda-codesnerda-codes
committed
docs(cpt): updates
1 parent ecf2f15 commit b7a86be

File tree

3 files changed

+76
-54
lines changed

3 files changed

+76
-54
lines changed

‎pages/cockpit/how-to/activate-managed-alerts.mdx‎

Lines changed: 15 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,46 @@
11
---
2-
title: How to manage Scaleway preconfigured alerts
3-
description: Learn how to configure alert notifications with the alert manager, activate preconfigured alerts for your Cockpit resources, and add contacts to notify, using the Scaleway console.
2+
title: How to activate Scaleway preconfigured alerts
3+
description: Learn how to activate preconfigured alerts for your Cockpit resources using the Scaleway console.
44
categories:
55
- observability
66
dates:
7-
validation: 2025-07-22
7+
validation: 2025-07-29
88
posted: 2024-04-05
99
---
1010
import Requirements from '@macros/iam/requirements.mdx'
1111

1212
import CustomAlertsTab from './assets/scaleway-custom-alerts-tab.webp'
1313

1414

15-
This page shows you how to enable the Scaleway alert manager, activate [preconfigured alerts](/cockpit/concepts/#preconfigured-alerts) for your Cockpit resources, and add contacts that will be notified when your alerts are triggered, using the [Scaleway console](https://console.scaleway.com/).
15+
This page shows you how to activate [preconfigured alerts](/cockpit/concepts/#preconfigured-alerts) for your Cockpit resources.
1616

1717
<Requirements />
1818

1919
- A Scaleway account logged into the [console](https://console.scaleway.com)
2020
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
21+
- [Enabled](/cockpit/how-to/enable-alert-manager/) the alert manager
22+
- [Added contacts](/cockpit/how-to/add-contact-points/)
2123

22-
## How to configure alert notifications
23-
Enabling Scaleway's regionalized alert manager allows you configure preconfigured alerts for your Scaleway resources.
24+
## How to activate preconfigured alerts
2425

2526
1. Click **Cockpit** in the **Monitoring** section of the [console](https://console.scaleway.com/) side menu. The **Cockpit** overview page displays.
2627
2. Click the **Alerts** tab.
2728
3. Click the **Region** drop-down and select the desired region.
2829
<Message type="important">
2930
Make sure that you select the same region as the [data sources](/cockpit/concepts/#data-sources) you want to be alerted for.
3031
</Message>
31-
5. Click **Enable alert manager** under the **Alert manager** section. A pop-up displays prompting you to configure alert notifications.
32-
<Message type="tip">
33-
Configuring alert notifications consists of two steps:
34-
- Enabling the alert manager, and
35-
- Adding contacts
36-
This allows you to receive notifications at the desired contact whenever alerts you may have configured are triggered.
37-
</Message>
38-
6. Click **Enable alert manager** to confirm. The step for adding contacts displays.
39-
7. Enter an email address, then click **+ Add email**. Your email address displays and by default, the **Resolved notifications** box is ticked. This means that you will receive notifications for resolved alerts.
40-
8. Optionally:
41-
- Click **Skip for now** if you do not want to add contacts yet, or
42-
- Enter another email and click **+ Add email** to add another contact and/or
43-
- Untick the box next to the email(s) you have added if you do not wish to receive notifications for resolved alerts and/or
44-
9. Click **Add contacts** to confirm. A new **Contacts** section displays.
32+
4. Scroll to the **Alert management** section. This section allows you to manage (enable, disable and visualize) [Scaleway preconfigured alerts](/cockpit/concepts/#preconfigured-alerts) or custom alerts.
33+
5. From the **Preconfigured** tab, click the down arrow next to the Scaleway product of your choice to view available alerts.
34+
6. Under the **Activation** section, tick the checkboxes next to the alerts you want to activate.
35+
7. Click **Save changes**. A pop-up appears summarizing the number of alerts you are about to enable and the total of enabled alerts you will have after you confirm.
4536
<Message type="tip">
46-
You can opt out of adding contacts and add them at a later time
37+
If you have created alerting or recording rules in Grafana, the total of enabled alerts includes your Scaleway preconfigured alerts and the ones you have in Grafana.
4738
</Message>
48-
49-
## How to activate preconfigured alerts
50-
51-
1. In the same tab as the previous steps, scroll to the **Alert management** section. This section allows you to manage (enable, disable and visualize) Scaleway preconfigured alerts or visualize custom alerts.
52-
2. From the **Preconfigured** tab, click the down arrow next to the Scaleway product of your choice to view available alerts.
53-
3. Under the **Activation** section, tick the boxes next to the alerts you want to activate.
54-
4. Click **Save changes**. A pop-up appears summarizing the number of alerts you are about to enable and the total of enabled alerts you will have after you confirm.
55-
5. Click **Save changes** to confirm.
39+
8. Click **Save changes** to confirm.
5640

5741
<Message type="note">
58-
If you have created alerts in Grafana, you can visualize them in the **Custom** tab.
42+
If you have created custom alerts in Grafana, you can visualize them in the **Custom** tab.
5943
<Lightbox image={CustomAlertsTab} alt="" />
6044
</Message>
6145

62-
Your enabled alerts display in the **Overview** as **enabled rules**. Alerting rules are your Scaleway or custom alerts.
46+
Your enabled alerts display in the **Overview** as **enabled rules**. Enabled rules include your Scaleway or custom alerts, as well as [recording rules](/cockpit/concepts/#recording-rules) you may have created in Grafana.

‎pages/cockpit/how-to/add-contact-points.mdx‎

Lines changed: 31 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,50 @@
11
---
2-
title: How to add contacts
3-
description: Learn how to add contacts to notify when alerts are triggered or resolved using the Scaleway console. Follow the steps to configure contacts, choose whether to be notified when alerts are resolved, and send test alerts.
2+
title: How to manage contacts
3+
description: Learn how to configure and manage contacts to notify when alerts are triggered or resolved using the Scaleway console. Follow the steps to configure contacts, choose whether to be notified when alerts are resolved, and send test alerts.
44
categories:
55
- observability
66
dates:
7-
validation: 2025-07-22
7+
validation: 2025-07-29
88
posted: 2024-04-05
99
---
1010
import Requirements from '@macros/iam/requirements.mdx'
1111

1212

13-
This page shows you how to add [contacts](/cockpit/concepts/#contacts) to notify when alerts are triggered or resolved using the [Scaleway console](https://console.scaleway.com/).
13+
This page shows you how to add [contacts](/cockpit/concepts/#contacts) to ensure the right people are notified when alerts are triggered or resolved using the [Scaleway console](https://console.scaleway.com/).
14+
15+
You are prompted to create contacts when [enabling the alert manager](/cockpit/how-to/enable-alert-manager/) for the first time, or when re-enabling it after disabling. However, you can also perform this step independently from the alert manager configuration at any time.
1416

1517
<Requirements />
1618

1719
- A Scaleway account logged into the [console](https://console.scaleway.com)
1820
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
1921
- [Enabled](/cockpit/how-to/enable-alert-manager/) the alert manager
2022

21-
## Add contacts
23+
## How to add contacts
24+
25+
1. Click **Cockpit** in the **Monitoring** section of the [console](https://console.scaleway.com/) side menu. The **Cockpit** overview page displays.
26+
2. Click the **Alerts** tab.
27+
3. Click the **Region** drop-down and select the desired region.
28+
<Message type="important">
29+
Make sure that you select the same region as the [data sources](/cockpit/concepts/#data-sources) you want your contacts to be alerted for.
30+
</Message>
31+
4. Click **Add email** in the **Contacts** section. A pop-up displays.
32+
5. Enter an email address, then click **+ Add email**. Your email address displays and by default, the **Resolved notifications** checkbox is ticked. This means that you will receive notifications for resolved alerts.
33+
6. Optionally, enter another email and click **+ Add email** to add another contact.
34+
7. Click **Add contacts** to confirm. The email addresses appears in the list of your contacts.
35+
36+
## How to manage contacts
2237

2338
1. Click **Cockpit** in the **Monitoring** section of the [console](https://console.scaleway.com/) side menu. The **Cockpit** overview page displays.
2439
2. Click the **Alerts** tab.
25-
3. Click **+ Add email** in the **Contacts** section. A pop-up displays.
26-
4. Enter the email address you wish to add as a contact.
27-
5. Choose the regions in which you want to add the contact.
28-
<Message type="important">
29-
Make sure that you choose the same regions as the data sources for which you want to receive alerts.
30-
</Message>
31-
6. Click **Add email address**. The email address appears in the list of your contacts.
32-
7. Optionally, if you have [activated preconfigured alerts](/cockpit/how-to/activate-managed-alerts/), click **Send test alert** to ensure that your alerts are sent to your contacts.
40+
3. Click the **Region** drop-down and select the desired region.
41+
<Message type="important">
42+
Make sure that you select the same region as the [data sources](/cockpit/concepts/#data-sources) you want your contacts to be alerted for.
43+
</Message>
44+
4. Scroll to the **Contacts** section and:
45+
- click **Send test alert** to ensure that your alerts are sent to your contacts. You **must have [activated preconfigured alerts](/cockpit/how-to/activate-managed-alerts/)** beforehand.
46+
- clear the checkbox under **Resolved notifications** to **stop receiving resolved notifications**.
47+
- click the trash icon next to the contact you wish to **delete**.
48+
<Message type="important">
49+
The contact you delete will no longer receive alerts. If this is your only configured contact, alert notifications will stop until you add a new contact.
50+
</Message>

‎pages/cockpit/how-to/enable-alert-manager.mdx‎

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,48 @@
11
---
2-
title: How to enable the alert manager
3-
description: Learn how to enable Scaleway's regionalized alert manager to configure preconfigured alerts for your resources. Follow the steps to navigate to the Alerts tab, select regions, and confirm the alert manager activation.
2+
title: How to enable the alert manager and add contacts
3+
description: Learn how to enable Scaleway's regionalized alert manager and add contacts to configure preconfigured alerts for your resources.
44
categories:
55
- observability
66
dates:
7-
validation: 2025-04-08
7+
validation: 2025-07-29
88
posted: 2024-04-05
99
---
1010
import Requirements from '@macros/iam/requirements.mdx'
1111

1212

13-
This page shows you how to enable Scaleway's regionalized alert manager to configure preconfigured alerts for your Scaleway resources.
13+
This page shows you how to enable Scaleway's regionalized alert manager, and add notification contacts that will be notified when your alerts are triggered, using the [Scaleway console](https://console.scaleway.com/).
14+
15+
You can [add]() or manage contacts at any time to ensure the right people are notified when alerts fire.
1416

1517
<Requirements />
1618

1719
- A Scaleway account logged into the [Scaleway console](https://console.scaleway.com)
1820
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
1921

22+
## How to configure alert notifications
23+
24+
Enabling Scaleway's regionalized alert manager allows you configure preconfigured alerts for your Scaleway resources.
2025

2126
1. Click **Cockpit** in the **Monitoring** section of the [console](https://console.scaleway.com/) side menu. The **Cockpit** overview page displays.
2227
2. Click the **Alerts** tab.
23-
3. Click **Enable** under the **Alert manager** section.
24-
4. Choose the regions where you want to enable the alert manager.
25-
<Message type="important">
26-
Make sure that you enable the alert manager in the same regions as the [data sources](/cockpit/concepts/#data-sources) you want to be alerted for.
27-
</Message>
28-
5. Click **Enable alert manager** to confirm.
28+
3. Click the **Region** drop-down and select the desired region.
29+
<Message type="important">
30+
Make sure that you select the same region as the [data sources](/cockpit/concepts/#data-sources) you want to be alerted for.
31+
</Message>
32+
5. Click **Enable alert manager** under the **Alert manager** section. A pop-up displays prompting you to configure alert notifications.
33+
<Message type="tip">
34+
Configuring alert notifications consists of two steps:
35+
- Enabling the alert manager, and
36+
- Adding contacts
37+
This allows you to receive notifications at the desired contact whenever alerts you may have configured are triggered.
38+
</Message>
39+
6. Click **Enable alert manager** to confirm. The step for adding contacts displays.
40+
<Message type="note">
41+
You are prompted to create contacts when enabling the alert manager for the first time, or when re-enabling it after disabling. However, you can also [add](/cockpit/how-to/add-contact-points/) or update contacts independently from the alert manager configuration at any time.
42+
</Message>
43+
7. Enter an email address, then click **+ Add email**. Your email address displays and by default, the **Resolved notifications** box is ticked. This means that you will receive notifications for resolved alerts.
44+
8. Optionally:
45+
- Click **Skip for now** if you do not want to add contacts yet, or
46+
- Enter another email and click **+ Add email** to add another contact and/or
47+
- Untick the box next to the email(s) you have added if you do not wish to receive notifications for resolved alerts
48+
9. Click **Add contacts** to confirm. A new **Contacts** section displays.

0 commit comments

Comments
 (0)