Skip to content

Commit 563def7

Browse files
committed
docs(add): rework part one
1 parent c6013d8 commit 563def7

File tree

7 files changed

+80
-39
lines changed

7 files changed

+80
-39
lines changed

menu/navigation.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3722,7 +3722,7 @@
37223722
"slug": "activate-managed-alerts"
37233723
},
37243724
{
3725-
"label": "Add contact points",
3725+
"label": "Add contacts",
37263726
"slug": "add-contact-points"
37273727
},
37283728
{

pages/cockpit/concepts.mdx

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ title: Cockpit - Concepts
33
description: Explore Scaleway Observability concepts including metrics, logs, and alerts management through Cockpit. Learn about agents, alerting rules, Grafana integration, and data types for comprehensive monitoring.
44
tags: observability alert-manager contact-points endpoint grafana loki logql prometheus promql tokens
55
dates:
6-
validation: 2025-06-04
6+
validation: 2025-07-22
7+
categories:
8+
- observability
79
---
810
import image from './assets/scaleway-traces-concept.webp'
911

@@ -49,9 +51,9 @@ Tokens are regionalized secret keys that allow you to authenticate against the e
4951
- **Rules**: allow you to configure alerting and recording rules.
5052
- **Alerts**: allow you to set up the alert manager.
5153

52-
## Contact points
54+
## Contacts
5355

54-
Contact points define who is notified when an alert fires, according to the region in which you have added them. Contact points include emails, Slack, on-call systems, and texts. When an alert fires, all contact points are notified.
56+
Contacts define who gets notified when an alert is triggered or [resolved](#resolved-notifications). Contacts can include email addresses, Slack channels, on-call systems, or phone numbers for text messages. When an alert fires, all configured contacts are notified.
5557

5658
## Custom data
5759

@@ -131,16 +133,20 @@ You can push metrics with any Prometheus-compatible agent such as [Prometheus](h
131133

132134
A preconfigured dashboard is a set of one or more panels that Scaleway sets up and updates for you to visualize the metrics and logs associated with your Scaleway products.
133135

134-
## Receivers
136+
## Recording rules
135137

136-
Receivers are hubs consisting of contact points. You can associate one or several alerts with one or more receivers. This allows you to diversify your alerts.
138+
Recording rules are custom queries that run automatically at regular intervals and save the results under a simple name. They let you precompute important or heavy queries ahead of time, so your dashboards and alerts load faster and use less computing power.
137139

138140
## Region
139141

140142
A region is the geographical area in which your Cockpit data is stored. They are duplicated on all Availability Zones of the selected regions (Paris, Amsterdam, or Warsaw).
141143

142144
You can decide in which region to enable the [alert manager](#alert-manager) and your [preconfigured alerts](#preconfigured-alerts). You can also choose the regions in which to create your [data types](#data-types), [data sources](#data-sources), and [tokens](#tokens).
143145

146+
## Resolved notifications
147+
148+
Resolved notifications are alerts your contacts receive to let them know that a previously triggered alert has been fixed or is no longer firing.
149+
144150
## Retention
145151

146152
Retention or data retention refers to the duration for which the data (metrics, logs, and traces) pushed to Cockpit (by Scaleway products or yourself) is stored before being automatically deleted. Retention allows you to manage the lifecycle of your Scaleway and custom data by selecting storage periods that align with your needs.
Lines changed: 46 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,62 @@
11
---
2-
title: How to activate Scaleway preconfigured alerts
3-
description: Learn how to activate preconfigured alerts for your Cockpit resources using the Scaleway console.
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.
4+
categories:
5+
- observability
46
dates:
5-
validation: 2025-04-08
7+
validation: 2025-07-22
68
posted: 2024-04-05
79
---
810
import Requirements from '@macros/iam/requirements.mdx'
911

12+
import CustomAlertsTab from './assets/scaleway-custom-alerts-tab.webp'
1013

11-
This page shows you how to activate [preconfigured alerts](/cockpit/concepts/#preconfigured-alerts) for your Cockpit resources using the [Scaleway console](https://console.scaleway.com/).
14+
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/).
1216

1317
<Requirements />
1418

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

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

2025
1. Click **Cockpit** in the **Monitoring** section of the [console](https://console.scaleway.com/) side menu. The **Cockpit** overview page displays.
21-
2226
2. Click the **Alerts** tab.
23-
24-
3. Click **Enable** under the **Scaleway preconfigured alerts** section. Select the regions you want to enable the alerts in.
25-
26-
<Message type="note">
27-
- You can only enable preconfigured alerts in the regions you have enabled the alert manager.
28-
- If you want to receive alerts, you also need to [add contact points](/cockpit/how-to/add-contact-points/).
29-
</Message>
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 to be alerted for.
30+
</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.
45+
<Message type="tip">
46+
You can opt out of adding contacts and add them at a later time
47+
</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.
56+
57+
<Message type="note">
58+
If you have created alerts in Grafana, you can visualize them in the **Custom** tab.
59+
<Lightbox image={CustomAlertsTab} alt="" />
60+
</Message>
61+
62+
Your enabled alerts display in the **Overview** as **enabled rules**. Alerting rules are your Scaleway or custom alerts.
Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,32 @@
11
---
2-
title: How to add contact points
3-
description: Learn how to add contact points to the default receiver using the Scaleway console. Follow the steps to enter email addresses, select regions, and optionally send test alerts.
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.
4+
categories:
5+
- observability
46
dates:
57
validation: 2025-07-22
68
posted: 2024-04-05
79
---
810
import Requirements from '@macros/iam/requirements.mdx'
911

1012

11-
This page shows you how to associate [contact points](/cockpit/concepts/#contact-points) with the default [receiver](/cockpit/concepts/#receivers) using the [Scaleway console](https://console.scaleway.com/).
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/).
1214

1315
<Requirements />
1416

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

19-
## Add contact points
21+
## Add contacts
2022

2123
1. Click **Cockpit** in the **Monitoring** section of the [console](https://console.scaleway.com/) side menu. The **Cockpit** overview page displays.
2224
2. Click the **Alerts** tab.
23-
3. Click **+ Add email** in the **Default receiver’s contact points** section. A pop-up displays.
24-
4. Enter the email address you wish to add as a contact point.
25-
5. Choose the regions in which you want to add the contact point.
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.
2628
<Message type="important">
2729
Make sure that you choose the same regions as the data sources for which you want to receive alerts.
2830
</Message>
29-
6. Click **Add email address**. The email address appears in the list of your contact points.
30-
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 contact points.
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.
93.5 KB
Loading

0 commit comments

Comments
 (0)