Commit Graph

292 Commits

Author SHA1 Message Date
Joe Blubaugh
8ad1f4f9be
Add a section to the alerting documents for performance considerations (#49663)
This change adds documentation about how the configuration of Grafana
Alerting affects the performance of the Grafana backend, and how to
control the load that Grafana Alerting generates.

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2022-06-02 20:55:45 +08:00
JitaC
1970c9020a
Docs: Update create alerting rules topics (#49764)
* Updated topic on Grafana managed rule.

* Updated loki and mimir rules and recording rules topics

* Checkin changes.

* Fixed typo
2022-05-27 22:29:59 -04:00
JitaC
f5a3ac855d
Docs: Refactor contact points section of alerting docs (#49758)
* Initial commit

* weight adjustments

* Checkin changes.
2022-05-27 13:37:37 -04:00
Christopher Moyer
8c84d62e3d
Docs: combines all SAML topics into one topic (#49443)
* combines all SAML topics

* resolves merge conflicts

* makes prettier
2022-05-27 07:42:51 -05:00
Jack Baldry
b84294dd27
Convert TOML front matter to YAML (#49690)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-05-26 11:06:25 -04:00
JitaC
a968a43e0c
Docs: Move alert rule section to alerting fundamentals section (#49657)
* initial commit

* Added links to alert rules, and fixes one broken alerting relref.
2022-05-25 18:53:05 -04:00
JitaC
b5d48d217a
Docs: Created separate section for migration under alerting (#49616)
* Lots of changes, including new topic, also fixed all alerting relrefs

* Push stashed change.

* Updated content to reflect that Grafana alerting is enabled during upgrade.

* Fix typo

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

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

* Checkin changes.

* Updates from Chris's review.

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2022-05-25 17:50:20 -04:00
Gilles De Mey
9fdbc60ce9
Docs: Add "about alerting" topic (#49523) 2022-05-24 22:17:29 -04:00
Gilles De Mey
438898de86
Alerting: add "about alert rules" section (#49413)
* Alerting: add "about alert rules" section

* chore: adds descriptions and keywords

* Docs: update image locations

* chore: fix typo
2022-05-24 16:04:25 -04:00
Gilles De Mey
1c0019285f
Alerting: Improve docs on alert state and health (#49410) 2022-05-24 17:31:57 +02:00
Christopher Moyer
7d0986fda5
updated alerts to alerting (#49446) 2022-05-23 16:05:40 -05:00
Karl Persson
0cbe4fe661
Docs: RBAC GA (#49062) 2022-05-20 21:48:52 +02:00
JitaC
6397b34f8b
Docs: Move labels and annotations topic to alerting fundamentals section (#49283)
* Moved annotation and labels topic to fundamentals and added label matching to the same section

* Cosmetic updates to "How label matching works topic"

* Few more changes to annotations and label section. Also added stem sentence to silences topics.

* Fixed one more broken relref.

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

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

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2022-05-19 19:17:57 -04:00
JitaC
639e548e32
Docs: Refactored alert groups and silences sections (#48833)
* Initial breakdown of silences topic

* Re-organized silences

* Refactored alert groups, fixed broken relrefs and adjusted weights.
2022-05-19 13:57:53 -04:00
Gilles De Mey
e574870104
Docs: pull labels and label matchers in to its own fundamentals article (#48758) 2022-05-17 17:31:39 +02:00
Jack Baldry
51dfcd7d37
Add current alias to all files (#48635)
* Add aliases to all files

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

* Prettify front matter

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-05-17 08:24:11 -07:00
JitaC
e16dc72c94
Docs:Cleanup alerting docs (#48826)
* Remove What's new reference.

* Moved messaging templates to under contact points. fixed broken relrefs.

* Fixed some more reflrefs

* Fixed a few more broken relrefs and adjusted weight
2022-05-06 13:52:30 -04:00
JitaC
5bc91187f1
Hide what's new topic (#48704) 2022-05-04 10:16:00 -04:00
achatterjee-grafana
082cfbdb06
Docs: Refactor alerting documentation (part 1) (#48664)
* Initial commit

* Moved files, ad fixed broken relrefs.

* Fixed other broken relrefs

* More changes.

* Fixing broken relrefs

* More changes.

* Fixed last of the broken links

* More re-org.

* Added aliases and some weight adjustments

* More aliases.

* Fix fundamentals topic.

* Fixed remaining metadata issues

* Ran prettier
2022-05-04 08:22:11 -04:00
achatterjee-grafana
815fc42da3
add alias to fix 404 error (#48599) 2022-05-02 15:58:35 -04:00
achatterjee-grafana
7048bf9f0d
added aliases (#48461) 2022-04-28 15:25:09 -04:00
Santiago
9237729c19
Make clear that the two example templates must be used together (#48305)
* make clear that the two templates work in conjunction

* PR review changes

* Update docs/sources/alerting/unified-alerting/message-templating/_index.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* Update docs/sources/alerting/unified-alerting/message-templating/_index.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* make numbered steps

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2022-04-27 11:43:45 -04:00
achatterjee-grafana
7311c9757a
Docs: Break down alerting HA topics (#48143)
* Initial commit

* Added some refinement to the alerting HA topics.

* Update docs/sources/administration/set-up-for-high-availability.md

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

* Updates from Chris's review. Also fixed a couple of broken relrefs

* Ran prettier

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2022-04-25 15:53:09 -04:00
Yuriy Tseretyan
c1ec122f75
Alerting: Update RBAC documentation with information about alerting (#47858)
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2022-04-20 11:35:57 -04:00
Santiago
694a7e73dc
notification template docs updated (#47744) 2022-04-13 16:47:53 -04:00
Santiago
5fb80498b1
Apply templating on alert notifications on OK state (#47355)
* OK notifications using previous evaluation data

* copy rule.EvalMatches to avoid changes to the underlying array

* test cases added/modified

* delete trailing newline

* fix double newline in go import

* add change to the changelog

* specify that this only affects legacy alerting (changelog)

* use current eval data instead of prev eval data

* create evalMatch just once

* code comments, renamings, getTemplateMatches() function

* changelog and docs updated
2022-04-13 17:04:10 -03:00
achatterjee-grafana
668df49801
renamed file names, by replacing cortex with mimir (#47340) 2022-04-05 12:07:58 -04:00
achatterjee-grafana
c1c78bbc32
replaced references to Cortex with Mimir (#47293)
* replaced references to Cortex with Mimir

* Updated some links to Cortex documentation.

* Update docs/sources/alerting/_index.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/_index.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-recording-rule.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-recording-rule.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-recording-rule.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-rule.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-rule.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-rule.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/edit-cortex-loki-namespace-group.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/edit-cortex-loki-namespace-group.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/rule-list.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/datasources/prometheus.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-recording-rule.md

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

* Update docs/sources/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-recording-rule.md

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

* Update docs/sources/alerting/unified-alerting/_index.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/_index.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-recording-rule.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/difference-old-new.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/datasources/alertmanager.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/fundamentals/alertmanager.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-rule.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-rule.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-rule.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-rule.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/edit-cortex-loki-namespace-group.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/edit-cortex-loki-namespace-group.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/edit-cortex-loki-namespace-group.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/edit-cortex-loki-namespace-group.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/rule-list.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/difference-old-new.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-rule.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

* Update docs/sources/alerting/unified-alerting/alerting-rules/edit-cortex-loki-namespace-group.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2022-04-05 10:22:43 -04:00
George Robinson
79769132c0
Alerting: Alert rule should wait For duration when execution error state is Alerting (#47052)
Alerting: Alert rule should wait For duration when execution error state is Alerting
2022-03-31 09:57:58 +01:00
achatterjee-grafana
d3b2ffed35
replaced ascii image with png image (#47032) 2022-03-30 09:15:07 -04:00
gotjosh
84e5f336fe
Alerting: Classic conditions can now display multiple values (#46971)
* Alerting: Extract classic condition values by RefID

* uncapitalise function

* update documentation

* Update pkg/services/ngalert/eval/extract_md.go

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

* Update pkg/services/ngalert/state/state.go

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

* Update pkg/services/ngalert/state/state.go

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

* Update pkg/services/ngalert/eval/extract_md.go

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

* Update docs/sources/alerting/unified-alerting/alerting-rules/alert-annotation-label.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* Update pkg/services/ngalert/eval/extract_md.go

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* Run prettier

Co-authored-by: George Robinson <george.robinson@grafana.com>
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2022-03-29 20:33:03 +01:00
Atrbear
8025997982
Update contact-points.md (#46657)
As you see. "orgId": 1 is duplicated.
2022-03-16 16:44:40 -04:00
Jens Oliver Meiert
c649b54ed2
docs: make case consistent (#46436)
(Other headings use sentence case)
2022-03-11 22:03:45 +01:00
Armand Grillet
cd3fb8e832
Document available Alerting annotations (#46081)
* Document available Alerting annotations

* Update docs/sources/alerting/unified-alerting/alerting-rules/alert-annotation-label.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2022-03-02 12:53:24 -05:00
achatterjee-grafana
77dddf43bc
Docs update default.ini file description (#46036)
* remove confusing wording

* fixed broken alerting links
2022-03-01 10:30:46 -05:00
juschm
34ae28846e
Update mute-timings.md (#45679)
cleaned up feature description (there were some leftovers from when the text was last edited)
2022-02-21 12:11:56 -05:00
Armand Grillet
8c6a5f043a
[docs] Clarify legacy alerting deprecation (#44759)
* Clarify legacy alerting deprecation

* Lint Markdown
2022-02-03 09:59:02 +01:00
achatterjee-grafana
d584a27055
Docs: Added information about Prometheus write permission requirement. (#44616)
* Added note.

* Fixed typo.
2022-01-28 19:35:50 -05:00
Christopher Moyer
449c608ef1
Docs/panel refactor (#43569)
* new refactored panel docs

* fixed links

* removed xtra sharing link, added links to panel display option tasks

* fixed typo

* add aliases

* incorporate PM feedback

* intermediate commit to resolve merge conflict

* final changes to resolve merge conflicts
2022-01-18 15:06:27 -06:00
Alexander Weaver
59bda131ec
Alerting: [Docs] Clarifications regarding what's supported in alerting message templates (#43544)
* Clarify docs for alerting templates

* Fix template cross-reference

* Add a single missing delimiter

* Update docs/sources/alerting/unified-alerting/message-templating/_index.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* Update docs/sources/alerting/unified-alerting/message-templating/_index.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* Update docs/sources/alerting/unified-alerting/message-templating/_index.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* Update docs/sources/alerting/unified-alerting/message-templating/_index.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* Address various points of docs feedback

* Update docs/sources/alerting/unified-alerting/message-templating/_index.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* Update docs/sources/alerting/unified-alerting/message-templating/_index.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* Update docs/sources/alerting/unified-alerting/message-templating/_index.md

Co-authored-by: Yuriy Tseretyan <tceretian@gmail.com>

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
Co-authored-by: Yuriy Tseretyan <tceretian@gmail.com>
2022-01-11 14:16:04 -06:00
Andreas Fitzek
58408f31ab
Fix typo in contact-points documentation (#43883)
Fixes a typo in contact-points documentation, `mesasges` => `messages`
2022-01-11 09:33:37 -05:00
Nathan Rodman
825edddfb6
Alerting: UI for mute timings (#41578)
* wip: add form inputs for creating mute timing

* form for mute timings

* add action for submitting config

* fix bug in payload

* add table for viewing mute timings

* remove mute timing from routes when deleted

* attach mute timing to route

* edit a mute timing

* use field array for multiple intervals

* Add confirmation modal for deleting mute timing

* add default values to form inputs

* fetch am config prior to renderring form

* validation for mute timing fields

* fix tests

* tests for mute timing form

* small ui fixes for the form and table

* pass mute name as query param

* make time fields inline

* fix validation for an existing alert and overwrite on edit

* rename mute timing in routes on edit

* fix validation for time inputs

* make time interval its own component

* add descriptions for mute timings

* refactor time interval parsing functions

* fix linting and tests

* refactor makeAmLink

* docs for mute timings

* reorganize docs and add intro for mute timings

* doc review edits

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* run prettier

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2022-01-05 10:16:43 -08:00
achatterjee-grafana
a9ad7d3c03
Add note for Cloud users. (#43689) 2022-01-04 17:20:42 -05:00
Torkel Ödegaard
b1643f536c
Docs: Fix formatting of markdown file (#43642) 2022-01-04 09:51:13 +01:00
achatterjee-grafana
88bc47441f
added note that notifications no longer include images. (#43635) 2022-01-03 17:57:38 -05:00
David Parrott
8206802f19
Rework template docs and add examples (#43178) 2021-12-15 15:00:12 -08:00
smallpath
aec14cba42
Alerting: Support WeCom as a contact point type (#40975)
* add wecom notifier

* fix backend lint

* fix alerting channel test

* update wecom doc

* update notifiers

* update wecom notifier test

* Apply suggestions from code review

Co-authored-by: gotjosh <josue.abreu@gmail.com>

* unify wecom alerting

* fix backend lint

* fix front lint

* fix wecom test

* update docs

* Update pkg/services/ngalert/notifier/channels/wecom.go

Co-authored-by: gotjosh <josue.abreu@gmail.com>

* Update docs/sources/alerting/old-alerting/notifications.md

Co-authored-by: gotjosh <josue.abreu@gmail.com>

* Update docs/sources/alerting/old-alerting/notifications.md

Co-authored-by: gotjosh <josue.abreu@gmail.com>

* Update docs/sources/alerting/old-alerting/notifications.md

Co-authored-by: gotjosh <josue.abreu@gmail.com>

* remove old wecom notifier

* remove old notifier doc

* fix backend test

* Update docs/sources/alerting/unified-alerting/contact-points.md

Co-authored-by: gotjosh <josue.abreu@gmail.com>

* fix doc style

Co-authored-by: gotjosh <josue.abreu@gmail.com>
2021-12-15 16:42:03 +00:00
achatterjee-grafana
d2073580be
fixed image links, also two broken relfrefs for alerting. (#42954) 2021-12-09 15:46:38 -05:00
Jean-Philippe Quéméner
e70cdb3f49
Alerting: add documentation about alertmanager contactpoint support (#42799) 2021-12-07 09:04:47 +01:00
gotjosh
67461086de
Docs: Dedicated section for Grouping in Alerting (#42641)
* Docs: Dedicated section for Grouping in Alerting

* Update docs/sources/alerting/unified-alerting/notification-policies.md

Co-authored-by: Armand Grillet <2117580+armandgrillet@users.noreply.github.com>

* Update docs/sources/alerting/unified-alerting/notification-policies.md

Co-authored-by: Armand Grillet <2117580+armandgrillet@users.noreply.github.com>

* Update docs/sources/alerting/unified-alerting/notification-policies.md

Co-authored-by: Armand Grillet <2117580+armandgrillet@users.noreply.github.com>

* Update docs/sources/alerting/unified-alerting/notification-policies.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* Update docs/sources/alerting/unified-alerting/notification-policies.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* Review suggestions

Co-authored-by: Armand Grillet <2117580+armandgrillet@users.noreply.github.com>
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2021-12-02 15:51:49 +00:00