Commit Graph

600 Commits

Author SHA1 Message Date
grafana-delivery-bot[bot] 4b6b5a92ed [v10.4.x] Update the docs for state_periodic_save_interval (#86667)
Update the docs for state_periodic_save_interval (#86611)

This commit updates the docs for state_periodic_save_interval following
a question in the forums about what the consequences of this change could
be.

(cherry picked from commit 30d38c1775)

Co-authored-by: George Robinson <george.robinson@grafana.com>
2024-04-22 12:43:42 +03:00
grafana-delivery-bot[bot] 58b3dd2fe7 [v10.4.x] Embed creating alerts with Grafana video to the documentation (#86665)
Embed creating alerts with Grafana video to the documentation (#86386)

(cherry picked from commit 65e6b67b2e)

Co-authored-by: Lisa <60980933+LisaHJung@users.noreply.github.com>
2024-04-22 11:13:18 +02:00
grafana-delivery-bot[bot] f7070df4d3 [v10.4.x] Alerting docs: add Template variable interpolation section in file provisioning (#85745)
Alerting docs: add `Template variable interpolation` section in file provisioning (#84106)

* Alerting docs: add `Template variable interpolation` section in file provisioning

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: Matthew Jacobson <matthew.jacobson@grafana.com>

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Matthew Jacobson <matthew.jacobson@grafana.com>
(cherry picked from commit 0672bdf397)

Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>
2024-04-08 17:44:10 +02:00
grafana-delivery-bot[bot] 8358e3db22 [v10.4.x] Alerting docs: update disable_provenance TF mute_timing (#85713)
Alerting docs: update `disable_provenance` TF mute_timing (#85692)

(cherry picked from commit d7ad7c6169)

Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>
2024-04-08 10:53:26 +02:00
grafana-delivery-bot[bot] 95604c1355 [v10.4.x] Alerting: Add docs for "Keep Last State" feature (#84943)
Alerting: Add docs for "Keep Last State" feature (#84676)

Add initial docs for "Keep Last State" feature

(cherry picked from commit c5b04b5674)

Co-authored-by: William Wernert <william.wernert@grafana.com>
2024-03-21 14:57:31 -04:00
Pepe Cano d3ce857c0e [v10.4.x] alerting docs: slack integration (#84823)
Alerting docs: Fix format issues on `Configure Slack` guide

Co-authored-by: tonypowa <45235678+tonypowa@users.noreply.github.com>
2024-03-20 15:29:54 +01:00
Pepe Cano de5b771270 [v10.4.x] Alerting docs: Fix broken links in TF Provisioning page (#84580) 2024-03-15 16:24:12 +01:00
grafana-delivery-bot[bot] 3f596e8e8c [v10.4.x] Alerting docs: document HTTP API to create templates (#84424)
Alerting docs: document HTTP API to create templates (#84055)

(cherry picked from commit e1d9aa5a7b)

Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>
2024-03-14 09:08:16 +01:00
grafana-delivery-bot[bot] 5c2b7e5c62 [v10.4.x] Alerting docs: update the supported export template functionality (#84050)
Alerting docs: update the supported export template functionality (#83816)

(cherry picked from commit dbb55f291a)

Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>
2024-03-07 09:16:19 +01:00
Pepe Cano 90b9cefd4b [v10.4.x] Alerting docs: update file provisioning guide (#83957)
Alerting docs: update file provisioning guide (#83924)

(cherry picked from commit 2653bd8fab)
2024-03-06 12:00:56 +01:00
Pepe Cano 2c3f9581cf Backport alerting docs changes to v10.4.x (#83898)
* Alerting docs: update Alerting Provisioning (#83376)

* Minor updates to Provisioning Index page

* Add instructions to export other alerting resources

* Edit example provisioning a `template` via config file

* Add `Resource` column to the `Export API endpoints` table

* Sort the `export` endpoint on the table in `Alerting Provisioning HTTP API`

* Minor updates for clarity to `Use configuration files to provision` docs

* Add `More examples` in Terraform Provisioning docs

* File provisioning: rename `Useful Links` section to `More examples`

* Minor grammar change

* Update docs/sources/alerting/set-up/provision-alerting-resources/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Address requested changes to `Export` docs

* export: Minor grammar change

* Update docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Fix `doc-validator` issue with relative link

* Use patch fixed version of doc-validator that better supports docs/reference destinations

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
(cherry picked from commit eb25b669c6)

* Alerting docs: fix incorrect `docs/reference` link

(cherry picked from commit c3c6ee4dca)

* Alerting docs: document `mute-timings` export endpoints (#83797)

(cherry picked from commit 244589d7ea)

* Alerting docs: improve visibility on the distinct options to edit provisioned resources (#83839)

Alerting docs: specify the distinct options to edit provisioned resources

(cherry picked from commit 019c9618f0)
2024-03-06 10:43:53 +01:00
grafana-delivery-bot[bot] 906490eeac [v10.4.x] alerting:clarify silence preview (#83838)
alerting:clarify silence preview (#83754)

* alerting:clarify silence preview

* prettier

* Update docs/sources/alerting/configure-notifications/create-silence.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Lint docs

---------

Co-authored-by: Armand Grillet <2117580+armandgrillet@users.noreply.github.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
(cherry picked from commit 89575f1df4)

Co-authored-by: tonypowa <45235678+tonypowa@users.noreply.github.com>
2024-03-04 19:36:44 +01:00
Pepe Cano deec5361b7 [v10.4.x] Alerting docs: update the Terraform Provision guide (#83820)
* Alerting docs: update the Terraform Provision guide (#83773)

* Alerting docs: update the Terraform Provision guide

* Fix incorrect links

* Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
(cherry picked from commit 111df1bba0)

* Fix `doc-validator` issue with relative link

* Use patch fixed version of doc-validator that better supports docs/reference destinations

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

(cherry picked from commit eb25b669c6)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2024-03-04 15:51:06 +01:00
Jack Baldry 676fd4c08e [v10.4.x] Fix typos (#83682)
* Fix typos (#83621)

Co-authored-by: Isabel Matwawana <isabel.matwawana@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
(cherry picked from commit 2a429cd7db)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fixed typo

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: omahs <73983677+omahs@users.noreply.github.com>
Co-authored-by: Isabel Matwawana <isabel.matwawana@grafana.com>
2024-02-29 13:40:03 -05:00
grafana-delivery-bot[bot] 6e7ba7c593 [v10.4.x] Alerting docs: fixes oncall broken links (#83167)
Alerting docs: fixes oncall broken links (#83139)

(cherry picked from commit 4b2ef36165)

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-02-21 14:12:44 +02:00
grafana-delivery-bot[bot] f6ab4e1323 [v10.4.x] Alerting docs: Fix migrating alert links (#83165)
Alerting docs: Fix migrating alert links (#83141)

* Alerting docs: fixes migrating links

* Fixes underscores and stars

* Corrects numbering

* ran prettier

* Fix links

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/alerting/set-up/migrating-alerts/_index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
(cherry picked from commit 4720c99bd5)

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-02-21 14:10:24 +02:00
grafana-delivery-bot[bot] 8e9fb37451 [v10.4.x] Alerting docs: adds simplified alert routing (#83159)
Alerting docs: adds simplified alert routing (#82158)

* Alerting docs: adds simplified alert routing

* adds to preview section

* adds numbering

* adds indent

* deletes fullstop

* ran prettier

* adds feature toggle notes

* fixes spelling error

(cherry picked from commit d091e4c264)

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-02-21 13:25:06 +02:00
Matthew Jacobson 118e4a50b7 Alerting: Remove start page of legacy upgrade preview (#82010)
Alerting: Remove start page of upgrade preview

Alerting upgrade page will now always show the summary table even before
upgrading any alerts or notification channels. There a few reasons for this:

- The information on the start page is redundant as it's now contained in the
documentation.
- Previously, if some unexpected issue prevented performing a full upgrade, a
user would have limited to no means to using the preview tool to help fix the
problem. This is because you could not see the summary table until the full
upgrade was performed at least once. Now, you can upgrade individual alerts and
notification channels from the beginning.
2024-02-15 17:34:00 -05:00
Pepe Cano 3909b4c14a Alerting docs: update <GRAFANA VERSION> to <GRAFANA_VERSION> (#82324) 2024-02-13 09:21:50 +00:00
Pepe Cano 9c92329bee Alerting docs: Provision alerting resources updates (#82221)
* Alert provisioning: initial restructuring

* Fix products labels

* Restructure `Import and export Grafana Alerting resources`

* Change URL to `export-alerting-resources`

* Complete `Export alerting resources`

* Export alerting resources

* Update `configuration files` provisioning

* Terraform Provisioning

* Change to `Provision/Import/Export` terms and some notes

* Replace `config` to `configuration`

* Set (menu)Title `Export alerting resources`

* Minor change on note about `Export Alerting endpoints`

* Fix `doc-validator` issues

* Fix grammar

* Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Fix numbered lists and `Note:` without admonition

* Convert text-based notes (`Note:`) to `admonition` blocks

* Replace text-based `Note:` with adminitions

* Remove `file-provisioning` grafana-cloud links

* Update `Export alerting resources` intro

* nitpicky format order

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-02-12 10:27:18 +01:00
Matthew Jacobson ce57166c9a Alerting: GA alertingPreviewUpgrade and enable by default (#82038)
* Alerting: GA alertingPreviewUpgrade and enable by default
2024-02-08 18:59:25 +01:00
brendamuir 899e06b439 Alerting docs: changes alerting rules to alert rules (#82049)
* Alerting docs: changes alerting rules to alert rules

* ran prettier
2024-02-07 11:04:13 +01:00
Wil.P 679d90be04 Patch 3 (#81937)
* Update _index.md

moved to the asked location

* ran prettier

* Update docs/sources/alerting/set-up/provision-alerting-resources/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/_index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-02-06 14:26:31 +01:00
brendamuir 95f90127ad Alerting docs: rename provisioning files (#81722) 2024-02-01 17:50:29 +01:00
brendamuir bac4c7fb32 Alerting docs: corrects save text (#81700)
* Alerting docs: corrects save text

* updates numbering
2024-02-01 12:43:11 +01:00
Sonia Aguilar da1538ba82 Alerting: Update docs after moving action buttons im the alert list, and move t… (#81375)
Update docs after moving action buttons im the alert list, and move the loading spinner
2024-01-29 16:52:34 +01:00
Julien Duchesne 2e352ba4d6 Docs(alerting): Document the disable_provenance attribute (#81290)
We no longer need to pass a http header
2024-01-26 09:16:45 +01:00
Jean-Philippe Quéméner 25dd8d5ceb Docs: add section about periodic state saving for alerting (#81244) 2024-01-25 17:05:58 +01:00
brendamuir 85429f7bd0 Alerting docs: swap alert steps (#81249)
* Alerting docs: swap annotation and notification steps

* Updates data source managed rule steps
2024-01-25 12:02:35 +01:00
brendamuir 030a68bbf7 Alerting docs: recovery threshold (#81069)
* Alerting docs: recovery threshold

* ran prettier

* Adds note that only available in oss

* ran prettier
2024-01-25 10:28:32 +01:00
Damian Szczepanik 5576731332 Docs: Update variables-label-annotation.md (#81134)
Update variables-label-annotation.md

Additional closing bracket was removed
2024-01-24 12:36:50 +02:00
Matthew Jacobson 2607528b52 Alerting: Update legacy migration docs to include Upgrade Preview (#80628)
* Alerting: Update legacy migration docs to include Upgrade Preview
2024-01-23 14:09:52 -05:00
brendamuir f9486ad2ee Alerting docs: updates eval group and provisioning topics for support (#81066) 2024-01-23 14:24:12 +01:00
Nicki de Wet 084a3c6b7f Update notifications.md (#80868)
Added clarity about the order policies are evaluated
2024-01-19 16:15:15 +01:00
brendamuir d50abe2ea2 Alerting docs: changes wrong label on configure alert state history doc (#80438) 2024-01-12 15:16:59 +01:00
Johannes Ehm 642391c9f9 Alerting: adds execErrState to the alerting file provisioning example as it is missing (#79002) 2024-01-10 12:49:38 +01:00
Gilles De Mey d2b023076b Alerting: Add support for TTL for pushover for Mimir Alertmanager (#78687) 2024-01-08 15:48:36 +01:00
annelaurefroment f09353e094 Update _index.md (#79237)
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-12-27 09:21:55 +00:00
brendamuir 524debbe53 Docs: adds docs on aggregation functions for alerting (#78893)
* Docs: adds docs on aggregation functions for alerting

* ran prettier
2023-12-20 10:18:08 +01:00
Pangidoan Butar 6659ed8722 Special alerts for NoData and Error (#79193)
* Special alerts for NoData and Error

To avoid confusion why there is no additional label added when setting `Alerting` or `OK` in the No Data and Error handling

* ran prettier

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-12-12 15:54:33 +01:00
brendamuir 9bd20db49f Alerting docs: remaining descriptions and deletes legacy topics (#79387)
Alerting docs: remaining descriptions and deletes legacy cloud alerting topics
2023-12-12 15:08:28 +01:00
brendamuir 5f5ed3187c Alerting docs: revises descriptions for the manage notifications section (#79385) 2023-12-12 12:02:58 +01:00
brendamuir 4d375aa5d4 Alerting docs: Adds Alerting descriptions for fundamentals section (#79383)
Adds Alerting descriptions for fundamentals section
2023-12-12 11:26:36 +01:00
brendamuir f20e98fac4 Docs: Alerting descriptions for alerting-rules section (#79376)
Alerting descriptions for alerting-rules section
2023-12-12 11:05:20 +01:00
Gilles De Mey 58d0c51cf4 Alerting: Add note to the docs that GMA rules are evaluated concurrently (#78902) 2023-12-01 18:32:48 +01:00
Matthew Jacobson 5a80962de9 Alerting: Add clean_upgrade config and deprecate force_migration (#78324)
* Alerting: Add clean_upgrade config and deprecate force_migration

Upgrading to UA and rolling back will no longer delete any data by default. 
Instead, each set of tables will remain unchanged when switching between 
legacy and UA. As such, the force_migration config has been deprecated 
and no extra configuration is required to roll back to legacy anymore.

If clean_upgrade is set to true when upgrading from legacy alerting to Unified
Alerting, grafana will first delete all existing Unified Alerting resources,
thus re-upgrading all organizations from scratch. If false or unset,
organizations that have previously upgraded will not lose their existing Unified
 Alerting data when switching between legacy and Unified Alerting.

 Similar to force_migration, it should be kept false when not needed as it may
 cause unintended data-loss if left enabled.

---------

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-11-30 11:01:11 -05:00
brendamuir 1b2a621533 Docs: adds docs on excluding labels (#78806)
* Docs: adds docs on excluding labels

* run prettier

* Update docs/sources/alerting/fundamentals/annotation-label/labels-and-label-matchers.md

Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com>

* adds table for display

* ran prettier

---------

Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com>
2023-11-30 10:26:22 +01:00
brendamuir 808e76ca05 Docs: adds note on gma alert limits (#78737)
* Docs: adds not on gma alert limits

* prettier
2023-11-29 08:46:38 +01:00
brendamuir 5fc68312c5 Docs: adds info on location for mute timings (#78462)
* Docs: adds info on location for mute timings

* ran prettier

* Update docs/sources/alerting/manage-notifications/mute-timings.md

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>

* Update docs/sources/alerting/manage-notifications/mute-timings.md

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>

* Adds note on not being able to retrieve alerting resources once deleted

---------

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-11-27 14:30:41 +01:00
Isabel 72e8672203 docs: 404 fixes - what's new Alerting content (#78549)
* Updated links in what's new 10.2 and what's new next

* Attempted to add alias

* Fix alias

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2023-11-22 14:40:05 -05:00