Commit Graph

170 Commits

Author SHA1 Message Date
brendamuir 26a01c42a6
Alerting docs: adds settings feature (#88294)
* Alerting docs: adds settings feature

* ran prettier
2024-05-24 15:01:15 +02:00
brendamuir 01d5744433
Alerting docs: adds note on provisioning to main page (#88264) 2024-05-24 09:44:21 +02:00
Pepe Cano 33db776c91
Alerting docs: fixes missing `alt` attributes (#88235)
* Fix missing `alt` text in images

* Fix `canonical` setting in AlertManager docs

* Fix `.`(dot) position in hyperlinks due to a temporary styling issue

* Revert "Fix `canonical` setting in AlertManager docs"

This reverts commit 65354b3642.
2024-05-23 18:07:52 +02:00
Jack Baldry 410e3b17e9
[docs/sources/alerting] Replace docs/reference shortcode with ref URIs (#88079) 2024-05-21 15:43:21 +03:00
antonio f24eb3165b
alerting: adding links to get-started tutorial (#87811)
* alerting: adding links to get-started tutorial

* Update index.md

* Update create-grafana-managed-rule.md

* Update _index.md

* Update _index.md

* Update docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md

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

* Update docs/sources/alerting/fundamentals/_index.md

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

* pretty

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-05-15 08:57:12 +02:00
Fayzal Ghantiwala 7a2fbad0c8
Alerting: Add options to configure TLS for HA using Redis (#87567)
* Add Alerting HA Redis Client TLS configs

* Add test to ping miniredis with mTLS

* Update .ini files and docs

* Add tests for unified alerting ha redis TLS settings

* Fix malformed go.sum

* Add modowner

* Fix lint error

* Update docs and use dstls config
2024-05-14 14:21:42 +01:00
brendamuir 526be4fa2b
Alerting vale fixes (#87380) 2024-05-06 11:43:34 +02:00
brendamuir 7077a5850e
Alerting docs: more vale (#86978) 2024-04-27 09:59:42 +02:00
George Robinson 30d38c1775
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.
2024-04-22 11:13:02 +02:00
Lisa 65e6b67b2e
Embed creating alerts with Grafana video to the documentation (#86386) 2024-04-22 11:09:00 +02:00
brendamuir b311612cf2
Alerting docs: RBAC for enterprise and cloud (#86506)
* Alerting docs: RBAC for enterprise and cloud

* rbac structure

* ran prettier

* updates to data source permissions

* adds tables for roles

* ran prettier

* adds examples for custom role

* ran prettier

* updates table

* typo fix

* ran prettier
2024-04-18 20:32:04 +02:00
TechVest 1ffe858e06
chore: remove repetitive words (#86412)
Signed-off-by: TechVest <techdashen@qq.com>
2024-04-17 13:08:00 +01:00
brendamuir 0cb3e8bc49
Alerting docs: adds roles docs (#86261)
* Alerting docs: adds roles docs

* adds header

* adds link

* spacing

* prettier

* Update docs/sources/alerting/set-up/configure-roles/index.md

Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-roles/index.md

Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-roles/index.md

Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>

* Update docs/sources/alerting/set-up/configure-roles/index.md

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

* Update docs/sources/alerting/set-up/configure-roles/index.md

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

* Update docs/sources/alerting/set-up/configure-roles/index.md

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

* Update docs/sources/alerting/set-up/configure-roles/index.md

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

* Update docs/sources/alerting/set-up/configure-roles/index.md

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

* prettier

* Update docs/sources/alerting/set-up/configure-roles/index.md

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

* corrects link

---------

Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-04-16 14:33:15 +02:00
Pepe Cano 0672bdf397
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>
2024-04-08 17:34:26 +02:00
Pepe Cano d7ad7c6169
Alerting docs: update `disable_provenance` TF mute_timing (#85692) 2024-04-08 10:20:51 +02:00
Pepe Cano a56a842d5f
Alerting docs: fix `docs/shared` API to render the current version (#85526) 2024-04-03 16:04:58 +02:00
Yuri Tseretyan e138ae3eb9
Alerting: Improve openAPI specification and docs for export endpoints (#85008) 2024-03-22 18:25:27 +02:00
Pepe Cano ec42b2a361
Alerting docs: restructure `Introduction` (#84248)
* Rename `Data sources` title

* Relocate and rename `Introduction/Notification templates`

* Rename `alert-rules/alert-instances` to `alert-rules/multi-dimensional-alerts`

* Move `fundamentals/high-availability` to `setup/enable-ha`

* Fix 404 high-availability alerting link on Setup HA Grafana docs

* Move alert manager/contact poitns/notification templates within Notifications

* Remove `Alerting on numeric data`

* Restructure Introduction v2

* Continue Intro restructuring

* Update docs/sources/alerting/fundamentals/alert-rules/_index.md

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

* Complete contact point TODO

* Alias: alertManager

* Aliases `annotation-label` + content changes

* Aliases to `templating-labels-annotations`

* Aliases to `queries-conditions`

* Rename `rule-evaluation.md` file

* Aliases: `contact points`

* Aliases to `message-templating`

* Aliases to `alert-rules`

* Update links to new URL slugs

* Remove duplicated alias

* Remove trailing slash for external heading links

* Remove trailing slash in heading links to other grafana pages

* Change URL directory slug `fundamentals/notifications`

* rename title `Configure High Availability`

* Content changes

* Update docs/sources/alerting/fundamentals/alert-rules/_index.md

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

* Update docs/sources/alerting/set-up/configure-alert-state-history/index.md

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

* Update docs/sources/alerting/set-up/configure-high-availability/_index.md

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

* Update docs/sources/alerting/set-up/configure-alert-state-history/index.md

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

* Update docs/sources/alerting/set-up/configure-high-availability/_index.md

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

* Update docs/sources/alerting/set-up/configure-high-availability/_index.md

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

* Update docs/sources/alerting/set-up/configure-high-availability/_index.md

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

* Update docs/sources/alerting/fundamentals/alert-rules/_index.md

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

* Fix broken link reference

* Fix `queries-and-conditions`

* Fix `alert-rule-evaluation` ref link

* Fix aliases + inline doc comments

* Fix broken link

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-03-14 16:58:18 +01:00
Pepe Cano e1d9aa5a7b
Alerting docs: document HTTP API to create templates (#84055) 2024-03-14 09:01:13 +01:00
Armand Grillet e33e219a9a
Remove legacy alerting docs (#84190) 2024-03-12 05:37:41 +01:00
Pepe Cano dbb55f291a
Alerting docs: update the supported export template functionality (#83816) 2024-03-07 08:42:38 +01:00
Pepe Cano 2653bd8fab
Alerting docs: update file provisioning guide (#83924) 2024-03-06 09:18:59 +01:00
Pepe Cano 019c9618f0
Alerting docs: improve visibility on the distinct options to edit provisioned resources (#83839)
Alerting docs: specify the distinct options to edit provisioned resources
2024-03-05 10:48:04 +01:00
Pepe Cano 111df1bba0
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>
2024-03-04 12:10:37 +01:00
Pepe Cano 244589d7ea
Alerting docs: document `mute-timings` export endpoints (#83797) 2024-03-04 10:50:44 +01:00
Pepe Cano 9eb69b9213
Alerting docs: fix incorrect `docs/reference` link (#83809) 2024-03-04 10:20:10 +01:00
Pepe Cano 88f010a72a
Alerting docs: remove admonition/notes related to old Grafana versions (#83669) 2024-02-29 12:55:52 +01:00
omahs 2a429cd7db
Fix typos (#83621)
Co-authored-by: Isabel Matwawana <isabel.matwawana@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-02-29 10:47:22 +00:00
Pepe Cano eb25b669c6
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>
2024-02-27 16:22:24 +01:00
Kristina e564024883
Docs: change discussion link to issue link (#83434)
* change discussion link to issue link

* run prettier
2024-02-27 08:14:54 -06:00
Pepe Cano 9c42826c30
Alerting docs: fix broken link and apply the Writer toolkit guideline to other links (#83209)
* Fix `/docs/reference` cannot be used within admonitions

* Remove `relref` links to apply Writers toolkit guidelines
2024-02-22 11:31:59 +01:00
brendamuir 4720c99bd5
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>
2024-02-21 10:41:12 +01:00
Pepe Cano b6098f2dde
Alerting docs: clean up Cloud links (#83073)
* Use fixed `/docs/grafana-cloud/alerting-and-irm` URLs for cloud references

* Fix `docs/grafana-cloud/` data sources links

* Fix `docs/grafana-cloud/` Panel & Visualization links

* Fix `/docs/grafana-cloud/` link to Dashboard page

* Set root directory `docs/reference` for non-cloud pages

* Fix `admonition` cannot use a  `docs/reference` relative link

* Update `doc-validator`

https://github.com/grafana/technical-documentation/releases/tag/doc-validator%2Fv4.1.0

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>
2024-02-20 11:49:39 +01: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
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
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
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
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 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
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 0e3c39c0e6
Docs: adds alerting provisioning updates (#78454)
* Docs: adds alerting provisioning updates

* prettier and changed passives
2023-11-21 13:55:39 +01:00
Arkadip Bhattacharya b3bf38ad68
fix: ha_peer to ha_peers (#75724) 2023-11-20 14:27:00 +01:00
littlelionking 577b3f2fb2
Docs: Reduce `location` indentation to match time_interval_spec (#77291)
Reduce location indentation to match time_interval_spec

https://prometheus.io/docs/alerting/latest/configuration/#time_interval_spec

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-11-03 11:44:59 +01:00
George Robinson ba384d29f6
Alerting: Fix order of the Alerting docs (#77084) 2023-10-24 19:31:03 +01:00
Marin N 150d4d68ad
Update _index.md (#75359)
* Update _index.md

* Update _index.md

Run through Prettier

* Update _index.md

ran Prettier again

* Prettier

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-10-07 12:47:03 +02:00
Jack Baldry 4432c4c75c
Fix developer links and newly discovered spelling errors (#75875)
* Fix developer links

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

* Fix newly discovered spelling errors

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-10-03 13:49:27 +01:00
brendamuir 23a873b33f
Alerting docs: fixes next and latest link errors (#75437)
* Alerting docs: fixes next and latest link errors

* fixes bracket

* more link fixes

* fixes numbering

* prettier

* Fix build errors, a broken link, and use more appropriate destination for Grafana Cloud OnCall links

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

* fixes for jacks feedback

* fixes note

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2023-09-26 16:15:32 +02:00
Jack Baldry 3ab31c345e
Fix migrating alerts aliases (#74898)
* Add comments to indicate which page I believe each alias is intending to redirect

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

* Remove difference-old-new redirect from migrating-alerts page since an alternative page exists

The alternative page is `docs/sources/alerting/difference-old-new.md`.

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

* Add comment to show intended absolute path redirect

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

* Remove `unified-alerting/difference-old-new/` redirect because it already exists in `docs/sources/alerting/difference-old-new.md`.

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

* Remove `unified-alerting/` alias since the absolute URL already redirects to `/docs/grafana/latest/alerting/`

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

* Fix `/docs/grafana/<GRAFANA VERSION>/alerting/migrating-alerts/` redirect

The following example uses `latest` as _`GRAFANA VERSION`_ for simplicity and readability.

The desire is the following redirect:

```
src: /docs/grafana/latest/alerting/migrating-alerts/
dst: /docs/grafana/latest/alerting/set-up/migrating-alerts/
```

`dst` is the Hugo pretty URL for the current page (`docs/sources/alerting/set-up/migrating-alerts/_index.md`).

When constructing Hugo aliases we are working from the page's containing directory and not the page itself.
The path element `.` represents that directory.
For example:

```
 page: /docs/grafana/latest/alerting/set-up/migrating-alerts/
alias: ./
  dst: /docs/grafana/latest/alerting/set-up/
```

The path element `..` represents the parent directory of the page's containing directory.
For example:

```
 page: /docs/grafana/latest/alerting/set-up/migrating-alerts/
alias: ../
  dst: /docs/grafana/latest/alerting/
```

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-09-26 11:29:29 +01:00
brendamuir c999979bc5
Alerting docs: removes cloud link (#75142)
* Alerting docs: removes cloud link

* removes link sentence
2023-09-20 12:17:54 +02:00
Jack Baldry ac314855eb
Remove set-up-cloud page as it has been moved to the website repository (#74755)
* Page has been moved to the website repository

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

* Update .codespellignore to ignore 'Operator Windrose' and fix typo

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-09-13 00:37:48 +03:00
Yuri Tseretyan 99fd7b8141
Alerting: Update provisioning to validate user-defined UID on create (#73793)
* add ValidateUID to util
* provisioning to validate UID on rule creation

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Alexander Weaver <weaver.alex.d@gmail.com>
2023-09-08 15:09:35 -04:00
brendamuir b22cfcd336
Docs alerting: meta monitoring topics (#74440)
* Docs alerting: adds insights logs and updates metamonitoring topic

* updates meta monitoring

* Update docs/sources/alerting/monitor/_index.md

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

* Update docs/sources/alerting/monitor/meta-monitoring/_index.md

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

* removes alias

* Update docs/sources/alerting/monitor/meta-monitoring/_index.md

Co-authored-by: Jennifer Villa <jvilla2013@gmail.com>

* Update docs/sources/alerting/monitor/meta-monitoring/_index.md

Co-authored-by: Jennifer Villa <jvilla2013@gmail.com>

* Update docs/sources/alerting/monitor/meta-monitoring/_index.md

Co-authored-by: Jennifer Villa <jvilla2013@gmail.com>

* Update docs/sources/alerting/monitor/meta-monitoring/_index.md

Co-authored-by: Jennifer Villa <jvilla2013@gmail.com>

* updates numbering

* adds codeblock

* updates

* Update docs/sources/alerting/monitor/meta-monitoring/_index.md

Co-authored-by: George Robinson <george.robinson@grafana.com>

* Update docs/sources/alerting/monitor/meta-monitoring/_index.md

Co-authored-by: George Robinson <george.robinson@grafana.com>

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jennifer Villa <jvilla2013@gmail.com>
Co-authored-by: George Robinson <george.robinson@grafana.com>
2023-09-07 15:08:11 +02:00
George Robinson 439270f6cb
Rename Google Hangouts to Google Chat (#74162)
* Rename Google Hangouts to Google Chat

* Fix prettier
2023-08-31 16:09:22 +03:00
brendamuir 356d8872bd
Alerting docs: fix duplicate titles (#73680)
* Alerting docs: fix duplicate titles

* makes titles match
2023-08-23 14:34:54 +02:00
Jean-Philippe Quéméner 44b94eca19
docs(alerting): add section about running redis for HA (#73153) 2023-08-11 13:57:00 +02:00
arunkg2787 cda78c6fe8
Update _index.md (#72562)
Fixes # https://github.com/grafana/support-escalations/issues/6887

Configure HA: Added ha_peer_Timeout global config in the unified alerting
2023-08-09 17:53:57 +02:00
Matthew Jacobson cfb1656968
Alerting: Add notification policy provisioning file export (#70009)
* Alerting: Add notification policy provisioning file export

- Add provisioning API endpoint for exporting notification policies.
- Add option in notification policy view ellipsis dropdown for exporting.
- Update various provisioning documentation.
2023-07-24 17:56:53 -04:00
Matthew Jacobson 13121d3234
Alerting: Add contact point provisioning file export (#71692)
* Add contact point provisioning file export apis

* Regenerate api

* docs

* frontend

* add mock to tests

* Fix missing row-level export button on viewer role w/ prov. read

* Address review comments

---------

Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com>
2023-07-20 14:35:56 -04:00
Jack Baldry 37ef4e940f
Add canonical URLs to all alerting pages (#71830)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-07-18 11:29:00 +01:00
Jack Baldry 7eb17bccca
Explicitly set all front matter labels in the source files (#71548)
* Set every page to have defaults of 'Enterprise' and 'Open source' labels

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

* Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels

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

* Set administration/enterprise-licensing pages to have 'Enterprise' labels

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

* Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels

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

* Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels

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

* Set administration/recorded-queries pages to have labels cloud,enterprise

* Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise

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

* Set administration/stats-and-license pages to have labels cloud,enterprise

* Set alerting pages to have labels cloud,enterprise,oss

* Set breaking-changes pages to have labels cloud,enterprise,oss

* Set dashboards pages to have labels cloud,enterprise,oss

* Set datasources pages to have labels cloud,enterprise,oss

* Set explore pages to have labels cloud,enterprise,oss

* Set fundamentals pages to have labels cloud,enterprise,oss

* Set introduction/grafana-cloud pages to have labels cloud

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

* Fix introduction pages products

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

* Set panels-visualizations pages to have labels cloud,enterprise,oss

* Set release-notes pages to have labels cloud,enterprise,oss

* Set search pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise

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

* Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss

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

* Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise

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

* Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise

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

* Set troubleshooting pages to have labels cloud,enterprise,oss

* Set whatsnew pages to have labels cloud,enterprise,oss

* Apply updated labels from review

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-18 09:10:12 +01:00
Alexander Weaver 128990dbb7
Docs: Consolidation and add call-outs for semantics in Alert Provisioning documentation (#68848)
* Provisioning landing page

* Move editing bit to view page

* Specify API vs File, and provide terraform example

* Improvements around notif policies

* Docs around contact points

* Use h2 instead of h1

* Address feedback

* Move text about policy granularity
2023-07-17 11:15:51 -05:00
Matthew Jacobson 8c6cdf51fc
Alerting: No longer silence paused alerts during legacy migration (#71596)
* Alerting: No longer silence paused alerts during legacy migration

Now that we migrate paused legacy alerts to paused UA alert rules, we no longer need to silence them.
2023-07-17 09:37:53 -04:00
Jack Baldry 01f6b8e90c
Use docs/reference style links for all Alerting links (#71124)
* Replace all alerting links with docs/reference style links

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

* Fix broken docs/reference style link

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

* Update all alerting links to go to Grafana Cloud resources when the page is published in Grafana Cloud

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

* Prettier

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

* Replace another link

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-07-10 11:51:29 +01:00
Armand Grillet 3ec0558204
Clarify external AM limitation (#71179) 2023-07-07 17:13:11 +02:00
Gilles De Mey 536146de5f
Docs: Adding the right syntax highlighting in a few places (#71141)
Adding the right syntax highlighting in a few places
2023-07-07 09:15:39 +02:00
Gilles De Mey 6af12b1953
Docs: Set up alert state history (#71123)
Co-authored-by: Armand Grillet <2117580+armandgrillet@users.noreply.github.com>
2023-07-06 17:03:32 +02:00
Matthew Jacobson 00d5f7fed7
Alerting: Convert 'Both' type Prometheus queries to 'Range' in migration (#70781)
* Alerting: Convert 'Both' type Prometheus queries to 'Range' in migration
2023-06-28 14:02:57 -04:00
brendamuir 5159317ee7
Docs: adds evaluation doc (#70757)
* Docs: adds evaluation doc

* Adds note on classic condition

* fixes link

* fixes link

* fixes link

* fixes data source

* link fix

* fixes rbac link

* adds aliases
2023-06-28 10:38:59 +02:00
Andreas Deininger 95b1f3c875
Fixing typos (#70487) 2023-06-22 09:43:38 +01:00
brendamuir d8ffc6be5e
Docs: fixes minor errors (#70458)
* Docs: fixes minor errors

* adds links

* remove trailing slash

---------

Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
2023-06-21 11:53:24 -05:00
brendamuir cd8e5dc140
Docs: rearrange content order (#70425)
* Docs: rearrange content order

* more rearranging

* fixes relrefs

* fixes links
2023-06-21 11:30:52 +02:00
brendamuir 701c6b6f07
Docs: fixes various links (#70384)
* Docs: fixes various links

* bit more moving

* corrects link

* fixes links

* fixes links from move

* fix links

* fix links

* fixes links

* fixes links

* fix typo

* fixes typo

* fix notif policy link

* fix link
2023-06-20 21:49:57 +02:00
brendamuir d529636bc3
Docs: bit of restructuring (#70364)
* Docs: bit of restructuring

* corrects link

* fixes link

* updates

* fixes links

* fixes links

* fixes links

* fixes links

* fixes links
2023-06-20 11:43:12 +02:00
brendamuir 5fc6bf5c69
Docs: recreates setup for oss alerting (#70156)
* recreates setup for oss alerting

* fixes relrefs

* fix relrefs

* fix relref

* adds other setup topics

* adds other setup topics 2

* adds other setup topics 3

* adds cloud setup

* adds cloud setup from legacy

* fixes links

* removing link

* gilles feedback
2023-06-16 12:15:55 +02:00
Gabriel Goller d850070f09
Docs: Added disableResolveMessage parameter (#66596)
Added disableResolveMessage parameter
2023-06-02 14:28:39 +02:00
gotjosh bf4ab36bc0
docs: revamp the alerting set-up documentation (#69064)
* docs: revamp the alerting set-up documentation

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

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

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

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

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

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

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-05-26 08:55:23 +02:00
Gilles De Mey 721d51a497
Alerting: Adds support for timezones in mute timings (#68813) 2023-05-25 16:19:33 +02:00
Jack Baldry 6c4cf4f8b9
Enable doc-validator for alerting directories (#68964)
* Enable doc-validator for alerting directories

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

* Adds missing description frontmatter

* Fix some more links

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

* Fix some more links

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

* Fixes anchors

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-05-24 14:12:30 +01:00
bojankezele 5145f4d3f1
Update index.md (#67979)
removing an extra ':'
2023-05-10 11:53:38 +02:00
brendamuir 8e51c4895d
Docs: Fix routes in provisioning (#67970)
* Fix routes in provisioning

* fixes spacing
2023-05-09 08:53:12 +02:00
Alex Moreno f64a89727e
Alerting: Allow provenance disable in alerting provisioning API (#63650)
* Allow provenance None in alert rule update and rule group replace

* Allow provenance None in contact point update

* Allow updating policies to none by sending x-disable-provenance header

* Allow mute timings to disable provenance with x-disable-provenance header

* Allow disabling provenance by using x-disable-provenance header

* Add provenance helper to lower the cyclomatic complexity

* Do not downgrade provenance except un ReplaceRuleGroup

* Add function explanation and change error handling

* Add docs for x-disable-provenance changes (#66300)

* Add docs for x-disable-provenance changes

* Apply suggestions from code review

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

* Update _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: George Robinson <george.robinson@grafana.com>

* Add error message check in tests

* Change docs

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: George Robinson <george.robinson@grafana.com>
2023-04-18 15:10:36 +02:00
Isabel a5c5db3e91
docs: nav updates for alerting (#65300)
* navigation related updates - text only

* navigation related updates

* navigation related text updates

* navigation related text updates

* navigation related text and image updates
2023-03-23 13:26:16 -07:00
annelaurefroment 7b7e417629
Updating documentation on alerting HA (#65064) 2023-03-23 11:34:38 +00:00
brendamuir 89c65e22d3
Docs: fix numbering and rename topic (#65093)
* Docs: fix numbering and rename topic

* fixes typo

* removes full stops

* deletes :
2023-03-21 13:37:00 +01:00
ismail simsek 91221bc436
Expressions: Fixes the issue showing expressions editor (#62510)
* Use suggested value for uid

* update the snapshot

* use __expr__

* replace all -100 with __expr__

* update snapshot

* more changes

* revert redundant change

* Use expr.DatasourceUID where it's possible

* generate files
2023-01-31 18:50:10 +01:00
Andre Miras a7c4872bcd
Alerting: Clarify PagerDuty integrationKey format (#62463)
**What is this feature?**

Simply a documentation update.

**Why do we need this feature?**

Clarify the doc, so people don't waste time integrating the wrong key,
e.g. #8979, #9036, https://community.librenms.org/t/19013

**Who is this feature for?**

Developers doing a PagerDuty integration.
2023-01-30 18:23:33 +00:00
Matthew Jacobson c006df375a
Alerting: Create endpoints for exporting in provisioning file format (#58623)
This adds provisioning endpoints for downloading alert rules and alert rule groups in a 
format that is compatible with file provisioning. Each endpoint supports both json and 
yaml response types via Accept header as well as a query parameter 
download=true/false that will set Content-Disposition to recommend initiating a download 
or inline display.

This also makes some package changes to keep structs with potential to drift closer 
together. Eventually, other alerting file structs should also move into this new file 
package, but the rest require some refactoring that is out of scope for this PR.
2023-01-27 11:39:16 -05:00
Armand Grillet 95f052bbd1
Add handleGrafanaManagedAlerts jsonData (#61874)
* Add handleGrafanaManagedAlerts jsonData

* Update following feedback
2023-01-26 10:48:51 +01:00
Armand Grillet a960b55a99
Update link to provisioning docs (#61840)
Update links to provisioning docs
2023-01-20 12:55:27 +01:00
George Robinson d4256b352d
Docs: Rename Message templates to Notification templates (#59477)
This commit renames "Message templates" to "Notification templates"
in the user interface as it suggests that these templates cannot
be used to template anything other than the message. However, message
templates are much more general and can be used to template other fields
too such as the subject of an email, or the title of a Slack message.
2023-01-18 17:26:34 +00:00