feat(docs): update ckpt docs with new grafana ui #5298
Conversation
nerda-codes
added
type: maintenance
|
nerda-codes
changed the title
| import MetricsExplorer from './assets/scaleway-metrics-explorer.webp' | ||
| import FiringAlertTabs from './assets/scaleway-firing-alert-tabs.webp' | ||
| import AlertsFiringGrafana from './assets/scaleway-alert-firing.webp' | ||
| import AlertsViaGrafanaUI from './assets/scaleway-alerts-via-grafana-ui.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. |
There was a problem hiding this comment.
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 datasource-level and notifications are handled and sent out by the Scaleway alert manager only.
Once the conditions of your alert rule are met, the rule evaluation engine of your datasource forwards the firing alert to the Scaleway alert manager, which then sends a notification to the contact points you have configured in the Scaleway console or in Grafana.
| import MetricsExplorer from './assets/scaleway-metrics-explorer.webp' | ||
| import FiringAlertTabs from './assets/scaleway-firing-alert-tabs.webp' | ||
| import AlertsFiringGrafana from './assets/scaleway-alert-firing.webp' | ||
| import AlertsViaGrafanaUI from './assets/scaleway-alerts-via-grafana-ui.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. |
There was a problem hiding this comment.
After the paragraph below, we can also add a small sentence saying that they can also create alerting rules on their own custom datasources. As such, it may be interpreted as alerting rules can only be set on the Scaleway metrics which is not the case
| @@ -36,15 +30,24 @@ This page shows you how to create alert rules in Grafana for monitoring Scaleway | |||
| - [Enabled](/cockpit/how-to/enable-alert-manager/) the Scaleway alert manager | |||
There was a problem hiding this comment.
as you did below, should we explicitly say: "in the same region as your Scaleway metrics datasources" / in the same region as the resources you want to be alerted on.
- maybe it would be worth reminding in the introduction (in this doc or maybe it's more in the global one on enabling the alertmanager and creating contacts), that alert manager and alerting rules are scoped per region per project.
| @@ -36,15 +30,24 @@ This page shows you how to create alert rules in Grafana for monitoring Scaleway | |||
| - [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 | |||
|
|
|||
| ## Switch to data source managed alert rules | |||
| ## Switch to the data source-managed tab | |||
|
|
|||
| 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. | |||
There was a problem hiding this comment.
Shall we put in bold "which is not supported" ?
| 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. | ||
| 2. In the **Set alert evaluation behavior** section, specify how long the condition must be true before triggering the alert. |
There was a problem hiding this comment.
must be "met" rather than true ?
| 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. | ||
| 2. In the **Set alert evaluation behavior** section, specify how long the condition must be true before triggering the alert. | ||
| 3. Enter a name in the **Namespace** and **Group** fields to categorize and manage your alert, and optionally, add annotations. |
There was a problem hiding this comment.
I would explicitly say that rules that share the same "group" will share the same configuration, in particular the evaluation interval (i.e. how often the rule will be evaluated). By default it's evaluated every 1 minute, and it can be changed in the group settings afterwards.
/!\ the "evaluation interval" is different than the pending period of step 2 ! you can be evaluated every minute, but need a 10mn pending period -> this means that we will check if the rule meets the condition every minute, and if it does for 10 minutes (aka ten consecutive times), it will fire. If we only evaluate every 5 mn, we will wait for 3 consecutive time == 10 minutes has lapsed to fire. No need to explain all that here though...
| 2. In the **Set alert evaluation behavior** section, specify how long the condition must be true before triggering the alert. | ||
| 3. Enter a name in the **Namespace** and **Group** fields to categorize and manage your alert, and optionally, add annotations. | ||
| 4. In the **Configure labels and notifications** section, click **+ Add labels**. A pop-up appears. | ||
| 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. |
There was a problem hiding this comment.
To take this step you must have created labels beforehand no ?
| 2. In the **Set alert evaluation behavior** section, specify how long the condition must be true before triggering the alert. | ||
| 3. Enter a name in the **Namespace** and **Group** fields to categorize and manage your alert, and optionally, add annotations. | ||
| 4. In the **Configure labels and notifications** section, click **+ Add labels**. A pop-up appears. | ||
| 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. | ||
| <Message type="note"> | ||
| 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). |
There was a problem hiding this comment.
I'm not sure I fully understand the note (but i don't understand Grafana's stuff here on groups, labels and policies). Your "Instances team" is what you defined a notification policies child right ?
| 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). | ||
| 6. Click **Save rule and exit** in the top right corner of your screen to save and activate your alert. | ||
| 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). |
There was a problem hiding this comment.
contact points in plural ?
| **You can configure up to a maximum of 10 alerts** for the `Scaleway Metrics` data source. | ||
|
|
||
| <Message type="tip"> | ||
| 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. |
There was a problem hiding this comment.
Should be more explicit ? "To get help in building your PromQL expression and finding the right metrics, you can also start building your alerts from the Grafana-managed tab.... once you are done building them before proceeding with the final configuration steps." ?
No description provided.