diff --git a/docs/sources/alerting/alerting-rules/link-alert-rules-to-panels.md b/docs/sources/alerting/alerting-rules/link-alert-rules-to-panels.md index 78cce1a5efa..4b401cd1d4e 100644 --- a/docs/sources/alerting/alerting-rules/link-alert-rules-to-panels.md +++ b/docs/sources/alerting/alerting-rules/link-alert-rules-to-panels.md @@ -48,7 +48,7 @@ Grafana allows you to link an alert rule to a dashboard panel. This can help you - Visualize the alert state directly from dashboards. - Include a screenshot of the panel in notification messages. -An alert rule is linked to a panel by setting the [`dashboardUId` and `panelId` annotations](ref:annotations). Both annotations must be set together. +An alert rule is linked to a panel by setting the [`__dashboardUid__` and `__panelId__` annotations](ref:annotations). Both annotations must be set together. ## Link alert rules to panels @@ -73,7 +73,7 @@ To streamline alert creation, you can create an alert rule directly from a panel 1. Hover over the top-right corner of a panel and click the panel menu icon. 1. From the dropdown menu, select **More...** > **New alert rule**. 1. This opens the **Edit rule** form and pre-fills some values: - - Sets the `dashboardUId` and `panelId` annotations to the corresponding dashboard and panel. + - Sets the annotations to the corresponding dashboard and panel. - Sets the alert rule query using the panel query. 1. Complete the alert rule configuration and click **Save rule** to initiate the alert rule. diff --git a/docs/sources/alerting/alerting-rules/templates/_index.md b/docs/sources/alerting/alerting-rules/templates/_index.md index cb12bf47513..d068b4a3390 100644 --- a/docs/sources/alerting/alerting-rules/templates/_index.md +++ b/docs/sources/alerting/alerting-rules/templates/_index.md @@ -106,7 +106,7 @@ Both types of templates are written in the Go templating system. However, it's i Annotations are key-value pairs defined in the alert rule. They can contain plain text or template code that is evaluated when the alert fires. -Grafana includes several optional annotations, such as `description`, `summary`, `runbook_url`, `dashboardUId` and `panelId`, which can be edited in the alert rule. You can also create your custom annotations. For example, you might create a new annotation named `location` to report the location of the system that triggered the alert. +Grafana includes several optional annotations, such as `description`, `summary`, and `runbook_url`, which can be edited in the alert rule. You can also create your custom annotations. For example, you might create a new annotation named `location` to report the location of the system that triggered the alert. Here’s an example of a `summary` annotation explaining why the alert was triggered, using plain text. diff --git a/docs/sources/alerting/fundamentals/alert-rules/annotation-label.md b/docs/sources/alerting/fundamentals/alert-rules/annotation-label.md index ade6b016049..8d0aca31034 100644 --- a/docs/sources/alerting/fundamentals/alert-rules/annotation-label.md +++ b/docs/sources/alerting/fundamentals/alert-rules/annotation-label.md @@ -143,7 +143,7 @@ Annotations are displayed in Grafana and are included by default in notification - `summary`: A short summary of what the alert has detected and why. - `description`: A detailed description of what happened and what the alert does. - `runbook_url`: The runbook page to guide operators managing a potential incident. -- `dashboardUId` and `panelId`: [Link the alert to a dashboard and panel](ref:link-alert-rules-to-panels) to facilitate alert investigation. +- `__dashboardUid__` and `__panelId__`: [Link the alert to a dashboard and panel](ref:link-alert-rules-to-panels) to facilitate alert investigation. For example, you can edit the annotation `summary` to explain why the alert was triggered: diff --git a/docs/sources/alerting/fundamentals/templates.md b/docs/sources/alerting/fundamentals/templates.md index 4e4243aee9c..efed6ad7cac 100644 --- a/docs/sources/alerting/fundamentals/templates.md +++ b/docs/sources/alerting/fundamentals/templates.md @@ -90,7 +90,7 @@ In this diagram: [Annotations](ref:annotations) can be defined in the alert rule to add extra information to alert instances. -When creating an alert rule, Grafana suggests several optional annotations, such as `description`, `summary`, `runbook_url`, `dashboardUId` and `panelId`, which help identify and respond to alerts. You can also create custom annotations. +When creating an alert rule, Grafana suggests several optional annotations, such as `description`, `summary`, and `runbook_url`, which help identify and respond to alerts. You can also create custom annotations. Annotations are key-value pairs, and their values can contain a combination of text and template code that is evaluated when the alert fires. diff --git a/docs/sources/shared/alerts/alerting_provisioning.md b/docs/sources/shared/alerts/alerting_provisioning.md index 40d3c72622d..2e6ef9a905b 100644 --- a/docs/sources/shared/alerts/alerting_provisioning.md +++ b/docs/sources/shared/alerts/alerting_provisioning.md @@ -1779,24 +1779,24 @@ When creating a contact point, the `EmbeddedContactPoint.name` property determin {{% responsive-table %}} -| Name | Type | Go type | Required | Default | Description | Example | -| ------------- | ---------------------------- | ------------------------- | :------: | ------- | ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `annotations` | map of string | `map[string]string` | | | Optional key-value pairs. `dashboardUId` and `panelId` must be set together; one cannot be set without the other. | `{"runbook_url":"https://supercoolrunbook.com/page/13"}` | -| `condition` | string | string | ✓ | | | `A` | -| `data` | [][AlertQuery](#alert-query) | `[]*AlertQuery` | ✓ | | | `[{"datasourceUid":"__expr__","model":{"conditions":[{"evaluator":{"params":[0,0],"type":"gt"},"operator":{"type":"and"},"query":{"params":[]},"reducer":{"params":[],"type":"avg"},"type":"query"}],"datasource":{"type":"__expr__","uid":"__expr__"},"expression":"1 == 1","hide":false,"intervalMs":1000,"maxDataPoints":43200,"refId":"A","type":"math"},"queryType":"","refId":"A","relativeTimeRange":{"from":0,"to":0}}]` | -| execErrState | string | string | ✓ | | | | -| `folderUID` | string | string | ✓ | | | `project_x` | -| `for` | [Duration](#duration) | [Duration](#duration) | ✓ | | | | -| `id` | int64 (formatted integer) | int64 | | | | | -| `isPaused` | boolean | `bool` | | | | `false` | -| `labels` | map of string | `map[string]string` | | | | `{"team":"sre-team-1"}` | -| `noDataState` | string | string | ✓ | | | | -| `orgID` | int64 (formatted integer) | `int64 | ✓ | | | | -| `provenance` | [Provenance](#provenance) | [Provenance](#provenance) | | | | | -| `ruleGroup` | string | string | ✓ | | | `eval_group_1` | -| `title` | string | string | ✓ | | | `Always firing` | -| `uid` | string | string | | | | | -| `updated` | date-time (formatted string) | `strfmt.DateTime` | | | | | +| Name | Type | Go type | Required | Default | Description | Example | +| ------------- | ---------------------------- | ------------------------- | :------: | ------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `annotations` | map of string | `map[string]string` | | | Optional key-value pairs. `__dashboardUid__` and `__panelId__` must be set together; one cannot be set without the other. | `{"runbook_url":"https://supercoolrunbook.com/page/13"}` | +| `condition` | string | string | ✓ | | | `A` | +| `data` | [][AlertQuery](#alert-query) | `[]*AlertQuery` | ✓ | | | `[{"datasourceUid":"__expr__","model":{"conditions":[{"evaluator":{"params":[0,0],"type":"gt"},"operator":{"type":"and"},"query":{"params":[]},"reducer":{"params":[],"type":"avg"},"type":"query"}],"datasource":{"type":"__expr__","uid":"__expr__"},"expression":"1 == 1","hide":false,"intervalMs":1000,"maxDataPoints":43200,"refId":"A","type":"math"},"queryType":"","refId":"A","relativeTimeRange":{"from":0,"to":0}}]` | +| execErrState | string | string | ✓ | | | | +| `folderUID` | string | string | ✓ | | | `project_x` | +| `for` | [Duration](#duration) | [Duration](#duration) | ✓ | | | | +| `id` | int64 (formatted integer) | int64 | | | | | +| `isPaused` | boolean | `bool` | | | | `false` | +| `labels` | map of string | `map[string]string` | | | | `{"team":"sre-team-1"}` | +| `noDataState` | string | string | ✓ | | | | +| `orgID` | int64 (formatted integer) | `int64 | ✓ | | | | +| `provenance` | [Provenance](#provenance) | [Provenance](#provenance) | | | | | +| `ruleGroup` | string | string | ✓ | | | `eval_group_1` | +| `title` | string | string | ✓ | | | `Always firing` | +| `uid` | string | string | | | | | +| `updated` | date-time (formatted string) | `strfmt.DateTime` | | | | | {{% /responsive-table %}}