Skip to content

Commit be1419e

Browse files
committed
docs(add): feedback
1 parent d7ea331 commit be1419e

File tree

6 files changed

+48
-32
lines changed

6 files changed

+48
-32
lines changed

pages/cockpit/how-to/access-grafana-and-managed-dashboards.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ tags: observability cockpit grafana preconfigured-dashboard
55
categories:
66
- observability
77
dates:
8-
validation: 2024-12-26
8+
validation: 2024-08-20
99
posted: 2022-10-31
1010
---
1111
import Requirements from '@macros/iam/requirements.mdx'
@@ -26,7 +26,7 @@ This page shows you how to access [preconfigured dashboards](/cockpit/concepts/#
2626
2. Click **Open dashboards** to open your preconfigured dashboards in Grafana. You are redirected to the Grafana website.
2727
3. Enter your [Grafana credentials](/cockpit/how-to/retrieve-grafana-credentials/).
2828
4. Click **Log in**. The Grafana overview page displays.
29-
5. Click the **Home** icon at the top left of your screen.
29+
5. Click the Grafana icon in the top left side of your screen to open the menu.
3030
6. Click **Dashboard**. The Scaleway folder appears, with a list of all available preconfigured dashboards for Scaleway resources.
3131
7. Click the dashboard you want to view.
3232

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

Lines changed: 38 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Learn how to configure alerts for Scaleway resources in Grafana. Fo
44
categories:
55
- observability
66
dates:
7-
validation: 2025-07-18
7+
validation: 2025-08-20
88
posted: 2023-11-06
99
---
1010
import Requirements from '@macros/iam/requirements.mdx'
@@ -17,7 +17,11 @@ import AlertsFiringGrafana from './assets/scaleway-alert-firing.webp'
1717
import AlertsViaGrafanaUI from './assets/scaleway-alerts-via-grafana-ui.webp'
1818

1919

20-
Cockpit does not support Grafana-managed alerting. It integrates with Grafana to visualize metrics, but alerts are managed through the Scaleway alert manager. You should use Grafana only to define alert rules, not to evaluate or receive alert notifications. Once the conditions of your alert rule are met, the Scaleway alert manager evaluates the rule and sends a notification to the contact points you have configured in the Scaleway console or in Grafana.
20+
Cockpit does not support the Grafana alert manager nor Grafana-managed alert rules. You should only use the Grafana interface to define alert rules, not to evaluate or receive alert notifications. Alerting rules are evaluated at the data source level and notifications are handled and sent out by the Scaleway alert manager only.
21+
22+
Once the conditions of your alert rule are met, the rule evaluation engine of your data source forwards the firing alert to the Scaleway alert manager, which then sends a notification to the contacts you have configured in the Scaleway console or in Grafana.
23+
24+
You can also create alerting rules on your custom data sources.
2125

2226
This page shows you how to create alert rules in Grafana for monitoring Scaleway resources integrated with Cockpit, such as Instances, Object Storage, and Kubernetes. These alerts rely on Scaleway-provided metrics, which are preconfigured and available in the **Metrics browser** drop-down when using the **Scaleway Metrics data source** in the Grafana interface. This page explains how to use the `Scaleway Metrics` data source, interpret metrics, set alert conditions, and activate alerts.
2327

@@ -27,12 +31,12 @@ This page shows you how to create alert rules in Grafana for monitoring Scaleway
2731
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
2832
- Scaleway resources you can monitor
2933
- [Created Grafana credentials](/cockpit/how-to/retrieve-grafana-credentials/) with the **Editor** role
30-
- [Enabled](/cockpit/how-to/enable-alert-manager/) the Scaleway alert manager
31-
- [Created](/cockpit/how-to/add-contact-points/) a contact point in the Scaleway console or in Grafana (with the `Scaleway Alerting` alert manager of the same region as your `Scaleway Metrics` data source), otherwise alerts will not be delivered
34+
- [Enabled](/cockpit/how-to/enable-alert-manager/) the Scaleway alert manager in the same region as the resources you want to be alerted for
35+
- [Added](/cockpit/how-to/add-contact-points/) contacts in the Scaleway console or contact points in Grafana (with the `Scaleway Alerting` alert manager of the same region as your `Scaleway Metrics` data source), otherwise alerts will not be delivered
3236

3337
## Switch to the data source-managed tab
3438

35-
Data source managed alert rules allow you to configure alerts managed by the data source of your choice, instead of using Grafana's managed alerting system which is not supported by Cockpit.
39+
Data source managed alert rules allow you to configure alerts managed by the data source of your choice, instead of using Grafana's managed alerting system **which is not supported by Cockpit**.
3640

3741
1. [Log in to Grafana](/cockpit/how-to/access-grafana-and-managed-dashboards/) using your credentials.
3842
2. Click the Grafana icon in the top left side of your screen to open the menu.
@@ -45,7 +49,7 @@ Data source managed alert rules allow you to configure alerts managed by the dat
4549
8. In the **Rule type** subsection, click the **Data source-managed** tab.
4650
<Lightbox image={DataSourceManaged} alt="" />
4751
<Message type="important">
48-
Data source managed alert rules allow you to configure alerts managed by the data source of your choice, instead of using Grafana's managed alerting system which is not supported by Cockpit.
52+
Data source managed alert rules allow you to configure alerts managed by the data source of your choice, instead of using Grafana's managed alerting system **which is not supported by Cockpit**.
4953
This step is **mandatory** because Cockpit does not support Grafana’s built-in alerting system, but only alerts configured and evaluated by the data source itself.
5054
</Message>
5155

@@ -64,16 +68,19 @@ Switch between the tabs below to create alerts for a Scaleway Instance, an Objec
6468
<Message type="tip">
6569
The `instance_server_cpu_seconds_total` metric records how many seconds of CPU time your Instance has used in total. It is helpful to detect unexpected CPU usage spikes.
6670
</Message>
67-
2. In the **Set alert evaluation behavior** section, specify how long the condition must be true before triggering the alert.
68-
3. Enter a name in the **Namespace** and **Group** fields to categorize and manage your alert, and optionally, add annotations.
71+
2. In the **Set alert evaluation behavior** section, specify how long the condition must be met before triggering the alert.
72+
3. Enter a name in the **Namespace** and **Group** fields to categorize and manage your alert rules. Rules that share the same group will use the same configuration, including the evaluation interval which determines how often the rule is evaluated (by default: every 1 minute). You can modify this interval later in the group settings.
73+
<Message type="note">
74+
The evaluation interval is different from the pending period set in step 2. The evaluation interval controls how often the rule is checked, while the pending period defines how long the condition must be continuously met before the alert fires.
75+
</Message>
6976
4. In the **Configure labels and notifications** section, click **+ Add labels**. A pop-up appears.
70-
5. Enter a label and value name and click **Save**. You can skip this step if you want your alerts to be sent to the contact points you may already have created in the Scaleway console.
77+
5. Enter a label and value name and click **Save**. You can skip this step if you want your alerts to be sent to the contacts you may already have created in the Scaleway console.
7178
<Message type="note">
7279
In Grafana, notifications are sent by matching alerts to notification policies based on labels. This step is about deciding how alerts will reach you or your team (Slack, email, etc.) based on labels you attach to them. Then, you can set up rules that define who receives notifications in the **Notification policies** page.
73-
For example, if an alert has the label `team = instances-team`, you are telling Grafana to send a notification to the Instances team when your alert `alert-for-high-cpu-usage` gets triggered. Find out how to [configure notification policies in Grafana](/tutorials/configure-slack-alerting/#configuring-a-notification-policy).
80+
For example, if your alert named `alert-for-high-cpu-usage` has the label `team = instances-team`, you are telling Grafana to send a notification to the Instances team when the alert gets triggered. Find out how to [configure notification policies in Grafana](/tutorials/configure-slack-alerting/#configuring-a-notification-policy).
7481
</Message>
7582
6. Click **Save rule and exit** in the top right corner of your screen to save and activate your alert.
76-
7. Optionally, check that your configuration works by temporarily lowering the threshold. This will trigger the alert and notify your [contact point](/cockpit/concepts/#contact-points).
83+
7. Optionally, check that your configuration works by temporarily lowering the threshold. This will trigger the alert and notify your [contacts](/cockpit/concepts/#contact-points).
7784
</TabsTab>
7885
<TabsTab label="Object Storage bucket">
7986
The steps below explain how to create the metric selection and configure an alert condition that triggers when **the object count in your bucket exceeds a specific threshold**.
@@ -85,16 +92,19 @@ Switch between the tabs below to create alerts for a Scaleway Instance, an Objec
8592
<Message type="tip">
8693
The `object_storage_bucket_objects_total` metric indicates the total number of objects stored in a given Object Storage bucket. It is useful to monitor and control object growth in your bucket and avoid hitting thresholds.
8794
</Message>
88-
2. In the **Set alert evaluation behavior** section, specify how long the condition must be true before triggering the alert.
89-
3. Enter a name in the **Namespace** and **Group** fields to categorize and manage your alert, and optionally, add annotations.
95+
2. In the **Set alert evaluation behavior** section, specify how long the condition must be met before triggering the alert.
96+
3. Enter a name in the **Namespace** and **Group** fields to categorize and manage your alert rules. Rules that share the same group will use the same configuration, including the evaluation interval which determines how often the rule is evaluated (by default: every 1 minute). You can modify this interval later in the group settings.
97+
<Message type="note">
98+
The evaluation interval is different from the pending period set in step 2. The evaluation interval controls how often the rule is checked, while the pending period defines how long the condition must be continuously met before the alert fires.
99+
</Message>
90100
4. In the **Configure labels and notifications** section, click **+ Add labels**. A pop-up appears.
91-
5. Enter a label and value name and click **Save**. You can skip this step if you want your alerts to be sent to the contact points you may already have created in the Scaleway console.
101+
5. Enter a label and value name and click **Save**. You can skip this step if you want your alerts to be sent to the contacts you may already have created in the Scaleway console.
92102
<Message type="note">
93103
In Grafana, notifications are sent by matching alerts to notification policies based on labels. This step is about deciding how alerts will reach you or your team (Slack, email, etc.) based on labels you attach to them. Then, you can set up rules that define who receives notifications in the **Notification policies** page.
94104
For example, if an alert has the label `team = object-storage-team`, you are telling Grafana to send a notification to the Object Storage team when your alert is firing. Find out how to [configure notification policies in Grafana](/tutorials/configure-slack-alerting/#configuring-a-notification-policy).
95105
</Message>
96106
6. Click **Save rule and exit** in the top right corner of your screen to save and activate your alert.
97-
7. Optionally, check that your configuration works by temporarily lowering the threshold. This will trigger the alert and notify your [contact point](/cockpit/concepts/#contact-points).
107+
7. Optionally, check that your configuration works by temporarily lowering the threshold. This will trigger the alert and notify your [contacts](/cockpit/concepts/#contact-points).
98108
</TabsTab>
99109
<TabsTab label="Kubernetes pod">
100110
The steps below explain how to create the metric selection and configure an alert condition that triggers when **no new pod activity occurs, which could mean your cluster is stuck or unresponsive.**
@@ -107,15 +117,18 @@ Switch between the tabs below to create alerts for a Scaleway Instance, an Objec
107117
The `kubernetes_cluster_k8s_shoot_nodes_pods_usage_total` metric represents the total number of pods currently running across all nodes in your Kubernetes cluster. It is helpful to monitor current pod consumption per node pool or cluster, and help track resource saturation or unexpected workload spikes.
108118
</Message>
109119
2. In the **Set alert evaluation behavior** field, specify how long the condition must be true before triggering the alert.
110-
3. Enter a name in the **Namespace** and **Group** fields to categorize and manage your alert, and optionally, add annotations.
120+
3. Enter a name in the **Namespace** and **Group** fields to categorize and manage your alert rules. Rules that share the same group will use the same configuration, including the evaluation interval which determines how often the rule is evaluated (by default: every 1 minute). You can modify this interval later in the group settings.
121+
<Message type="note">
122+
The evaluation interval is different from the pending period set in step 2. The evaluation interval controls how often the rule is checked, while the pending period defines how long the condition must be continuously met before the alert fires.
123+
</Message>
111124
4. In the **Configure labels and notifications** section, click **+ Add labels**. A pop-up appears.
112-
5. Enter a label and value name and click **Save**. You can skip this step if you want your alerts to be sent to the contact points you may already have created in the Scaleway console.
125+
5. Enter a label and value name and click **Save**. You can skip this step if you want your alerts to be sent to the contacts you may already have created in the Scaleway console.
113126
<Message type="note">
114127
In Grafana, notifications are sent by matching alerts to notification policies based on labels. This step is about deciding how alerts will reach you or your team (Slack, email, etc.) based on labels you attach to them. Then, you can set up rules that define who receives notifications in the **Notification policies** page.
115128
For example, if an alert has the label `team = kubernetes-team`, you are telling Grafana to send a notification to the Kubernetes team when your alert is firing. Find out how to [configure notification policies in Grafana](/tutorials/configure-slack-alerting/#configuring-a-notification-policy).
116129
</Message>
117130
6. Click **Save rule and exit** in the top right corner of your screen to save and activate your alert.
118-
7. Optionally, check that your configuration works by temporarily lowering the threshold. This will trigger the alert and notify your [contact point](/cockpit/concepts/#contact-points).
131+
7. Optionally, check that your configuration works by temporarily lowering the threshold. This will trigger the alert and notify your [contacts](/cockpit/concepts/#contact-points).
119132
</TabsTab>
120133
<TabsTab label="Cockpit logs">
121134
The steps below explain how to create the metric selection and configure an alert condition that triggers when **no logs are stored for 5 minutes, which may indicate your app or system is broken**.
@@ -128,22 +141,25 @@ Switch between the tabs below to create alerts for a Scaleway Instance, an Objec
128141
The `observability_cockpit_loki_chunk_store_stored_chunks_total:increase5m` metric represents the number of chunks (log storage blocks) that have been written over the last 5 minutes for a specific resource. It is useful to monitor log ingestion activity and detect issues such as a crash of the logging agent, or your application not producing logs.
129142
</Message>
130143
2. In the **Set alert evaluation behavior** field, specify how long the condition must be true before triggering the alert.
131-
3. Enter a name in the **Namespace** and **Group** fields to categorize and manage your alert, and optionally, add annotations.
144+
3. Enter a name in the **Namespace** and **Group** fields to categorize and manage your alert rules. Rules that share the same group will use the same configuration, including the evaluation interval which determines how often the rule is evaluated (by default: every 1 minute). You can modify this interval later in the group settings.
145+
<Message type="note">
146+
The evaluation interval is different from the pending period set in step 2. The evaluation interval controls how often the rule is checked, while the pending period defines how long the condition must be continuously met before the alert fires.
147+
</Message>
132148
4. In the **Configure labels and notifications** section, click **+ Add labels**. A pop-up appears.
133-
5. Enter a label and value name and click **Save**. You can skip this step if you want your alerts to be sent to the contact points you may already have created in the Scaleway console.
149+
5. Enter a label and value name and click **Save**. You can skip this step if you want your alerts to be sent to the contacts you may already have created in the Scaleway console.
134150
<Message type="note">
135151
In Grafana, notifications are sent by matching alerts to notification policies based on labels. This step is about deciding how alerts will reach you or your team (Slack, email, etc.) based on labels you attach to them. Then, you can set up rules that define who receives notifications in the **Notification policies** page.
136152
For example, if an alert has the label `team = cockpit-team`, you are telling Grafana to send a notification to the Cockpit team when your alert is firing. Find out how to [configure notification policies in Grafana](/tutorials/configure-slack-alerting/#configuring-a-notification-policy).
137153
</Message>
138154
6. Click **Save rule and exit** in the top right corner of your screen to save and activate your alert.
139-
7. Optionally, check that your configuration works by temporarily lowering the threshold. This will trigger the alert and notify your [contact point](/cockpit/concepts/#contact-points).
155+
7. Optionally, check that your configuration works by temporarily lowering the threshold. This will trigger the alert and notify your [contacts](/cockpit/concepts/#contact-points).
140156
</TabsTab>
141157
</Tabs>
142158

143159
**You can configure up to a maximum of 10 alerts** for the `Scaleway Metrics` data source.
144160

145161
<Message type="tip">
146-
You can also build your alerts from the Grafana-managed tab, with the metrics explorer (book icon) and **+ Operations** button. However, remember to click the **Data source-managed** tab once you are done building them to receive alert notifications.
162+
You can also build your PromQL expressions and find the right metrics from the Grafana-managed tab, with the metrics explorer (book icon) and **+ Operations** button. However, remember to click the **Data source-managed** tab once you are done building them to proceed with the final configuration steps.
147163
<Lightbox image={AlertsViaGrafanaUI} alt="" />
148164
</Message>
149165

0 commit comments

Comments
 (0)