PMM-13235 Merge branch 'release-11.1.5'

percona · Sep 6, 2024 · b7c37f0 · b7c37f0
2 parents 6814ac9 + 9731d7c
commit b7c37f0
Show file tree

Hide file tree

Showing 131 changed files with 1,789 additions and 959 deletions.
diff --git a/.betterer.results b/.betterer.results
@@ -2955,7 +2955,9 @@ exports[`better eslint`] = {
       [0, 0, 0, "Unexpected any. Specify a different type.", "9"],
       [0, 0, 0, "Unexpected any. Specify a different type.", "10"],
       [0, 0, 0, "Unexpected any. Specify a different type.", "11"],
-      [0, 0, 0, "Unexpected any. Specify a different type.", "12"]
+      [0, 0, 0, "Unexpected any. Specify a different type.", "12"],
+      [0, 0, 0, "Unexpected any. Specify a different type.", "13"],
+      [0, 0, 0, "Unexpected any. Specify a different type.", "14"]
     ],
     "public/app/features/dashboard-scene/serialization/transformSceneToSaveModel.ts:5381": [
       [0, 0, 0, "Do not use any type assertions.", "0"],

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,12 @@
+<!-- 11.1.4 START -->
+
+# 11.1.4 (2024-08-14)
+
+### Bug fixes
+
+- **Swagger:** Fixed CVE-2024-6837.
+
+<!-- 11.1.4 END -->
 <!-- 11.1.3 START -->
 
 # 11.1.3 (2024-07-26)

diff --git a/...nistration/data-source-management/teamlbac/configure-teamlbac-for-loki/index.md b/...nistration/data-source-management/teamlbac/configure-teamlbac-for-loki/index.md
@@ -42,4 +42,4 @@ We recommend that you remove all permissions for roles and teams that are not re
 1. Navigate to Data Source Permissions
    - Go to the permissions tab of the newly created Loki data source. Here, you'll find the Team LBAC rules section.
 
-For more information on how to setup Team LBAC rules for a Loki data source, [Add Team LBAC rules]({{< relref "./../create-teamlbac-rules/" >}}).
+For more information on how to setup Team LBAC rules for a Loki data source, refer to [Create Team LBAC rules for the Loki data source](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/administration/data-source-management/teamlbac/create-teamlbac-rules/).
diff --git a/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md b/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md
@@ -83,11 +83,8 @@ Grafana-managed rules are the most flexible alert rule type. They allow you to c
 Multiple alert instances can be created as a result of one alert rule (also known as a multi-dimensional alerting).
 
 {{% admonition type="note" %}}
-For Grafana Cloud, there are limits on how many Grafana-managed alert rules you can create. These are as follows:
-
-- Free: 100 alert rules
-- Paid: 2000 alert rules
-  {{% /admonition %}}
+For Grafana Cloud, you can create 100 free Grafana-managed alert rules.
+{{% /admonition %}}
 
 Grafana managed alert rules can only be edited or deleted by users with Edit permissions for the folder storing the rules.
 
@@ -256,7 +253,7 @@ You can configure the alert instance state when its evaluation returns no data:
 | No Data configuration | Description                                                                                                                                                                                                                               |
 | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | No Data               | The default option. Sets alert instance state to `No data`. <br/> The alert rule also creates a new alert instance `DatasourceNoData` with the name and UID of the alert rule, and UID of the datasource that returned no data as labels. |
-| Alerting              | Sets alert instance state to `Alerting`. It waits until the [pending period](ref:pending-period) has finished.                                                                                                                            |
+| Alerting              | Sets alert instance state to `Alerting`. It transitions from `Pending` to `Alerting` after the [pending period](ref:pending-period) has finished.                                                                                         |
 | Normal                | Sets alert instance state to `Normal`.                                                                                                                                                                                                    |
 | Keep Last State       | Maintains the alert instance in its last state. Useful for mitigating temporary issues, refer to [Keep last state](ref:keep-last-state).                                                                                                  |
 
@@ -265,7 +262,7 @@ You can also configure the alert instance state when its evaluation returns an e
 | Error configuration | Description                                                                                                                                                                                                                            |
 | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | Error               | The default option. Sets alert instance state to `Error`. <br/> The alert rule also creates a new alert instance `DatasourceError` with the name and UID of the alert rule, and UID of the datasource that returned no data as labels. |
-| Alerting            | Sets alert instance state to `Alerting`. It waits until the [pending period](ref:pending-period) has finished.                                                                                                                         |
+| Alerting            | Sets alert instance state to `Alerting`. It transitions from `Pending` to `Alerting` after the [pending period](ref:pending-period) has finished.                                                                                      |
 | Normal              | Sets alert instance state to `Normal`.                                                                                                                                                                                                 |
 | Keep Last State     | Maintains the alert instance in its last state. Useful for mitigating temporary issues, refer to [Keep last state](ref:keep-last-state).                                                                                               |
 

diff --git a/...figure-notifications/manage-contact-points/integrations/configure-amazon-sns.md b/...figure-notifications/manage-contact-points/integrations/configure-amazon-sns.md
@@ -0,0 +1,57 @@
+---
+canonical: https://grafana.com/docs/grafana/latest/alerting/configure-notifications/manage-contact-points/integrations/configure-amazon-sns/
+description: Configure the Grafana Alerting - Amazon SNS integration to receive alert notifications when your alerts are firing.
+keywords:
+  - grafana
+  - alerting
+  - Amazon SNS
+  - integration
+labels:
+  products:
+    - cloud
+    - enterprise
+    - oss
+menuTitle: Amazon SNS
+title: Configure Amazon SNS for Alerting
+weight: 0
+---
+
+# Configure Amazon SNS for Alerting
+
+Use the Grafana Alerting - Amazon SNS integration to send notifications to Amazon SNS when your alerts are firing.
+
+## Before you begin
+
+To configure Amazon SNS to receive alert notifications, complete the following steps.
+
+1. Create a new topic in https://console.aws.amazon.com/sns.
+1. Open the topic and create a new subscription.
+1. Choose the protocol HTTPS.
+1. Copy the URL.
+
+For more information, refer to [Amazon SNS documentation](https://docs.aws.amazon.com/sns/latest/dg/welcome.html).
+
+## Procedure
+
+To create your Amazon SNS integration in Grafana Alerting, complete the following steps.
+
+1. Navigate to **Alerts & IRM** -> **Alerting** -> **Contact points**.
+1. Click **+ Add contact point**.
+1. Enter a contact point name.
+1. From the Integration list, select **AWS SNS**.
+1. Copy in the URL from above into the **The Amazon SNS API URL** field.
+1. Click **Test** to check that your integration works.
+1. Click **Save contact point**.
+
+## Next steps
+
+The Amazon SNS contact point is ready to receive alert notifications.
+
+To add this contact point to your alert, complete the following steps.
+
+1. In Grafana, navigate to **Alerting** > **Alert rules**.
+1. Edit or create a new alert rule.
+1. Scroll down to the **Configure labels and notifications** section.
+1. Under Notifications click **Select contact point**.
+1. From the drop-down menu, select the previously created contact point.
+1. **Click Save rule and exit**.
diff --git a/...configure-notifications/manage-contact-points/integrations/configure-discord.md b/...configure-notifications/manage-contact-points/integrations/configure-discord.md
@@ -13,7 +13,7 @@ labels:
     - oss
 menuTitle: Discord
 title: Configure Discord for Alerting
-weight: 10
+weight: 0
 ---
 
 # Configure Discord for Alerting

diff --git a/...g/configure-notifications/manage-contact-points/integrations/configure-email.md b/...g/configure-notifications/manage-contact-points/integrations/configure-email.md
@@ -13,7 +13,7 @@ labels:
     - oss
 menuTitle: Email
 title: Configure email for Alerting
-weight: 20
+weight: 0
 ---
 
 # Configure email for Alerting

diff --git a/...igure-notifications/manage-contact-points/integrations/configure-google-chat.md b/...igure-notifications/manage-contact-points/integrations/configure-google-chat.md
@@ -13,7 +13,7 @@ labels:
     - oss
 menuTitle: Google Chat
 title: Configure Google Chat for Alerting
-weight: 30
+weight: 0
 ---
 
 # Configure Google Chat for Alerting

diff --git a/.../configure-notifications/manage-contact-points/integrations/configure-oncall.md b/.../configure-notifications/manage-contact-points/integrations/configure-oncall.md
@@ -18,7 +18,7 @@ labels:
     - oss
 menuTitle: Grafana OnCall
 title: Configure Grafana OnCall for Alerting
-weight: 40
+weight: 0
 ---
 
 # Configure Grafana OnCall for Alerting

diff --git a/...onfigure-notifications/manage-contact-points/integrations/configure-opsgenie.md b/...onfigure-notifications/manage-contact-points/integrations/configure-opsgenie.md
@@ -13,7 +13,7 @@ labels:
     - oss
 menuTitle: Opsgenie
 title: Configure Opsgenie for Alerting
-weight: 60
+weight: 0
 ---
 
 # Configure Opsgenie for Alerting

diff --git a/...g/configure-notifications/manage-contact-points/integrations/configure-slack.md b/...g/configure-notifications/manage-contact-points/integrations/configure-slack.md
@@ -13,7 +13,7 @@ labels:
     - oss
 menuTitle: Slack
 title: Configure Slack for Alerting
-weight: 80
+weight: 0
 refs:
   nested-policy:
     - pattern: /docs/grafana/

diff --git a/...g/configure-notifications/manage-contact-points/integrations/configure-teams.md b/...g/configure-notifications/manage-contact-points/integrations/configure-teams.md
@@ -13,7 +13,7 @@ labels:
     - oss
 menuTitle: Microsoft Teams
 title: Configure Microsoft Teams for Alerting
-weight: 50
+weight: 0
 ---
 
 # Configure Microsoft Teams for Alerting
@@ -22,15 +22,16 @@ Use the Grafana Alerting - Microsoft Teams integration to receive notifications
 
 ## Before you begin
 
-To set up Microsoft Teams for integration with Grafana Alerting, you need to create an incoming Webhook. This allows Grafana to send alert notifications to Microsoft Teams channels.
+To set up Microsoft Teams for integration with Grafana Alerting, create a new workflow that accepts Webhook requests. This allows Grafana to send alert notifications to Microsoft Teams channels.
 
-### Create an incoming Webhook in Microsoft Teams
+### Create a workflow in Microsoft Teams
 
-1. To add an incoming Webhook to a Teams channel, follow the steps in the [Create an Incoming Webhook guide](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook?tabs=newteams%2Cdotnet#create-an-incoming-webhook).
+1. To create a new workflow, follow the steps in [Create flows in Microsoft Teams](https://learn.microsoft.com/en-us/power-automate/teams/teams-app-create).
+1. Microsoft provides a template library. You can use the template **Post to a channel when a webhook request is received**.
+1. At the end of workflow creation wizard, copy the URL that is provided.
 
-   Note: The steps to create incoming Webhooks may vary depending on the version of Microsoft Teams you are using. You can switch between the "New Teams" and "Classic Teams" tabs to view the relevant instructions for your version.
-
-1. Copy the Webhook URL.
+**Note**
+If you chose a private channel for the target of the workflow, you need to edit workflow before using it. Expand the step "Send each adaptive card", and then expand action "Post your own adaptive card as the Flow bot to a channel". Change "Post as" to User, and save the workflow.
 
 ## Procedure
 
@@ -57,3 +58,7 @@ To add this contact point to your alert, complete the following steps.
 1. Under Notifications click **Select contact point**.
 1. From the drop-down menu, select the previously created contact point.
 1. **Click Save rule and exit**.
+
+## Troubleshooting
+
+- If Grafana reports that notification was sent successfully but it was not delivered to the channel, check the workflow's run history. You can find it in the workflow details page.
diff --git a/...onfigure-notifications/manage-contact-points/integrations/configure-telegram.md b/...onfigure-notifications/manage-contact-points/integrations/configure-telegram.md
@@ -13,7 +13,7 @@ labels:
     - oss
 menuTitle: Telegram
 title: Configure Telegram for Alerting
-weight: 90
+weight: 0
 ---
 
 # Configure Telegram for Alerting

diff --git a/...erting/configure-notifications/manage-contact-points/integrations/pager-duty.md b/...erting/configure-notifications/manage-contact-points/integrations/pager-duty.md
@@ -14,7 +14,7 @@ labels:
     - oss
 menuTitle: PagerDuty
 title: Configure PagerDuty for Alerting
-weight: 70
+weight: 0
 ---
 
 # Configure PagerDuty for Alerting

diff --git a/.../configure-notifications/manage-contact-points/integrations/webhook-notifier.md b/.../configure-notifications/manage-contact-points/integrations/webhook-notifier.md
@@ -21,7 +21,7 @@ labels:
     - oss
 menuTitle: Webhook notifier
 title: Configure the webhook notifier for Alerting
-weight: 100
+weight: 0
 ---
 
 # Configure the webhook notifier for Alerting

diff --git a/docs/sources/alerting/fundamentals/alert-rule-evaluation/state-and-health.md b/docs/sources/alerting/fundamentals/alert-rule-evaluation/state-and-health.md
@@ -44,13 +44,13 @@ There are three key components that help you understand how your alerts behave d
 
 An alert instance can be in either of the following states:
 
-| State        | Description                                                                                                                                                                                                                               |
-| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **Normal**   | The state of an alert when the condition (threshold) is not met.                                                                                                                                                                          |
-| **Pending**  | The state of an alert that has breached the threshold but for less than the [pending period](ref:pending-period).                                                                                                                         |
-| **Alerting** | The state of an alert that has breached the threshold for longer than the [pending period](ref:pending-period).                                                                                                                           |
-| **NoData**   | The state of an alert whose query returns no data or all values are null. You can [change the default behavior](/docs/grafana/latest/alerting/alerting-rules/create-grafana-managed-rule/#configure-no-data-and-error-handling).          |
-| **Error**    | The state of an alert when an error or timeout occurred evaluating the alert rule. You can [change the default behavior](/docs/grafana/latest/alerting/alerting-rules/create-grafana-managed-rule/#configure-no-data-and-error-handling). |
+| State        | Description                                                                                                                                                                       |
+| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **Normal**   | The state of an alert when the condition (threshold) is not met.                                                                                                                  |
+| **Pending**  | The state of an alert that has breached the threshold but for less than the [pending period](ref:pending-period).                                                                 |
+| **Alerting** | The state of an alert that has breached the threshold for longer than the [pending period](ref:pending-period).                                                                   |
+| **NoData**   | The state of an alert whose query returns no data or all values are null. You can [change the default behavior of the no data state](#modify-the-no-data-and-error-state).        |
+| **Error**    | The state of an alert when an error or timeout occurred evaluating the alert rule. You can [change the default behavior of the error state](#modify-the-no-data-and-error-state). |
 
 {{< figure src="/media/docs/alerting/alert-instance-states-v3.png" caption="Alert instance state diagram" alt="A diagram of the distinct alert instance states and transitions." max-width="750px" >}}
 
@@ -64,18 +64,37 @@ Alert instances will be routed for [notifications](ref:notifications) when they
 
 An alert instance is considered stale if its dimension or series has disappeared from the query results entirely for two evaluation intervals.
 
-Stale alert instances that are in the **Alerting**, **NoData**, or **Error** states transition to the **Normal** state as **Resolved**, and include the `grafana_state_reason` annotation with the value **MissingSeries**. They are routed for notifications like other resolved alert instances.
+Stale alert instances that are in the **Alerting**, **NoData**, or **Error** states transition to the **Normal** state as **Resolved**. Once transitioned, these resolved alert instances are routed for notifications like other resolved alerts.
 
-### Keep last state
+### Modify the no data and error state
 
-The "Keep Last State" option helps mitigate temporary data source issues, preventing alerts from unintentionally firing, resolving, and re-firing.
-
-In [Configure no data and error handling,](ref:no-data-and-error-handling) you can decide to keep the last state of the alert instance when a `NoData` and/or `Error` state is encountered. Just like normal evaluation, the alert instance transitions from `Pending` to `Alerting` after the pending period has elapsed.
+In [Configure no data and error handling](ref:no-data-and-error-handling), you can change the default behaviour when the evaluation returns no data or an error. You can set the alert instance state to `Alerting`, `Normal`, or keep the last state.
 
 {{< figure src="/media/docs/alerting/alert-rule-configure-no-data-and-error.png" alt="A screenshot of the `Configure no data and error handling` option in Grafana Alerting." max-width="500px" >}}
 
+#### Keep last state
+
+The "Keep Last State" option helps mitigate temporary data source issues, preventing alerts from unintentionally firing, resolving, and re-firing.
+
 However, in situations where strict monitoring is critical, relying solely on the "Keep Last State" option may not be appropriate. Instead, consider using an alternative or implementing additional alert rules to ensure that issues with prolonged data source disruptions are detected.
 
+### `grafana_state_reason` annotation
+
+Occasionally, an alert instance may be in a state that isn't immediately clear to everyone. For example:
+
+- Stale alert instances in the `Alerting` state transition to the `Normal` state when the series disappear.
+- If "no data" handling is configured to transition to a state other than `NoData`.
+- If "error" handling is configured to transition to a state other than `Error`.
+- If the alert rule is deleted, paused, or updated in some cases, the alert instance also transitions to the `Normal` state.
+
+In these situations, the evaluation state may differ from the alert state, and it might be necessary to understand the reason for being in that state when receiving the notification.
+
+The `grafana_state_reason` annotation is included in these situations, providing the reason in the notifications that explain why the alert instance transitioned to its current state. For example:
+
+- Stale alert instances in the `Normal` state include the `grafana_state_reason` annotation with the value **MissingSeries**.
+- If "no data" or "error" handling transitions to the `Normal` state, the `grafana_state_reason` annotation is included with the value **NoData** or **Error**, respectively.
+- If the alert rule is deleted or paused, the `grafana_state_reason` is set to **Paused** or **RuleDeleted**. For some updates, it is set to **Updated**.
+
 ### Special alerts for `NoData` and `Error`
 
 When evaluation of an alert rule produces state `NoData` or `Error`, Grafana Alerting generates a new alert instance that have the following additional labels:

diff --git a/docs/sources/dashboards/create-manage-playlists/index.md b/docs/sources/dashboards/create-manage-playlists/index.md
@@ -26,6 +26,10 @@ Grafana automatically scales dashboards to any resolution, which makes them perf
 
 You can access the Playlist feature from Grafana's side menu, in the Dashboards submenu.
 
+{{< admonition type="note" >}}
+You must have at least Editor role permissions to create and manage playlists.
+{{< /admonition >}}
+
 ## Access, share, and control a playlist
 
 Use the information in this section to access existing playlists. Start and control the display of a playlist using one of the five available modes.