60 Commits

Author SHA1 Message Date
facca37f4d Alerting docs: Update Create alert rules from panels (#95566)
* Alerting docs: Update `Create alert rules from panels`

* Remove screenshots except when the panel displays alert status

* Further changes sync with Brenda

* minor changes

* Relocate admonition

* Specify `dashboardUId` and `panelId` must be set together

* Update docs/sources/alerting/alerting-rules/link-alert-rules-to-dashboards.md

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

* change title

* change URL

* fix spell error

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-11-05 10:00:59 +01:00
9d937725ad Alerting docs: add Time type documentation for notification templates (#95688)
* Improve `tz` and `date` docs

* Add documentation for `Time` type
2024-11-04 12:21:28 +01:00
d3a3e53354 Alerting docs: Add one notification template example that prints a title or subject (#95680) 2024-11-04 09:24:40 +01:00
6fcfd132e5 Remove second aliases section (#95587) 2024-10-30 09:56:36 +00:00
c84b6b783c Docs: Fix shared file references (#95287) 2024-10-23 15:04:24 -04:00
813632dff1 Alerting Docs: Update Alert rule and Notification Templating (#94069)
* Update links to the new location of the Templates intro page

* Set alert rule template structure

* Update the `Template notifications` structure/sidebar

* Move examples to examples pages

* Update menu titles and URL paths

* WIP reference

* added intro to examples.md

* reference page section intros

* examples title

* Template

* Continue Alert Template Reference

* example sections

* Almost finish with Reference page

* weight pages

* WIP - template variables Intro

* Edits Alert rule templates + Differences with notification templates

* examples-draft-2

* how to map annotations to notif templates

* examples v2

* moved example

* Continue Template annotations and labels

* Preview annotation templates

* Complete `Template annotations and labels`

* Update `Differences with notification templates`

* Polish a bit `Differences with notification tempaltes`

* added logic examples to `Examples`

* Finish sharing Template language

* Minor: set `anchor` link

* Minor edit

* Minor edit

* Minor changes

* Template language changes

* Document missing functions for alert rule templates

* 'Examples' v3

* `Examples` v3.1

* `Examples` v3.2

* added context/intro to `Examples`

* added a how to section to `Examples`

* moved legacy info in `Examples`

* added examples, sections in `Examples`

* formatting

* examples v5

* examples v5.1

* Complete update to `Notification template reference`

* Update `$values` description

* moved steps to `index`

* fixed urls

* removed section in `examples`

* added refs

* fixed urls

* refs fix

* blended the use case into the explanation

* Notification template reference: Minor readibility changes

* Edit `$value` in Alert rule template reference

* Edit `Manage notification templates

* links to ref and lang pages

* Minor copy changes

* Edit Template annotation overview + Prepare Template notifications overview

* `Select` vs `Choose`

* Template Overview

* Fix `heading` does not match `title`

* examples v6

* examples v6.1

* Fix spell errors

* Run `prettier --write` to fix md format errors

* examples v7

* examples v7.1

* examples v7.2

* examples v7.4

* examples v7.5

* examples v7.6

* all pretty, no pity

* Update alert rule examples

* Complete `Labels and annotations template examples`

* Minor changes

* Use `.` notation instead of `index` in examples

* rename `extendeddata` to `notificationdata`

* Complete Notification examples

* minor changes

* Set `go` language when displaying template examples

* Revert "minor changes"

This reverts commit f647c55c8718a4b5c5ab51b3ef88ef0605de3c84.

* Update example and admonition for consistency

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

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

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

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

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

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

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

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

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

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

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

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

* Update docs/sources/shared/alerts/template-language.md

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

* Update docs/sources/shared/alerts/template-language.md

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

* Update docs/sources/alerting/alerting-rules/templates/language.md

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

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

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

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

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

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

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

* Update docs/sources/alerting/alerting-rules/templates/examples.md

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

* Update docs/sources/alerting/alerting-rules/templates/examples.md

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

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

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

* Update docs/sources/alerting/alerting-rules/templates/examples.md

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

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

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

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

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

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

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

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

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

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

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

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

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

* use `add` instead of `enrich`

* fix prettier content errors

* minor copy change

* Specify which Alert properties are exclusive to Grafana-managed alerts

* Use `Monitor` instead of `Meta monitoring`

* Be more detailed about notifation template limitations

---------

Co-authored-by: tonypowa <tonypowa@gmail.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-10-23 12:43:28 +02:00
87b57a1b25 Docs: Remove deprecation warnings for panelURL and dashboardURL (#94730)
Docs: Remove deprecation warnings for panelURL and dashboardURL in webhook and mqtt integration docs
2024-10-15 15:52:36 +02:00
981aad6b77 Docs: Fix description for GeneratorURL template value (#92578) 2024-10-14 13:16:27 +02:00
cbf8e7e679 Alerting docs: update that test functionality only for G Alertmanager (#94064)
* Alerting docs: update that test functionality only for G Alertmanager

* ran prettier

* fixed alphabetical order

* indentation

* format

* all pretty, no pity

---------

Co-authored-by: tonypowa <tonypowa@gmail.com>
2024-10-01 17:28:26 +02:00
f39c5ed9f7 Alerting: Improve Amazon SNS documentation (#93862)
* Alerting: Improve Amazon SNS documentation
2024-10-01 09:43:58 -04:00
7098c22f39 Docs: Remove deprecation warning on webhook payload fields (#92604) 2024-09-26 11:53:22 -03:00
c78ea87751 Docs > alerting: example of conditional notification based on labels (#93541)
* Docs > alerting: example of conditional notification based on labels

* typos

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

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

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-09-23 10:24:09 +00:00
aee9458d98 alerting>docs>notification template example (#93330)
* alerting>docs>notification template example

* all pretty no pity

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

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

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

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

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

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

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

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

* replaced future tense

* pretty

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-09-17 10:27:44 +00:00
9d3d1703f7 Alerting docs: adds caps not supported in email contact points (#92902)
* Alerting docs: adds caps not supported in email contact points

* ran prettier

* feedback from antonio

* ran prettier
2024-09-04 09:54:38 +00:00
832bb01f36 Alerting: Add MQTT notifications receiver (#91487)
* Alerting: Add MQTT notifications receiver
* Update alerting to 9daa6239cc41dc42bff0e916c8d0d27766caa8b9 (main)
---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-08-22 16:47:48 +02:00
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
534549e491 Alerting: Update documentation for MS Teams integration (#90610)
---------

Co-authored-by: Alyssa Wada <101596687+alyssawada@users.noreply.github.com>
2024-07-26 10:59:58 -04:00
2186676f55 alerting:docs>google chat (#90257)
* alerting:docs>google chat

* pretty

* weight

* changed weight

* typo
2024-07-17 08:22:47 +02:00
e061f2886f alerting/integrations:opsgenie (#90133)
* alerting/integrations:opsgenie

* Update _index.md

* new line

* all pretty no pity

* numbering

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

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

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

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

* Update configure-opsgenie.md

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-07-06 11:38:25 +02:00
8bc8b4b31f alerting/integrations:telegram-update (#90105)
* alerting/integrations:telegram-update

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

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

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

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

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-07-05 10:18:15 +02:00
d563db63e7 alerting/docs:discord (#90068)
* alerting/docs:discord

* 'pretty'
2024-07-04 17:42:33 +02:00
9740ce3f58 alerting:docs>oncall (#89780)
* alerting:docs>oncall

* removed refs

* links

* dot

* all pretty no pity
2024-07-02 17:21:29 +02:00
f833b782b6 Alerting docs: adds silence RBAC 11.1 (#89176)
* Alerting docs: adds silence RBAC 11.1

* ran prettier

* Improve docs with new rule-specific silence RBAC information

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* prettier

---------

Co-authored-by: Matt Jacobson <matthew.jacobson@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-06-27 10:10:34 +02:00
891cc0512f alerting: teams contact point + updates (#89695)
* alerting: teams contact point + updates

* typo

* all pretty no pity

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

* formatting

* formatting

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-06-25 17:52:53 +02:00
3a29f68d0c Alerting docs: vale fixes (#89604)
* Alerting docs: vale fixes

* fix numbering

* Alerting docs: monitor errors

* takes out will

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

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

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

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

* Update docs/sources/alerting/configure-notifications/template-notifications/images-in-notifications.md
2024-06-25 08:14:16 +02:00
ffe755f95d Alerting: Add warning in telegram contact point (#89397)
* Add warning in telegram contact point

* Protect possible undefined in settings

* Address review comments
2024-06-20 17:00:57 +03:00
beb8397be8 Alerting docs: adds notification policy update (#88515)
* Alerting docs: adds notiification policy update

* Adds insert below or above

* ran prettier

* few grammar adds

* Changes to child policy terminology

* adds sibling terminology

* ran prettier

* updates with new terminology

* updates child policy info

* corrects typo

* ran prettier

* changes description for child policy
2024-06-06 14:59:04 +02:00
3e57576770 Alerting docs: Contact points updates (#88582)
* Update `Intro>Notifications>Contact points`

* Mention `OnCall` integration
2024-06-03 11:01:54 +02:00
68c44f1dd9 Alerting docs: Update Alertmanager docs (#88567)
* Remove alertmanager page and set redirects

* Update internal alertmanager links

* Update `Alertmanager` docs

* Change heading to `Configure Alertmanagers`
2024-06-03 11:00:52 +02:00
c8bbc9d6e5 Alerting docs: adds template selector docs (#88412)
* Alerting docs: adds template selector docs

* adds line about single save
2024-05-29 15:39:22 +02:00
3d7fc8c927 Alerting docs: Update Intro - alert rule labels and annotations (#88230)
* Update `Labels & Annotations`

* Complete labels and annotations

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

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

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

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

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

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

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-05-24 10:09:35 +02:00
410e3b17e9 [docs/sources/alerting] Replace docs/reference shortcode with ref URIs (#88079) 2024-05-21 15:43:21 +03:00
fe78563faa Alerting docs: vale fixes (#88039)
* Alerting docs: vale fixes

* ran prettier
2024-05-21 14:26:40 +02:00
086def3f57 alerting: contact points - links (#87955)
* alerting: contact points - links

* fundamentals: alerting instructions update

* updated steps

* prettier
2024-05-16 12:19:44 +02:00
1191992226 alerting: PD - typo fix (#87674)
typo fix
2024-05-13 11:34:02 +02:00
7e8b71d882 alerting: docs - pagerduty (#87604)
* alerting: docs - pagerduty

* pretty
2024-05-11 11:00:28 +02:00
3a2c9f4898 alerting: integrations > small update (#87538)
* added links to list

* changed heading
2024-05-09 11:31:28 +02:00
d83cbe4d85 alerting/webhook doc update (#87492)
* alerting/webhook doc update

* text formath

* fixed admonition

* typo

* headings

* formatted headings and prettified it all

* one more heading
2024-05-08 13:49:55 +03:00
1bde17c8d5 alerting: config notif page improvement (#87140)
* alerting: config notif page improvement

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

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

* Update _index.md

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-05-07 10:26:04 +02:00
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
c049e5bbfc Alerting: Update grafana/alerting to bb4f4f4 (#86827) 2024-04-25 10:47:01 +01:00
2d9d0e61b1 Added Caveat regarding inheritance of Mute timings (#86678)
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-04-23 10:27:24 +02:00
f7b82a74ad alerting: email doc >url fix (#86574)
* url fix

* pretty
2024-04-19 17:01:42 +02:00
272b2e139a email contact point -url fix (#86538)
url fix
2024-04-18 17:24:22 +02:00
212acb9bc5 Alerting: clarify alerting silences (#85853)
* Clarify alerting silences

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

Co-authored-by: Tom Ratcliffe <tom.ratcliffe@grafana.com>

---------

Co-authored-by: Tom Ratcliffe <tom.ratcliffe@grafana.com>
2024-04-10 18:30:21 +02:00
4b4bdc7c33 docs: email contact point (#85627)
* docs: email contact point

* applied suggestions

* admonition fix

* small typo fix

* applied suggested changes

* formatted text / applied suggestions
2024-04-08 11:35:45 +02:00
ad5ade71bb telegram url fix (#85583)
* alerging-get-started: update

* fixed url issues

* pretty

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

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

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-04-04 15:14:22 +02:00
847d2b01b6 Alerting docs: note on images in notifications for cloud (#85529) 2024-04-03 14:32:56 +02:00
561838a87d convert telegram blog post to doc (#85231)
* convert telegram blog post to doc

* pretty

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

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

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

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

* applied suggested changes

* fixed typo

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-04-03 14:28:50 +02:00
a7c7a1ffed Alerting docs: Fix format issues in recent Slack tutorial (#84651)
* Alerting docs: Fix format issues in Slack tutorial

* Alerting docs: Include link to Slack docs

* Alerting docs: fix Slack `nested-policy` link
2024-03-18 13:18:57 +01:00