diff --git a/menu/navigation.json b/menu/navigation.json index 1e73a67147..537ed87bac 100644 --- a/menu/navigation.json +++ b/menu/navigation.json @@ -3722,7 +3722,7 @@ "slug": "activate-managed-alerts" }, { - "label": "Add contact points", + "label": "Manage contacts", "slug": "add-contact-points" }, { diff --git a/pages/cockpit/concepts.mdx b/pages/cockpit/concepts.mdx index 4caf735129..b2e75a76f2 100644 --- a/pages/cockpit/concepts.mdx +++ b/pages/cockpit/concepts.mdx @@ -3,7 +3,9 @@ title: Cockpit - Concepts 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. tags: observability alert-manager contact-points endpoint grafana loki logql prometheus promql tokens dates: - validation: 2025-06-04 + validation: 2025-07-22 +categories: + - observability --- import image from './assets/scaleway-traces-concept.webp' @@ -49,9 +51,9 @@ Tokens are regionalized secret keys that allow you to authenticate against the e - **Rules**: allow you to configure alerting and recording rules. - **Alerts**: allow you to set up the alert manager. -## Contact points +## Contacts -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. +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. ## Custom data @@ -131,9 +133,9 @@ You can push metrics with any Prometheus-compatible agent such as [Prometheus](h 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. -## Receivers +## Recording rules -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. +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. ## Region @@ -141,6 +143,10 @@ A region is the geographical area in which your Cockpit data is stored. They are 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). +## Resolved notifications + +Resolved notifications are alerts your contacts receive to let them know that a previously triggered alert has been fixed or is no longer firing. + ## Retention 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. diff --git a/pages/cockpit/how-to/activate-managed-alerts.mdx b/pages/cockpit/how-to/activate-managed-alerts.mdx index 54a3bdd4fa..76b4747594 100644 --- a/pages/cockpit/how-to/activate-managed-alerts.mdx +++ b/pages/cockpit/how-to/activate-managed-alerts.mdx @@ -1,29 +1,46 @@ --- title: How to activate Scaleway preconfigured alerts description: Learn how to activate preconfigured alerts for your Cockpit resources using the Scaleway console. +categories: + - observability dates: - validation: 2025-04-08 + validation: 2025-07-29 posted: 2024-04-05 --- import Requirements from '@macros/iam/requirements.mdx' +import CustomAlertsTab from './assets/scaleway-custom-alerts-tab.webp' -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/). + +This page shows you how to activate [preconfigured alerts](/cockpit/concepts/#preconfigured-alerts) for your Cockpit resources. - A Scaleway account logged into the [console](https://console.scaleway.com) - - [Enabled](/cockpit/how-to/enable-alert-manager/) the alert manager - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization + - [Enabled](/cockpit/how-to/enable-alert-manager/) the alert manager + - [Added contacts](/cockpit/how-to/add-contact-points/) +## How to activate preconfigured alerts 1. Click **Cockpit** in the **Monitoring** section of the [console](https://console.scaleway.com/) side menu. The **Cockpit** overview page displays. - 2. Click the **Alerts** tab. - -3. Click **Enable** under the **Scaleway preconfigured alerts** section. Select the regions you want to enable the alerts in. - - - - You can only enable preconfigured alerts in the regions you have enabled the alert manager. - - If you want to receive alerts, you also need to [add contact points](/cockpit/how-to/add-contact-points/). - +3. Click the **Region** drop-down and select the desired region. + + Make sure that you select the same region as the [data sources](/cockpit/concepts/#data-sources) you want to be alerted for. + +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. +5. From the **Preconfigured** tab, click the down arrow next to the Scaleway product of your choice to view available alerts. +6. Under the **Activation** section, tick the checkboxes next to the alerts you want to activate. +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. + + 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. + +8. Click **Save changes** to confirm. + + + If you have created custom alerts in Grafana, you can visualize them in the **Custom** tab. + + + +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. \ No newline at end of file diff --git a/pages/cockpit/how-to/add-contact-points.mdx b/pages/cockpit/how-to/add-contact-points.mdx index b8425e1987..1533107a25 100644 --- a/pages/cockpit/how-to/add-contact-points.mdx +++ b/pages/cockpit/how-to/add-contact-points.mdx @@ -1,14 +1,18 @@ --- -title: How to add contact points -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. +title: How to manage contacts +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. +categories: + - observability dates: - validation: 2025-07-22 + validation: 2025-07-29 posted: 2024-04-05 --- import Requirements from '@macros/iam/requirements.mdx' -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/). +This page shows you how to add and manage [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/). + +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. @@ -16,15 +20,31 @@ This page shows you how to associate [contact points](/cockpit/concepts/#contact - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - [Enabled](/cockpit/how-to/enable-alert-manager/) the alert manager -## Add contact points +## How to add contacts + +1. Click **Cockpit** in the **Monitoring** section of the [console](https://console.scaleway.com/) side menu. The **Cockpit** overview page displays. +2. Click the **Alerts** tab. +3. Click the **Region** drop-down and select the desired region. + + Make sure that you select the same region as the [data sources](/cockpit/concepts/#data-sources) you want your contacts to be alerted for. + +4. Click **Add email** in the **Contacts** section. A pop-up displays. +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. +6. Optionally, enter another email and click **+ Add email** to add another contact. +7. Click **Add contacts** to confirm. The email addresses appears in the list of your contacts. + +## How to manage contacts 1. Click **Cockpit** in the **Monitoring** section of the [console](https://console.scaleway.com/) side menu. The **Cockpit** overview page displays. 2. Click the **Alerts** tab. -3. Click **+ Add email** in the **Default receiver’s contact points** section. A pop-up displays. -4. Enter the email address you wish to add as a contact point. -5. Choose the regions in which you want to add the contact point. - - Make sure that you choose the same regions as the data sources for which you want to receive alerts. - -6. Click **Add email address**. The email address appears in the list of your contact points. -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. +3. Click the **Region** drop-down and select the desired region. + + Make sure that you select the same region as the [data sources](/cockpit/concepts/#data-sources) you want your contacts to be alerted for. + +4. Scroll to the **Contacts** section and: + - 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. + - clear the checkbox under **Resolved notifications** to **stop receiving resolved notifications**. + - click the trash icon next to the contact you wish to **delete**, then click **Delete contact** to confirm. + + 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. + \ No newline at end of file diff --git a/pages/cockpit/how-to/assets/scaleway-custom-alerts-tab.webp b/pages/cockpit/how-to/assets/scaleway-custom-alerts-tab.webp new file mode 100644 index 0000000000..33ffa5a3c7 Binary files /dev/null and b/pages/cockpit/how-to/assets/scaleway-custom-alerts-tab.webp differ diff --git a/pages/cockpit/how-to/configure-alerts-for-scw-resources.mdx b/pages/cockpit/how-to/configure-alerts-for-scw-resources.mdx index 5b8c757901..800b8b6c75 100644 --- a/pages/cockpit/how-to/configure-alerts-for-scw-resources.mdx +++ b/pages/cockpit/how-to/configure-alerts-for-scw-resources.mdx @@ -21,7 +21,7 @@ import image11 from './assets/scaleway-alerts-firing.webp' -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. +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 contacts you have configured in the Scaleway console or in Grafana. 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. @@ -32,7 +32,7 @@ This page shows you how to create alert rules in Grafana for monitoring Scaleway - Scaleway resources you can monitor - [Created Grafana credentials](/cockpit/how-to/retrieve-grafana-credentials/) with the **Editor** role - [Enabled](/cockpit/how-to/enable-alert-manager/) the Scaleway alert manager - - [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 + - [Created](/cockpit/how-to/add-contact-points/) a contact in the Scaleway console or a contact point in Grafana (with the `Scaleway Alerting` alert manager of the same region as your `Scaleway Metrics` data source), otherwise alerts will not be delivered ## Switch to data source managed alert rules @@ -71,13 +71,13 @@ Switch between the tabs below to create alerts for a Scaleway Instance, an Objec ``` 9. In the **Set alert evaluation behavior** field, specify how long the condition must be true before triggering the alert. 10. Enter a name in the **Namespace** and **Group** fields to categorize and manage your alert, and optionally, add annotations. - 11. Enter a label in the **Labels** field and a name in the **Value** field. 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. + 11. Enter a label in the **Labels** field and a name in the **Value** field. 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. 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. 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). 12. Click **Save rule** in the top right corner of your screen to save and activate your alert. - 13. 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). + 13. Optionally, check that your configuration works by temporarily lowering the threshold. This will trigger the alert and notify your [contact](/cockpit/concepts/#contacts). 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**. @@ -100,13 +100,13 @@ Switch between the tabs below to create alerts for a Scaleway Instance, an Objec ``` 9. In the **Set alert evaluation behavior** field, specify how long the condition must be true before triggering the alert. 10. Enter a name in the **Namespace** and **Group** fields to categorize and manage your alert, and optionally, add annotations. - 11. Enter a label in the **Labels** field and a name in the **Value** field. 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. + 11. Enter a label in the **Labels** field and a name in the **Value** field. 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. 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. 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). 12. Click **Save rule** in the top right corner of your screen to save and activate your alert. - 13. 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). + 13. Optionally, check that your configuration works by temporarily lowering the threshold. This will trigger the alert and notify your [contact](/cockpit/concepts/#contacts). 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.** @@ -129,13 +129,13 @@ Switch between the tabs below to create alerts for a Scaleway Instance, an Objec ``` 9. In the **Set alert evaluation behavior** field, specify how long the condition must be true before triggering the alert. 10. Enter a name in the **Namespace** and **Group** fields to categorize and manage your alert, and optionally, add annotations. - 11. Enter a label in the **Labels** field and a name in the **Value** field. 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. + 11. Enter a label in the **Labels** field and a name in the **Value** field. 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. 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. 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). 12. Click **Save rule** in the top right corner of your screen to save and activate your alert. - 13. 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). + 13. Optionally, check that your configuration works by temporarily lowering the threshold. This will trigger the alert and notify your [contact](/cockpit/concepts/#contacts). 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**. @@ -158,13 +158,13 @@ Switch between the tabs below to create alerts for a Scaleway Instance, an Objec ``` 9. In the **Set alert evaluation behavior** field, specify how long the condition must be true before triggering the alert. 10. Enter a name in the **Namespace** and **Group** fields to categorize and manage your alert, and optionally, add annotations. - 11. Enter a label in the **Labels** field and a name in the **Value** field. 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. + 11. Enter a label in the **Labels** field and a name in the **Value** field. 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. 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. 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). 12. Click **Save rule** in the top right corner of your screen to save and activate your alert. - 13. 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). + 13. Optionally, check that your configuration works by temporarily lowering the threshold. This will trigger the alert and notify your [contact](/cockpit/concepts/#contacts). diff --git a/pages/cockpit/how-to/enable-alert-manager.mdx b/pages/cockpit/how-to/enable-alert-manager.mdx index 4f21ee046a..efbb419d64 100644 --- a/pages/cockpit/how-to/enable-alert-manager.mdx +++ b/pages/cockpit/how-to/enable-alert-manager.mdx @@ -1,26 +1,45 @@ --- title: How to enable the alert manager -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. +description: Learn how to enable Scaleway's regionalized alert manager and add contacts to configure alert notifications for your resources. +categories: + - observability dates: - validation: 2025-04-08 + validation: 2025-07-29 posted: 2024-04-05 --- import Requirements from '@macros/iam/requirements.mdx' -This page shows you how to enable Scaleway's regionalized alert manager to configure preconfigured alerts for your Scaleway resources. +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/). + +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. - A Scaleway account logged into the [Scaleway console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization +## How to enable the alert manager + +Enabling Scaleway's regionalized alert manager allows you configure preconfigured alerts for your Scaleway resources. 1. Click **Cockpit** in the **Monitoring** section of the [console](https://console.scaleway.com/) side menu. The **Cockpit** overview page displays. 2. Click the **Alerts** tab. -3. Click **Enable** under the **Alert manager** section. -4. Choose the regions where you want to enable the alert manager. - - 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. - -5. Click **Enable alert manager** to confirm. +3. Click the **Region** drop-down and select the desired region. + + Make sure that you select the same region as the [data sources](/cockpit/concepts/#data-sources) you want to be alerted for. + +4. Click **Enable alert manager** under the **Alert manager** section. A pop-up displays prompting you to configure alert notifications. + + Configuring alert notifications consists of two steps: + - Enabling the alert manager, and + - Adding contacts + This allows the contacts to receive notifications whenever alerts you have configured are triggered. + +5. Click **Enable alert manager** to confirm. The step for adding contacts displays. +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. +7. Optionally, click **Skip for now** if you do not want to add contacts yet. + + 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. + + diff --git a/pages/cockpit/quickstart.mdx b/pages/cockpit/quickstart.mdx index 8907c52b02..252cb0244c 100644 --- a/pages/cockpit/quickstart.mdx +++ b/pages/cockpit/quickstart.mdx @@ -36,7 +36,7 @@ In this documentation, we show you how to retrieve your Grafana credentials to a 5. Select a [role](/cockpit/concepts/#grafana-users) for the user. 6. Click **Add a user**. Your automatically generated password to log in to Grafana displays. Make sure to copy and save it before closing the pop-up. -## How to create a token to push your metrics and logs +## How to create a Cockpit token to push your metrics and logs 1. Click **Cockpit** in the **Monitoring** section of the [console](https://console.scaleway.com/) side menu. The **Cockpit** overview page displays. 2. Click the **Tokens** tab.