cf1b964829
docs(alerting): clarify transition to Recovering state when using recovery thresholds ( #104381 )
2025-04-23 15:15:12 +02:00
6abe6499c4
docs(alerting): clarify how Math expressions operate on multiple series ( #104316 )
2025-04-22 22:56:56 +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
54fb34f59b
docs(alerting): specify sequential evaluation for imported DS rules ( #104234 )
2025-04-22 22:17:45 +02:00
7c0cb1b7bb
docs(alerting): replace outdated alert state diagram with updated image ( #104232 )
2025-04-22 22:15:07 +02:00
9e4980320a
docs(alerting): add JSON payload example to template examples list ( #104282 )
2025-04-22 22:14:50 +02:00
536ff2fc3d
docs(alerting): clarify recovery threshold for pending state ( #102780 )
...
Alerting docs: clarify recovery threshold on pending state
2025-04-21 18:50:53 +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
1bafd5c807
Docs: Remove mention of alertingApiServer flag from alerting documentation ( #104131 )
2025-04-18 11:51:38 -04:00
b604fdf6f8
Alerting: Update docs for RBAC ( #104005 )
...
* Alerting: Update docs for RBAC
This updates the documentation for RBAC to match the changes from 032299011a26483567cce9b31c149dcd295e23d2
* add note about RBAC permissions with datasource permissions
* writers toolkit update
2025-04-15 15:34:19 -04:00
17fbeb09f1
docs: alert migration tool draft ( #103752 )
...
* docs: alert migration tool draft
roughest of rough drafts, homies.
* prettier + edit
* Update migration-api.md
* Update migration-api.md
* edits per sonia and alex
* Update migration-api.md
* fresh edits
edits from some alex wisdom
* Update migration-api.md
* Update migration-api.md
* Update migration-api.md
* Update docs/sources/alerting/alerting-rules/alerting-migration/_index.md
Co-authored-by: Sonia Aguilar <33540275+soniaAguilarPeiron@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/alerting-migration/migration-api.md
Co-authored-by: Alexander Akhmetov <me@alx.cx>
* edits
feature flag info added to docs as well as another edit
---------
Co-authored-by: Sonia Aguilar <33540275+soniaAguilarPeiron@users.noreply.github.com>
Co-authored-by: Alexander Akhmetov <me@alx.cx>
2025-04-11 20:11:33 +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
c5760eb147
docs: add documentation for keep_firing_for and Recovering state ( #103412 )
...
* docs: add documentation for keep_firing_for and Recovering state
add documentation for keep_firing_for and Recovering state
* updated image, added procedure step, added new state info
updated image, added procedure step, added new state info
* vale'd
* Update docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md
Co-authored-by: Sonia Aguilar <33540275+soniaAguilarPeiron@users.noreply.github.com>
* edits with gratitude to pepe
* impage update
image
---------
Co-authored-by: Sonia Aguilar <33540275+soniaAguilarPeiron@users.noreply.github.com>
2025-04-11 16:06:38 +00:00
e9643366b3
alerting docs: update alert rules history limit documentation ( #102838 )
...
* alerting docs: update alert rules history limit documentation
the documentation for the alert rules version history has been updatedto specify that the rules apply to enterprise/OSS customers.
the rules should also be explicated for cloud documentation.
* Update view-alert-rules.md
2025-04-11 08:43:46 -05:00
f1625d9e56
docs: docs for "Permanently delete" feature for alert rules ( #103409 )
...
* documentation on permanently deleting alert rules
document the new Delete permanently feature.
* Update create-grafana-managed-rule.md
uuid detail
* Update create-grafana-managed-rule.md
* Update create-grafana-managed-rule.md
vale
* Update docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md
thanks pepe
Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>
---------
Co-authored-by: Pepe Cano <825430+ppcano@users.noreply.github.com>
2025-04-11 08:29:27 -05: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
a8f60de620
Alerting: Remove feature toggles relating to Loki Alert State History ( #103540 )
...
* Remove feature toggles relating to Loki Alert State History
2025-04-08 09:50:27 -04:00
3cc2c1509b
docs(alerting): fix annotation names for panel links in alerts ( #103471 )
2025-04-08 07:09:48 +02:00
21fe9480a1
docs(alerting): Configure Grafana IRM ( #103549 )
...
* docs(alerting): Configure Grafana IRM
* update `PagerDuty`
2025-04-07 18:51:49 +02:00
1220bc7a5f
alerting docs: alert rule recovery documentation ( #102938 )
...
* alerting docs: alert rule recovery documentation
document the alert rule recovery feature
* shared content edit
* prettiest
* restore content
* Update create-data-source-managed-rule.md
2025-04-01 09:49:37 -05:00
37c6c519c8
docs(alerting): stale alert instance minor change ( #103030 )
...
docs(alerting): stale alert instance minor text change
2025-03-27 23:00:13 +01:00
740c47c33a
docs(alerting): stale alert instances updates ( #103014 )
...
* docs(alerting): stale alert instances updates
* correct vale error
2025-03-27 22:14:28 +01:00
d44a9953d3
docs(alerting): add missing port setting for the HA k8s example ( #103017 )
2025-03-27 22:05:41 +01:00
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
