558773ed7f
docs: add note about alert migration ( #102741 )
...
* docs: add note about alert migration
added note about alert migration in 11.6.0.
* docs: add note about alert migration
adding documentation about the migrations to the performance limitation docs
* title edit
<-- vale = NO -->
2025-03-26 15:39:32 -05:00
c54da8f955
Alerting: Make $value return the query value in case when a single datasource is used ( #102301 )
...
What is this feature?
This PR changes the behavior of the $value and .Value variables in alerting templating to be more compatible with Prometheus templating. When a single datasource is used in the alerting rule, these variables will now return the numeric value from the query instead of the evaluation string.
Why do we need this feature?
It makes Grafana templating more compatible with Prometheus templates. In Prometheus, $value returns the numeric value of the query, but in Grafana it's the evaluation string: [ var='A' labels={instance=instance1} value=81.234 ]. This is because in Grafana multiple datasources can be used in the alert rule, and it's not always possible to get a single value.
This change makes Grafana's behavior consistent with Prometheus when a single datasource is used, and in case when multiple datasources are used in the query, it keeps the old behaviour.
Both $value and .Value are not recommended to use (documentation), and it's better to use .Values instead.
2025-03-26 10:31:38 +01:00
d25dba8d0a
Alerting docs: additional details for No Data and Error alerts ( #102593 )
...
* Alerting docs: additional details for `No Data` and `Error` alerts
* add Error in the list of possible values
---------
Co-authored-by: Sonia Aguilar <33540275+soniaAguilarPeiron@users.noreply.github.com>
2025-03-24 10:43:01 +01:00
e2b84ff828
alerting docs: add note about alert rule versions limit ( #102647 )
...
added note about alert rule versions limit
2025-03-21 14:40:58 -05: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
42958497ff
alerting docs: add alert rule history image ( #101980 )
...
* alerting docs: add alert rule history image
add image for alert rule history to docs
* Update view-alert-rules.md
* lint/prettier
2025-03-13 14:01:56 -05:00
9452069745
docs(alerting): timing options minor enhancements ( #101965 )
...
* docs(alerting): timing options minor enhancements
* minor addition
* Update docs/sources/alerting/fundamentals/notifications/group-alert-notifications.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-03-13 18:08:31 +01:00
65d047dd43
docs(alerting): add notification screenshots details in Create and link alert rules to panels ( #102103 )
...
* format admonition
* include mention to display panel screenshots in notifications
2025-03-13 17:12:57 +01:00
64b65ffc72
docs(alerting): minor enhancements to intro concepts and example ( #102023 )
...
* docs(alerting): minor enhancements to intro concepts and example
* Update docs/sources/alerting/fundamentals/alert-rules/annotation-label.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-03-12 22:04:26 +01:00
3e1513a6df
docs(alerting): alert instance state resets when rule changes ( #102038 )
...
* docs(alerting): alert instance state resets when rule changes
* specify that annotations updates are not affected
* enumerate exception fields
2025-03-12 21:51:39 +01:00
ee2050d866
Alerting: Update docs for alert rule versions tab ( #101998 )
...
* Update docs for alert rule versions tab
* Update docs/sources/alerting/monitor-status/view-alert-rules.md
Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com>
---------
Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com>
2025-03-12 15:00:35 +00:00
13cd9c3c60
Docs: Fix incorrect label groupings ( #101491 )
...
fix incorrect label groupings in alerting documents
Co-authored-by: Matheus Macabu <macabu.matheus@gmail.com>
2025-03-12 07:33:15 +00:00
5bfe046da9
docs(alerting): clarify behaviour when provisioning the policy tree ( #101937 )
2025-03-11 15:58:25 +01:00
a800f87064
Alerting docs: clarify No data/Error alerts skip pending period ( #101431 )
...
* Alerting docs: clarify `No data/Error` alerts skip pending period
* fix vale errors
2025-03-10 11:36:09 +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
23ccd2be95
Alerting docs: dynamic label changes ( #101781 )
2025-03-10 11:31:07 +01:00
df3e58cb11
docs: alert rule history ( #100378 )
...
* docs: alert rule history
first draft
* -additional h2, removal of compare functionality
-additional h2, removal of compare functionality
* Update docs/sources/alerting/monitor-status/view-alert-rules.md
Co-authored-by: Sonia Aguilar <33540275+soniaAguilarPeiron@users.noreply.github.com>
* Update docs/sources/alerting/monitor-status/view-alert-rules.md
Co-authored-by: Sonia Aguilar <33540275+soniaAguilarPeiron@users.noreply.github.com>
* Update docs/sources/alerting/monitor-status/view-alert-rules.md
Co-authored-by: Sonia Aguilar <33540275+soniaAguilarPeiron@users.noreply.github.com>
* Update view-alert-rules.md
added image
* update frontmatter description
* prettier
* Update view-alert-rules.md
* Update view-alert-rules.md
---------
Co-authored-by: Sonia Aguilar <33540275+soniaAguilarPeiron@users.noreply.github.com>
Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
2025-03-06 18:03:17 -06:00
13cf67de53
Remove relref shortcodes ( #101694 )
...
* manually replce all shared relrefs
* relref replace - grafana next
* Merge branch 'master' into robbymilo/relref-replace-grafana-next
* manual fixes
* remove ref shortcode
* Merge branch 'master' into robbymilo/relref-replace-grafana-next
* prettier
* fix test
* update readme
2025-03-06 13:59:08 +01:00
5b61222733
Lint only Markdown files ( #101533 )
...
* Lint only Markdown files
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Lint a file
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Test
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Lint
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2025-03-04 11:00:35 +00:00
87a4034332
docs: link to tutorial from docs ( #101277 )
...
* docs: link to tutorial from docs
* missing part of url
2025-02-25 12:13:16 +01:00
9073f1a525
docs: document new alerting threshold operators ( #101013 )
...
* docs: document new alerting threshold operators
adding new operators to alerting docs
Equal
Not Equal
Greater or Equal
Less or Equal
Within Range Inclusive
Outside Range Inclusive
* cAPITALIZATION fIX
* Update docs/sources/alerting/fundamentals/alert-rules/queries-conditions.md
Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/alert-rules/queries-conditions.md
Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/alert-rules/queries-conditions.md
Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>
* Update queries-conditions.md
matching with ui
---------
Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>
2025-02-24 12:17:13 -06: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
1fdb36022d
Alerting docs: fix tutorial URL ( #100954 )
2025-02-19 10:58:49 +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
983829e47b
Alerting docs: remove admonition about auto-generated policies ( #100501 )
2025-02-12 15:13:05 +01: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
99c8d4b0c6
Update Intro > Queries and Conditions ( #95109 )
...
* Update `Intro > Queries and Conditions`
* Small tweaks (advanced options) and screenshots
* Change `Expressions` heading
* Set links from Alert rules introduction
* Minor intro changes
* small change due to recent updates
* fix vale errors
* fix vale error
* Remove unnecessary mention to `alertingQueryAndExpressionsStepMode` feature flag
2025-02-12 10:42:53 +01:00
a9ce930634
Alerting: Promote alertingSaveStateCompressed flag to public preview ( #99935 )
2025-02-06 18:09:43 +01:00
5fe6479a10
Alerting docs: update screenshot (modify NoData/Error state) ( #99996 )
2025-02-03 22:01:18 +01:00
cf177776bf
Alerting: Adding color option for slack receiver ( #99615 )
2025-01-30 00:12:16 +02:00
9c7618160d
Update queries-conditions.md ( #99592 )
2025-01-28 10:52:50 +01:00
88d5ae8153
docs>alert-rules>templates:example-fix ( #99355 )
...
* docs>alert-rules>templates:example-fix
* second-fix
* fixed 2 other label templates
2025-01-22 11:01:11 +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
7771768363
Alerting docs: clarify data source-managed rules for Prometheus ( #98378 )
...
* Clarify DS managed rules support only the creation of Mimir and Loki rules
* additional copy changes
* Extend `Manage alerts via Alerting UI` description
* fix capital letter
* further details for `Manage alerts via Alerting UI`
2025-01-14 13:34:02 +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
6178320257
Alerting docs/internal: leaf bundle page becomes a branch bundle ( #98391 )
2024-12-30 11:49:11 +01:00
6976908597
Alerting docs: update configuring and using additional Alertmanagers in Grafana Alerting ( #98363 )
...
* Alerting docs: Alertmanager data source
* Alertmanager data source: minor intro changes
* Update `Intro > Notifications`
* Complete Configure alertmanager update
* Configure alertmanager
* minor final edits
2024-12-27 10:16:31 +01:00
9f0e1a1053
Alerting docs: fix broken link ( #98259 )
2024-12-20 11:08:32 +01:00
9a17954eaf
tutorial>alerting:get started with grafana alerting part 3 ( #98093 )
...
* tutorial>alerting:get started with grafana alerting part 3
* draft 1
* call-to-action
* typos
* all pretty, no pity
* delete sentence
* Update docs/sources/alerting/fundamentals/notifications/group-alert-notifications.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/tutorials/alerting-get-started-pt2/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/tutorials/alerting-get-started-pt2/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/tutorials/alerting-get-started-pt2/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/tutorials/alerting-get-started-pt3/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/tutorials/alerting-get-started-pt3/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/tutorials/alerting-get-started-pt3/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/tutorials/alerting-get-started-pt3/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/tutorials/alerting-get-started-pt3/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* admon
* pretty again
* links
* format
* group interval note
* Update docs/sources/tutorials/alerting-get-started-pt3/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* rmved note
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-12-19 13:22:03 +01:00
001cc853a5
Alerting docs: update Monitor status section ( #98179 )
...
* Minor updates to `Declare incidents` docs
* change URL
* View alert state history + restructuring
* Complete alert state
* alert state
* change heading
* View alert rules
* Monitor alerts
2024-12-18 13:23:15 +01:00
7f6c794ecd
Update create-notification-policy.md ( #98077 )
...
found an extra /
2024-12-18 12:39:17 +02:00
1f8f9a45d7
Alerting: Add state_periodic_save_batch_size config option ( #98019 )
...
* Alerting: Add state_periodic_save_batch_size config option
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-12-16 15:30:38 +01:00
c983af1755
Alerting docs: reorder rules action in DS rules ( #97974 )
...
Alerting docs (minor) - mention `reorder rules` action in DS rules
2024-12-16 12:08:10 +01: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
