46ef9aaa0a
Alerting docs: Links fix ( #115044 )
...
* alerting docs: links fix
fixes 404 errors
* Alerting docs: Fix Slack integration links
Fixes Slack links and clarifies the first two steps.
* prettier
2025-12-12 08:58:10 -06:00
0aeb4feef3
update documentation to mention protected fields ( #114809 )
...
* update documentation to mention protected fields
* alerting docs: add protected field info for grafana cloud
add protected field info for grafana cloud
* prettier
* link fix
---------
Co-authored-by: Yuri Tseretyan <yuriy.tseretyan@grafana.com >
2025-12-03 19:47:23 -05:00
67f811b6d8
alerting: mute timing clarification ( #113129 )
...
* alerting: mute timing clarification
clarify that mute timing takes precedence over active timing
* alerting docs: best practices addition
draft content for best practices re: recording rules
* wrong branch
* alerting: best practices docs
best practices addition re: recording rules
* smh
2025-11-12 10:49:50 -06:00
fb5c5411f8
docs(alerting): clarify usage of templates in webhook custom payloads ( #112672 )
...
* docs(alerting): clarify usage of templates in webhook custom payloads
* Update docs/sources/alerting/configure-notifications/template-notifications/manage-notification-templates.md
Co-authored-by: Johnny Kartheiser <140559259+JohnnyK-Grafana@users.noreply.github.com >
---------
Co-authored-by: Johnny Kartheiser <140559259+JohnnyK-Grafana@users.noreply.github.com >
2025-10-21 13:32:01 -05:00
7bc97d5fa8
Docs: Add contact point specific text formatting examples ( #112276 )
...
* Docs: Add contact point specific text formatting examples to notification templates
* Add Slack formatting examples with *bold* and _italic_ syntax
* Clarify that text formatting depends on contact point type
* Docs: Add contact point specific text formatting examples to notification templates
* Reflect review that fix docs
2025-10-15 17:28:10 +00:00
f150c56e00
alerting docs: ai templating .md swap ( #112233 )
...
moving the file to the proper templating section
2025-10-09 16:57:50 +00:00
5438df01a1
docs(alerting): Email contact point enhancements ( #111944 )
...
* docs(alerting): Email contact point enhancements
* minor content tweaks
2025-10-07 17:20:52 +02:00
73a241da86
alerting docs: update contact point emails (SE #17651 ) ( #110780 )
2025-09-10 19:47:33 +00:00
c94f930950
Update dependency prettier to v3.6.2 ( #108689 )
...
* Update dependency prettier to v3.6.2
* run prettier
---------
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com >
2025-07-25 17:47:44 +01:00
08e8a71ad6
alerting docs: activate active timing time ( #107928 )
...
* alerting docs: activate active timing time
rough draft: documentation for active timing feature.
* purdier
* more tweaks
* edits via yuri advice
* prettier
2025-07-17 10:56:25 -05:00
1cd6ef6b84
Docs: Align Jira documentation with contact point options ( #105069 )
...
Align with option names in contact point.
To avoid confusion, ensure that the documentation aligns with the option names used in the Jira contact point.
2025-07-10 21:15:04 +00:00
244ffad99d
Fix all the old usage of admonition syntax ( #106984 )
2025-06-19 17:31:13 +01:00
493e7ba75f
docs(alerting): enhancements for MQTT docs ( #106566 )
...
* docs(alerting): enhancements for MQTT docs
* Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-mqtt.md
Co-authored-by: Simon Prickett <simon@crudworks.org >
---------
Co-authored-by: Simon Prickett <simon@crudworks.org >
2025-06-13 10:27:08 +02:00
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
8de013c7e6
docs(alerting): OpsGenie instructions for other alertmanagers ( #106049 )
...
* docs(alerting): OpsGenie instructions for other alertmanagers
* run prettier
2025-05-28 10:59:05 +02:00
a1b1de584c
docs(alerting): fix broken links due to using shared md files ( #105195 )
...
* docs(alerting): fix broken links due to using shared md files
* fix prettier errors
* fix aliased links
2025-05-09 21:03:38 +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
50e24d6634
docs(alerting): clarify that webhook extra headers can override the Content-Type header ( #104324 )
2025-04-22 22:19:28 +02:00
9e4980320a
docs(alerting): add JSON payload example to template examples list ( #104282 )
2025-04-22 22:14:50 +02:00
a3d27c5912
docs(alerting): Add heartbeat monitoring docs for the IRM contact point ( #103811 )
...
* docs(alerting): Add heartbeat monitoring docs for the IRM contact point
* Use `After` instead of `Once`
2025-04-21 12:31:56 +02:00
f023fcc68a
docs(alerting): New Alertmanager contact point docs ( #103782 )
2025-04-21 12:08:41 +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
e650fa7b20
docs(alerting): update integration choice for IRM setup ( #103701 )
2025-04-09 18:47:36 +02:00
6a358c7fd6
docs(alerting): Configure IRM for Alerting (OSS/Enterprise) ( #103614 )
2025-04-08 17:36:46 +02:00
21fe9480a1
docs(alerting): Configure Grafana IRM ( #103549 )
...
* docs(alerting): Configure Grafana IRM
* update `PagerDuty`
2025-04-07 18:51:49 +02:00
671ba2ab02
docs: create documentation for jira service management contact point ( #100444 )
...
* docs: create documentation for jira service management contact point
create documentation page for jira service management
* Update configure-jira-service-management.md
updates thanks to yuri and some subsequent edits
* minor edits, weight
minor edits, weight
* links and tables
links and references to jira added on other pages, bullets turned into a table.
* edits
* Update configure-jira.md
link fix
* Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-jira.md
Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com >
* Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-jira.md
Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com >
* Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-jira.md
Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com >
* Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-jira.md
Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com >
* Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-jira.md
Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com >
* Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-jira.md
Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com >
* Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-jira.md
Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com >
* Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-jira.md
Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com >
* pretty, prettier, prettiest
* Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-jira.md
Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com >
* Update configure-jira.md
prettier
---------
Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com >
2025-03-18 15:33:24 -05:00
ef5cc12b33
Alerting: Add HMAC signature config to the webhook integration ( #100960 )
...
Adds HMAC-SHA256 signature support to webhook notifications, providing a way to verify the authenticity and integrity of webhook requests. The implementation allows to specify the header in which the signature will be sent. The signature is calculated from the request body.
An optional timestamp header name can be provided. If set, the HMAC signature will be generated by concatenating the timestamp, a ":" and the request body: {timestamp}:{body}. The timestamp will also be sent in the provided header name.
2025-03-14 07:22:41 +01: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
8646961c3f
Alerting docs: fix heading anchor ( #100783 )
...
Co-authored-by: Jack Baldry <jack.baldry@grafana.com >
2025-02-19 11:47:55 +01:00
e1c1cc34af
Alerting docs: Update Amazon SNS integration ( #100754 )
...
* Update `Configure Amazon SNS notifications`
* Clarify templateable fields
* correct prop description
2025-02-18 22:50:13 +01:00
f1b4678012
Alerting docs: update Configure Webhook notifications ( #100650 )
...
* Alerting docs: update `Configure Webhook notifications`
* fix typo
* fix typo
* Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier.md
Co-authored-by: Matthew Jacobson <matthew.jacobson@grafana.com >
* Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier.md
Co-authored-by: Matthew Jacobson <matthew.jacobson@grafana.com >
* fix typo
* Add `Note` to configure either HTTP Basic Authentication or the Authorization request header
* Use `inline` format for JSON keys
---------
Co-authored-by: Matthew Jacobson <matthew.jacobson@grafana.com >
2025-02-14 11:04:08 +01:00
6e4c1a57c1
docs: capitalization issues ( #100562 )
...
fixing two capitalization issues for product names.
2025-02-13 10:29:04 -06:00
8e436fc473
Alerting docs: Add Enable notifications section to Configure contact points docs ( #100446 )
...
Alerting docs: Add `Enable notifications` section to `Configure contact points` page
2025-02-12 11:18:31 +01:00
2b4e1f3c51
Alerting docs: clarify that silences and mute timings do not interrupt alert evaluation ( #100414 )
...
* Alerting docs: clarify that `silences` and `mute timings` do not interrupt alert evaluation
* replace `ad-hoc` word
2025-02-12 11:12:40 +01:00
c7edbffd82
Alerting docs: add Admonitions to Link Doc pages with practical Tutorials ( #99317 )
...
Alerting docs: add admonitions to link to practical tutorials
2025-01-21 15:18:57 +01:00
9ce9ad1777
Alerting docs: add instructions to execute notification template examples ( #99275 )
2025-01-21 10:32:04 +01:00
619e7d3d3f
Alerting docs: fix template example link ( #98715 )
...
* Alerting docs: fix template example link
* ran prettier
* adjust spacing
* Update docs/sources/alerting/configure-notifications/template-notifications/manage-notification-templates.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com >
* Alerting docs: fix `Explore` ref link
* updates other links
* correcting link
* Update docs/sources/alerting/alerting-rules/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com >
* Update docs/sources/alerting/alerting-rules/templates/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com >
* fix label ref
---------
Co-authored-by: Jack Baldry <jack.baldry@grafana.com >
Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com >
2025-01-10 15:21:18 +01:00
9558a25ebe
Alerting text: rename Affected alert rule instances ( #98369 )
...
* Alerting text: rename `Affected alert rule instances`
* Update docs/sources/alerting/configure-notifications/create-silence.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com >
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com >
2025-01-07 13:38:21 +01:00
9f0e1a1053
Alerting docs: fix broken link ( #98259 )
2024-12-20 11:08:32 +01:00
7f6c794ecd
Update create-notification-policy.md ( #98077 )
...
found an extra /
2024-12-18 12:39:17 +02:00
b8c4126fbc
Alerting docs: update Configure notifications ( #97862 )
...
* Update `Configure notifications`
* wip notification policies
* Finish Create Notification Policy
* Minor update to Contact point intro
* Fix `How label matching works` links and remove links from contact point intro
* Silences and Mute timings
* Reorder + MuteTimings + Silences
* Complete Create silence
* fix mispell
* Update docs/sources/alerting/configure-notifications/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com >
* Update docs/sources/alerting/configure-notifications/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com >
* Update docs/sources/alerting/configure-notifications/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com >
* Update docs/sources/alerting/configure-notifications/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com >
* fix prettier error
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com >
2024-12-13 16:26:45 +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
706300e9b7
Alerting: notification template group ( #96447 )
...
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com >
Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com >
2024-11-22 14:40:20 +02:00
b14d58a890
Update images-in-notifications for Alerting ( #95765 )
...
* Update images-in-notifications for Alerting
* Review I
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com >
* Clarify it's only on Emails
Co-authored-by: Santiago <santiagohernandez.1997@gmail.com >
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com >
Co-authored-by: Santiago <santiagohernandez.1997@gmail.com >
2024-11-12 10:34:36 +01:00
ca04cf780b
Alerting docs: fixes broken oncall link ( #96215 )
2024-11-11 14:00:30 +01:00
290612e366
Alerting docs: specify using multiple contact point integrations in the UI and HTTP API ( #95890 )
...
* Sort list of contact points on the sidebar
* Update `Configure contact points` to clarify contact point integrations
* Alerting HTTP API: fix `EmbeddedContactPoint` properties table
* HTTP Alerting API: clarify how `ContactPoint.name` groups contact points
* Update docs/sources/alerting/configure-notifications/manage-contact-points/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com >
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com >
2024-11-06 15:28:44 +01:00
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
Johnny Kartheiser
Pepe Cano
Seunghun Shin
renovate[bot]
Blueswen
Jack Baldry
Matthew Jacobson
Alexander Akhmetov
brendamuir
flopp999
Jara Suárez de Puga García