f36d5c5206
docs(alerting): new notification template example: link to a dashboard with time range ( #106254 )
...
* docs(alerting): new notification template example: link to a dashboard with time range
* remind configuring the `MyDashboardURL` annotation
* Update docs/sources/alerting/configure-notifications/template-notifications/examples.md
Co-authored-by: Matthew Jacobson <matthew.jacobson@grafana.com>
---------
Co-authored-by: Matthew Jacobson <matthew.jacobson@grafana.com>
2025-06-03 17:16:43 +02:00
d0154e8e77
docs(alerting): admonition for webhook features that are not GA in GC ( #104331 )
...
* docs(alerting): admonition for webhook features that are not GA in GC
* fix plural
* minor copy change
2025-04-22 22:45:48 +02:00
9e933882ed
Alerting: Webhook Improvements - Templateable Payloads ( #103818 )
...
* Template editor syntax highlighting when preview is json-like
* Add new template editor language examples, snippets, and functions
* Use updated NewTemplate function
* Add new fields to webhook notifier
- CustomPayload
- ExtraHeaders
* Documentation
* Update grafana/alerting to in-progress PR (needs updating after merge)
* Fix integration test
* Remove docs reference to .Extra template context
No longer exists, was part of a previous iteration
* make update-workspace
* Update grafana/alerting to actual merged commit
2025-04-11 12:22:51 -04:00
5fb8540230
Alerting docs: clarify values included in Alert.Labels and Alert.Values ( #101571 )
...
* Alerting docs: clarify values included in `Alert.Labels` and `Alert.Values`
* minor change
2025-03-10 11:31:50 +01:00
9ce9ad1777
Alerting docs: add instructions to execute notification template examples ( #99275 )
2025-01-21 10:32:04 +01:00
8fe36e1c83
Alerting docs: clarify $labels and query labels ( #97350 )
...
* Alerting docs: clarify `$labels` and query labels
* fix mispell
2024-12-03 15:57:17 +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
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
981aad6b77
Docs: Fix description for GeneratorURL template value ( #92578 )
2024-10-14 13:16:27 +02:00
c049e5bbfc
Alerting: Update grafana/alerting to bb4f4f4 ( #86827 )
2024-04-25 10:47:01 +01:00
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
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 2b4f1087712e82d17db8ce29adf4a40f5b76e0fc.
* 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
2b4f108771
Revert "Alerting docs: rework create alert rules definition and topic" ( #83328 )
2024-02-23 19:30:08 +02:00
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
