Commit Graph

124 Commits

Author SHA1 Message Date
brendamuir
bb41ff267b
Alerting docs: updates to default and advanced options (#93999)
* Alerting docs: updates to default and advanced options

* feedback sonia
2024-09-30 16:41:44 +02:00
Pepe Cano
405887eebf
Alerting Docs: Update the introduction to Templates (#93935)
* Intro/Templates: update Intro and Template annotations sections

* Template labels section + adjustements

* Template notifications

* Use diagram for `meta_image`
2024-09-30 11:31:18 +02:00
brendamuir
ff5e6da358
Alerting docs: adds simple mode for query section (#93909)
* Alerting docs: adds simple mode for query section

* prettier and add steps section

* delete space

* feedback from sonia

* prettier
2024-09-27 16:22:34 +02:00
brendamuir
bb923db279
Alerting docs: improve alert rule definitions (#93321)
* Alerting docs: improve alert rule definitions

* more edits

* corrects numbering
2024-09-13 17:29:48 +02:00
brendamuir
85fbc8e8e5
Alerting docs: some edits to recording rules (#93260)
* Alerting docs: some edits to recording rules

* ran prettier

* removes refs

* fixes link

* fixing links

* corrects typo

* removes type step

* corrects typo
2024-09-12 14:00:12 +00:00
brendamuir
98f766a50d
Alerting docs: adds recording rule info (#93204)
* Alerting docs: adds recording rule info

* ran prettier

* Updates with feedback from pepe and removes external reference

* couple of minor edits

* removes reference

* feedback from sonia

* adds links per gilles

* adds correct version link
2024-09-12 12:06:23 +02:00
brendamuir
4749064f57
Alerting docs: responds to feedback on alerting state or error alerts (#92859)
* Alerting docs: responds to feedback on alerting state or error alerts

* ran prettier
2024-09-04 08:10:55 +02:00
Alexander Akhmetov
1df622641c
Alerting: Update documentation about alert instance limit (#92668) 2024-09-03 11:02:20 +02:00
brendamuir
02c820382d
Alerting docs: separates doc on create alerts from panels (#92131)
* Alerting docs: separates doc on create alerts from panels

* deletes previous panel section

* adds time series limitation and play link

* removes play from old topic

* ran prettier

* removed play shortcode, typo

* adds feedback from gilles

---------

Co-authored-by: tonypowa <tonypowa@gmail.com>
2024-08-21 17:20:59 +02:00
brendamuir
0631322d36
Alerting docs: adds sns integration (#92075)
* Alerting docs: adds sns integration

* deletes 2000 alert rule limit

* added .md ext and set weight field to 0

---------

Co-authored-by: tonypowa <tonypowa@gmail.com>
2024-08-20 16:22:07 +02:00
Pepe Cano
98a74d844e
Add grafana_state_reason section in State of alerts (#91562)
* Add `grafana_state_reason` section in State of alerts

* Minor edit for clarification

* Mention `Paused/RuleDeleted/Updated` states
2024-08-14 19:22:55 +02:00
Alexander Weaver
3b6a8775bb
Alerting: Fix stale values associated with states that have gone to NoData, unify values calculation (#89807)
* Unify values

* Fix with latest changes on main

* Fix up NaN test

* Keep refIDs with -1 as value

* Test that refIDs are preserved on Normal to Error transition

* Alerting to err test too

* Add a blurb to docs about this behavior
2024-07-08 12:30:23 -05:00
antonio
0cc67bb93d
alerting: notes on label matchers (#89269)
* alerting: notes on label matchers

* routing clarification

* Update docs/sources/alerting/alerting-rules/templating-labels-annotations.md

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

* Update docs/sources/alerting/fundamentals/notifications/templates.md

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

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-06-18 09:22:23 +02:00
antonio
000b5dd6ea
docs: alerting: clarify which panels support alerts (#88756)
* alerting: clarify which panels support alerts

* changed note placement

* small change to link

* added links

* 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/alerting-rules/create-mimir-loki-managed-rule.md

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

* Update docs/sources/panels-visualizations/visualizations/_index.md

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

* Update docs/sources/panels-visualizations/visualizations/time-series/index.md

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

* Update docs/sources/panels-visualizations/visualizations/time-series/index.md

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

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-06-06 15:19:59 +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
Gilles De Mey
8cc944f64f
Alerting: Docs feedback (#88125)
update OK to Normal label, matching instances to instances
2024-05-21 18:10:12 +03:00
Jack Baldry
410e3b17e9
[docs/sources/alerting] Replace docs/reference shortcode with ref URIs (#88079) 2024-05-21 15:43:21 +03:00
Pepe Cano
f3be9d009e
Alerting docs: Fix H3 headings in Configure Grafana alert rules. (#88040)
Configure Grafana alert rules: Fix `H3` headings
2024-05-20 10:41:27 +02:00
Pepe Cano
8e5ce99f72
Update Configure no data and error handling and State & Health (#87985)
* Update `Configure no data and error handling` and State & Health

* 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/alerting-rules/create-grafana-managed-rule.md

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

* 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/alert-rule-evaluation/state-and-health.md

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

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-05-20 09:39:30 +02:00
Pepe Cano
67f434dc73
Remove Single and multi-dimensional rule from Configure alert rules (#87951)
* Remove `Single and multi-dimensional rule` from `Configure alert rules`

* Do not change H3 titles
2024-05-20 09:34:00 +02:00
Pepe Cano
54eab4db59
Alerting docs: Relocate Resolved stale alert instances section (#87965)
Relocate `Resolved stale alert instances` section
2024-05-20 09:33:14 +02:00
antonio
e2f062d16d
alerting: Improve documentation regarding linking and visualizing alert rules in dashboards (#87892)
* commit 4

* commit 5
2024-05-15 15:50:32 +02: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
antonio
99f2de0847
alerting:config-notifications links (#87127)
* alerting:config-notifications links

* link fix

* linked blog post to examples section
2024-04-30 16:34:06 +02:00
Matthew Jacobson
980b9a62c6
Alerting: Enable simplified routing FF by default (#84856) 2024-03-22 13:45:20 -04:00
brendamuir
f30f7dfb93
Alerting docs: updates alert list view details (#84913)
* Alerting docs: updates alert list view details

* couple fixes

* prettier fixes

* corrects title
2024-03-21 14:57:54 +01:00
brendamuir
d01d99a585
Alerting docs: change icon and simplified routing (#84729) 2024-03-19 21:29:45 +01:00
Pepe Cano
200ff7f9b4
Alerting docs: fix broken link (#84572) 2024-03-15 16:23:52 +01: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
Armand Grillet
e33e219a9a
Remove legacy alerting docs (#84190) 2024-03-12 05:37:41 +01:00
brendamuir
05865034d7
Docs: removes note as recovery threshold now in cloud (#83907) 2024-03-05 14:22:03 +01:00
brendamuir
3901077f39
Alerting docs: changes weights and titles (#83519)
* Alerting docs: changes weights and titles

* language improvements to intro topic

* corrects rulle spelling

* adds alert instance info

* updates admonition note
2024-02-28 10:10:19 +02:00
brendamuir
93f18404c0
Alerting docs: readjust titles (#83504)
* Alerting docs: readjust titles

* removes outdated videos

* removes menutitle
2024-02-27 15:00:09 +02:00
brendamuir
45f8e7f8cf
Revert "Revert "Alerting docs: rework create alert rules definition and topic"" (#83372)
* Revert "Revert "Alerting docs: rework create alert rules definition and topic…"

This reverts commit 2b4f108771.

* updates aliases

* fixes after testing aliases

* more alias updates

* test silence alias

* fix alias for mute timings

* attempt alias fix

* ran prettier

* fixes more aliases

* quick title update

* fixes alias

* Update docs/sources/alerting/configure-notifications/manage-contact-points/_index.md

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

* Update docs/sources/alerting/configure-notifications/manage-contact-points/_index.md

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

* Update docs/sources/alerting/configure-notifications/manage-contact-points/_index.md

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

* Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-oncall.md

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

* Update docs/sources/alerting/configure-notifications/template-notifications/reference.md

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

* Update docs/sources/alerting/configure-notifications/template-notifications/use-notification-templates.md

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

* Update docs/sources/alerting/configure-notifications/template-notifications/using-go-templating-language.md

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

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

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

* Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier.md

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

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

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

* Update docs/sources/alerting/configure-notifications/template-notifications/_index.md

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

* Update docs/sources/alerting/manage-notifications/_index.md

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

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

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

* Update docs/sources/alerting/configure-notifications/manage-contact-points/_index.md

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

* Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-oncall.md

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

* Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/pager-duty.md

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

* Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier.md

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

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

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

* Update docs/sources/alerting/configure-notifications/template-notifications/_index.md

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

* fix silence aliases

* fix canonical

* Update docs/sources/alerting/configure-notifications/template-notifications/create-notification-templates.md

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

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

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

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-02-27 11:56:11 +01:00
Jack Baldry
2b4f108771
Revert "Alerting docs: rework create alert rules definition and topic" (#83328) 2024-02-23 19:30:08 +02:00
brendamuir
57114a4916
Alerting docs: rework create alert rules definition and topic (#83220)
* Alerting docs: rework create alert rules definition and topic

* ran prettier

* corrects note

* adds configure notifications section

* update branch

* corrects links

* parts of alert rule creation

* Update docs/sources/alerting/configure-notifications/_index.md

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

* moved section

* updates recording rule steps

* gets rid of configure integrations topic

* deletes configure integrations topic

* deletes links

* ran prettier

* Include contact point links

* phase 2 sorting out manage notifications

* manage notification changes

* manage notification updates

* finishing touches

* fixes links

* link fixes

* more link fix

* link fixes

* ran prettier

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-02-23 17:52:19 +01: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
d091e4c264
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
2024-02-21 12:21:44 +01:00
brendamuir
4b2ef36165
Alerting docs: fixes oncall broken links (#83139) 2024-02-21 09:39:13 +01:00
Pepe Cano
5b918f555c
Alerting docs: correct notification-policies link (#83099) 2024-02-20 13:50:31 +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
Jack Baldry
72c8ae2d8a
Remove duplicate paragraph and wrap in note (#82575) 2024-02-19 11:21:51 +00:00
Pepe Cano
3909b4c14a
Alerting docs: update <GRAFANA VERSION> to <GRAFANA_VERSION> (#82324) 2024-02-13 09:21:50 +00: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
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
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
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