Skip to content

Commit dea1c2e

Browse files
committed
docs(fix): alerts doc imprvts
1 parent bd87609 commit dea1c2e

File tree

9 files changed

+197
-205
lines changed

9 files changed

+197
-205
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Learn how to activate preconfigured alerts for your Cockpit resourc
44
categories:
55
- observability
66
dates:
7-
validation: 2025-07-29
7+
validation: 2025-10-22
88
posted: 2024-04-05
99
---
1010
import Requirements from '@macros/iam/requirements.mdx'
@@ -19,7 +19,7 @@ This page shows you how to activate [preconfigured alerts](/cockpit/concepts/#pr
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
2121
- [Enabled](/cockpit/how-to/enable-alert-manager/) the alert manager
22-
- [Added contacts](/cockpit/how-to/add-contact-points/)
22+
- [Added contacts](/cockpit/how-to/enable-alert-manager/#how-to-add-contacts/)
2323

2424
## How to activate preconfigured alerts
2525

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

Lines changed: 0 additions & 50 deletions
This file was deleted.

pages/cockpit/how-to/configure-alerts-for-scw-resources.mdx

Lines changed: 90 additions & 90 deletions
Large diffs are not rendered by default.

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

Lines changed: 47 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
22
title: How to configure the alert manager
3-
description: Learn how to enable Scaleway's regionalized alert manager and add contacts to configure alert notifications for your resources.
3+
description: Learn how to configure the Scaleway regionalized alert manager and add contacts to receive alert notifications for your resources.
44
categories:
55
- observability
66
dates:
7-
validation: 2025-10-16
7+
validation: 2025-10-22
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, and add notification contacts that will be notified when your alerts are triggered, using the [Scaleway console](https://console.scaleway.com/).
13+
This page shows you how to enable Scaleway's regionalized alert manager, add and manage contacts that will be notified when your alerts are triggered, using the [Scaleway console](https://console.scaleway.com/).
1414

15-
You can [add](/cockpit/how-to/add-contact-points/) or manage contacts at any time to ensure the right people are notified when alerts fire.
15+
You can add or manage contacts at any time to ensure the right people are notified when alerts fire.
1616

1717
<Requirements />
1818

@@ -40,6 +40,48 @@ Enabling Scaleway's regionalized alert manager allows you configure preconfigure
4040
6. Enter an email address, then click **+ Add email** and **Add contacts**. Your email address displays in the **Contacts** section, and by default, the **Resolved notifications** box is ticked. This means that you will receive notifications for resolved alerts.
4141
7. Optionally, click **Skip for now** if you do not want to add contacts yet.
4242
<Message type="note">
43-
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 manage them independently from the alert manager configuration at any time.
43+
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 or manage them independently from the alert manager configuration at any time.
4444
</Message>
4545

46+
## How to add contacts
47+
48+
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.
49+
50+
1. Click **Cockpit** in the **Monitoring** section of the [console](https://console.scaleway.com/) side menu. The **Cockpit** overview page displays.
51+
2. Click the **Alerts** tab.
52+
3. Click the **Region** drop-down and select the desired region.
53+
<Message type="important">
54+
Make sure that you select the same region as the [data sources](/cockpit/concepts/#data-sources) you want your contacts to be alerted for.
55+
</Message>
56+
4. Click **Add email** in the **Contacts** section. A pop-up displays.
57+
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.
58+
6. Optionally, enter another email and click **+ Add email** to add another contact.
59+
7. Click **Add contacts** to confirm. The email addresses appears in the list of your contacts.
60+
61+
Refer to the dedicated documentation to find out how to manage your contacts.
62+
63+
## How to manage contacts
64+
65+
1. Click **Cockpit** in the **Monitoring** section of the [console](https://console.scaleway.com/) side menu. The **Cockpit** overview page displays.
66+
2. Click the **Alerts** tab.
67+
3. Click the **Region** drop-down and select the desired region.
68+
<Message type="important">
69+
Make sure that you select the same region as the [data sources](/cockpit/concepts/#data-sources) you want your contacts to be alerted for.
70+
</Message>
71+
4. Scroll to the **Contacts** section and:
72+
- 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.
73+
- clear the checkbox under **Resolved notifications** to **stop receiving resolved notifications**.
74+
- click the trash icon next to the contact you wish to **delete**, then click **Delete contact** to confirm.
75+
<Message type="important">
76+
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.
77+
</Message>
78+
79+
## Advanced configuration
80+
81+
<Message type="important">
82+
Make sure that you use the Scaleway alert manager if you follow the Grafana documentation below
83+
</Message>
84+
85+
- Find out how to configure templates and customize your alert notification messages in the [dedicated Grafana documentation](https://grafana.com/docs/grafana/latest/alerting/fundamentals/templates/)
86+
87+
- Find out how to configure notification policies in the [dedicated Grafana documentation](http://grafana.com/docs/grafana/latest/alerting/configure-notifications/)

pages/cockpit/menu.ts

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,32 +19,28 @@ export const cockpitMenu = {
1919
{
2020
items: [
2121
{
22-
label: 'Retrieve your Grafana credentials',
23-
slug: 'retrieve-grafana-credentials',
24-
},
25-
{
26-
label: 'Create a token',
27-
slug: 'create-token',
22+
label: 'Configure the alert manager',
23+
slug: 'enable-alert-manager',
2824
},
2925
{
30-
label: 'Enable the alert manager',
31-
slug: 'enable-alert-manager',
26+
label: 'Activate Scaleway preconfigured alerts',
27+
slug: 'activate-managed-alerts',
3228
},
3329
{
34-
label: 'Create and push traces',
35-
slug: 'activate-push-traces',
30+
label: 'Configure alerts for Scaleway resources',
31+
slug: 'configure-alerts-for-scw-resources',
3632
},
3733
{
38-
label: 'Activate Scaleway preconfigured alerts',
39-
slug: 'activate-managed-alerts',
34+
label: 'Retrieve your Grafana credentials',
35+
slug: 'retrieve-grafana-credentials',
4036
},
4137
{
42-
label: 'Manage contacts',
43-
slug: 'add-contact-points',
38+
label: 'Create a token',
39+
slug: 'create-token',
4440
},
4541
{
46-
label: 'Configure alerts for Scaleway resources',
47-
slug: 'configure-alerts-for-scw-resources',
42+
label: 'Create and push traces',
43+
slug: 'activate-push-traces',
4844
},
4945
{
5046
label: 'Access Grafana and preconfigured dashboards',

pages/cockpit/reference-content/cockpit-limitations.mdx

Lines changed: 43 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Cockpit capabilities and limits
33
description: Discover the capabilities and limits of Cockpit, including retention periods, Loki and Mimir limits, and product integrations for comprehensive infrastructure monitoring and management efficiency.
44
tags: observability cockpit retention metrics logs
55
dates:
6-
validation: 2025-08-28
6+
validation: 2025-10-22
77
posted: 2023-09-05
88
---
99

@@ -62,45 +62,49 @@ The following table provides information about [Mimir](/cockpit/concepts/#mimir)
6262

6363
The following table provides details about the products that are integrated into Cockpit. This means that you can have metrics and/or logs and/or alerts in your Cockpit for the products mentioned below.
6464

65+
Some Scaleway resources provide preconfigured alerts to notify you of any abnormal behavior. Refer to the **Alert management** section in the **Alerts tab** of the [Scaleway console](https://console.scaleway.com/cockpit/) to find out which Scaleway resources have integrated alerts.
66+
6567
**Sending metrics and logs using an external path is a billable feature**. As such, any additional data that you may push yourself will be billed, even if you send data from Scaleway products that are **integrated into Cockpit**. Refer to the [product pricing](https://www.scaleway.com/en/pricing/managed-services/#cockpit) for more information.
6668

67-
| **Product Name** | **Metrics** | **Logs** | **Alerts** |
68-
|----------------------------|-----------------|-----------------|-----------------|
69-
| CPU & GPU Instances | **Integrated*** | Not integrated | Not integrated |
70-
| Managed Inference | **Integrated*** | **Integrated*** | Not integrated |
71-
| Generative APIs | **Integrated*** | Not integrated | Not integrated |
72-
| Elastic Metal | Not integrated | Not integrated | Not integrated |
73-
| Apple silicon | Not integrated | Not integrated | Not integrated |
74-
| Kubernetes Kapsule | **Integrated*** | **Integrated*** | **Integrated** |
75-
| Kubernetes Kosmos | **Integrated*** | **Integrated*** | **Integrated** |
76-
| Container Registry | Not integrated | Not integrated | Not integrated |
77-
| Serverless Containers | **Integrated*** | **Integrated*** | Not integrated |
78-
| Serverless Functions | **Integrated*** | **Integrated*** | Not integrated |
79-
| Serverless Jobs | **Integrated*** | **Integrated*** | Not integrated |
80-
| NATS | **Integrated*** | Not integrated | Not integrated |
81-
| Queues | **Integrated*** | Not integrated | Not integrated |
82-
| Topics and Events | **Integrated*** | Not integrated | Not integrated |
83-
| Block Storage | **Integrated*** | Not integrated | Not integrated |
84-
| Object Storage | **Integrated*** | **Integrated*** | Not integrated |
85-
| Database RDB PostgreSQL | **Integrated*** | **Integrated*** | **Integrated** |
86-
| Database RDB MySQL | **Integrated*** | **Integrated*** | **Integrated** |
87-
| Serverless SQL Database | **Integrated*** | **Integrated*** | **Integrated** |
88-
| Redis | **Integrated*** | **Integrated*** | **Integrated** |
89-
| MongoDB | **Integrated*** | Not integrated | Not integrated |
90-
| Data Lab (Apache Spark) | **Integrated*** | Not integrated | Not integrated |
91-
| Clickhouse | Planned | Not integrated | Not integrated |
92-
| Private Networks | **Integrated*** | Not integrated | Not integrated |
93-
| Public Gateways | **Integrated*** | **Integrated*** | Not integrated |
94-
| Load Balancers | **Integrated*** | **Integrated*** | Not integrated |
95-
| Domains and DNS | Not integrated | Not integrated | Not integrated |
96-
| Edge Services | **Integrated*** | Not integrated | Not integrated |
97-
| Transactional Email | **Integrated*** | Not integrated | Not integrated |
98-
| IoT Hub | **Integrated*** | Not integrated | Not integrated |
99-
| Web Hosting | Not integrated | Not integrated | Not integrated |
100-
| Cockpit | **Integrated*** | Not integrated | Not integrated |
101-
| Audit Trail | Not integrated | Not integrated | Not integrated |
102-
| IAM | Not integrated | Not integrated | Not integrated |
103-
| Secret Manager | **Integrated*** | Not integrated | Not integrated |
104-
| Key Manager | Not integrated | Not integrated | Not integrated |
69+
| **Product Name** | **Metrics** | **Logs** |
70+
|----------------------------|-----------------|-----------------|
71+
| CPU & GPU Instances | **Integrated*** | Not integrated |
72+
| Managed Inference | **Integrated*** | **Integrated*** |
73+
| Generative APIs | **Integrated*** | Not integrated |
74+
| Elastic Metal | Not integrated | Not integrated |
75+
| Apple silicon | Not integrated | Not integrated |
76+
| Kubernetes Kapsule | **Integrated*** | **Integrated*** |
77+
| Kubernetes Kosmos | **Integrated*** | **Integrated*** |
78+
| Container Registry | Not integrated | Not integrated |
79+
| Serverless Containers | **Integrated*** | **Integrated*** |
80+
| Serverless Functions | **Integrated*** | **Integrated*** |
81+
| Serverless Jobs | **Integrated*** | **Integrated*** |
82+
| NATS | **Integrated*** | Not integrated |
83+
| Queues | **Integrated*** | Not integrated |
84+
| Topics and Events | **Integrated*** | Not integrated |
85+
| Block Storage | **Integrated*** | Not integrated |
86+
| Object Storage | **Integrated*** | **Integrated*** |
87+
| Database RDB PostgreSQL | **Integrated*** | **Integrated*** |
88+
| Database RDB MySQL | **Integrated*** | **Integrated*** |
89+
| Serverless SQL Database | **Integrated*** | **Integrated*** |
90+
| Redis | **Integrated*** | **Integrated*** |
91+
| MongoDB | **Integrated*** | Not integrated |
92+
| Data Lab (Apache Spark) | **Integrated*** | Not integrated |
93+
| Clickhouse | Planned | Not integrated |
94+
| Private Networks | **Integrated*** | Not integrated |
95+
| Public Gateways | **Integrated*** | **Integrated*** |
96+
| Load Balancers | **Integrated*** | **Integrated*** |
97+
| Domains and DNS | Not integrated | Not integrated |
98+
| Edge Services | **Integrated*** | Not integrated |
99+
| Transactional Email | **Integrated*** | Not integrated |
100+
| IoT Hub | **Integrated*** | Not integrated |
101+
| Web Hosting | Not integrated | Not integrated |
102+
| Cockpit | **Integrated*** | Not integrated |
103+
| Audit Trail | Not integrated | Not integrated |
104+
| IAM | Not integrated | Not integrated |
105+
| Secret Manager | **Integrated*** | Not integrated |
106+
| Key Manager | Not integrated | Not integrated |
107+
108+
105109

106110
*: Including data and dashboards

pages/serverless-containers/how-to/configure-alerts-containers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This page shows you how to configure alerts for Scaleway Serverless Containers u
1818
- Scaleway resources you can monitor
1919
- [Created Grafana credentials](/cockpit/how-to/retrieve-grafana-credentials/) with the **Editor** role
2020
- [Enabled](/cockpit/how-to/enable-alert-manager/) the alert manager
21-
- [Created](/cockpit/how-to/add-contact-points/) at least one contact point
21+
- [Added](/cockpit/how-to/enable-alert-manager/#how-to-add-contacts) at least one contact in the Scaleway console or contact points in Grafana
2222
- Selected the **Scaleway Alerting** alert manager in Grafana
2323

2424
1. [Log in to Grafana](/cockpit/how-to/access-grafana-and-managed-dashboards/) using your credentials.

pages/serverless-functions/how-to/configure-alerts-functions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This page shows you how to configure alerts for Scaleway Serverless Functions us
1818
- Scaleway resources you can monitor
1919
- [Created Grafana credentials](/cockpit/how-to/retrieve-grafana-credentials/) with the **Editor** role
2020
- [Enabled](/cockpit/how-to/enable-alert-manager/) the alert manager
21-
- [Created](/cockpit/how-to/add-contact-points/) at least one contact point
21+
- [Added](/cockpit/how-to/enable-alert-manager/#how-to-add-contacts) at least one contact in the Scaleway console or contact points in Grafana
2222
- Selected the **Scaleway Alerting** alert manager in Grafana
2323

2424
1. [Log in to Grafana](/cockpit/how-to/access-grafana-and-managed-dashboards/) using your credentials.

pages/serverless-jobs/how-to/configure-alerts-jobs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This page shows you how to configure alerts for Scaleway Serverless Jobs using S
1919
- Scaleway resources you can monitor
2020
- [Created Grafana credentials](/cockpit/how-to/retrieve-grafana-credentials/) with the **Editor** role
2121
- [Enabled](/cockpit/how-to/enable-alert-manager/) the alert manager
22-
- [Added](/cockpit/how-to/add-contact-points/) at least one contact in the Scaleway console or contact points in Grafana
22+
- [Added](/cockpit/how-to/enable-alert-manager/#how-to-add-contacts) at least one contact in the Scaleway console or contact points in Grafana
2323
- Selected the **Scaleway Alerting** alert manager in Grafana
2424

2525
1. [Log in to Grafana](/cockpit/how-to/access-grafana-and-managed-dashboards/) using your credentials.

0 commit comments

Comments
 (0)