Commit Graph

413 Commits

Author SHA1 Message Date
brendamuir
d19803a0f0
Alerting docs: updates to alert rules docs for 9.4 (#62744)
* Alerting docs: updates to alert rules docs for 9.4

* Adds updates to oncall contact point and pause alerts

* Adds view read-only query update 9.4
2023-02-02 16:31:03 +00:00
brendamuir
9d07b77532
Alerting docs: adds declare incident (#62681)
* Alerting docs: adds declare incident

* adds alert detail view option
2023-02-01 16:55:40 +00:00
ismail simsek
91221bc436
Expressions: Fixes the issue showing expressions editor (#62510)
* Use suggested value for uid

* update the snapshot

* use __expr__

* replace all -100 with __expr__

* update snapshot

* more changes

* revert redundant change

* Use expr.DatasourceUID where it's possible

* generate files
2023-01-31 18:50:10 +01:00
Andre Miras
a7c4872bcd
Alerting: Clarify PagerDuty integrationKey format (#62463)
**What is this feature?**

Simply a documentation update.

**Why do we need this feature?**

Clarify the doc, so people don't waste time integrating the wrong key,
e.g. #8979, #9036, https://community.librenms.org/t/19013

**Who is this feature for?**

Developers doing a PagerDuty integration.
2023-01-30 18:23:33 +00:00
Gilles De Mey
702fd0f9e8
Docs: Update wording / text and copy (#61868)
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-01-30 15:26:21 +00:00
Matthew Jacobson
c006df375a
Alerting: Create endpoints for exporting in provisioning file format (#58623)
This adds provisioning endpoints for downloading alert rules and alert rule groups in a 
format that is compatible with file provisioning. Each endpoint supports both json and 
yaml response types via Accept header as well as a query parameter 
download=true/false that will set Content-Disposition to recommend initiating a download 
or inline display.

This also makes some package changes to keep structs with potential to drift closer 
together. Eventually, other alerting file structs should also move into this new file 
package, but the rest require some refactoring that is out of scope for this PR.
2023-01-27 11:39:16 -05:00
Armand Grillet
f0a88e0609
Add SQLite performance limitation with alerting (#62296) 2023-01-27 14:22:47 +01:00
brendamuir
a273c232a1
Alerting: fix default template link (#62251) 2023-01-26 17:45:09 +00:00
Armand Grillet
95f052bbd1
Add handleGrafanaManagedAlerts jsonData (#61874)
* Add handleGrafanaManagedAlerts jsonData

* Update following feedback
2023-01-26 10:48:51 +01:00
Sonia Aguilar
dbdd135298
Alerting: Fix recording rules showing alert notification information. (#61988)
* Fix recording rules form steps not showing alert information

* Fix docs about creating cloud and recording rules

* Update docs with suggested changes
2023-01-25 08:26:51 +00:00
Armand Grillet
a960b55a99
Update link to provisioning docs (#61840)
Update links to provisioning docs
2023-01-20 12:55:27 +01:00
George Robinson
d4256b352d
Docs: Rename Message templates to Notification templates (#59477)
This commit renames "Message templates" to "Notification templates"
in the user interface as it suggests that these templates cannot
be used to template anything other than the message. However, message
templates are much more general and can be used to template other fields
too such as the subject of an email, or the title of a Slack message.
2023-01-18 17:26:34 +00:00
Alex Moreno
be72e570cf
Fix documentation for notification policy object_matchers (#61602)
* Fix documentation

* Fix grammar

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: George Robinson <george.robinson@grafana.com>

Co-authored-by: George Robinson <george.robinson@grafana.com>
2023-01-17 11:37:56 +01:00
gotjosh
8f72893076
Alerting: Document not supporting inhibition rules (#61313)
* Alerting: Document not supporting inhibition rules

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

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

* Update docs/sources/alerting/manage-notifications/alertmanager.md

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

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-01-13 15:06:06 +01:00
Ryan Cole
37a0afe136
Docs: Fix links to default_template.go in alert template reference file (#61340)
Docs: Fix links to `default_template.go` alert template reference file
2023-01-13 11:32:45 +00:00
George Robinson
fa9f1c3a52
Docs: Re-order nav for Manage your alert notifications (#60897) 2023-01-11 08:44:01 +00:00
Alex Moreno
3db08d4e36
Add object_matchers example (#61235)
* Add object_matchers example

* Use better terminology
2023-01-11 09:43:42 +01:00
George Robinson
35ad9e23ce
Docs: Update weights for Customize notifications without changing the order of pages (#60898) 2023-01-10 11:07:00 +00:00
melGL
fc91baa2f8
Alerting Docs: Clarify feature flag for Grafana Cloud users (#57637)
Docs: Clarify feature flag for Grafana Cloud

Images in Alerts requires a feature flag for hosted Grafana instances. This change directs users to contact Support for access to this feature.
2023-01-04 10:57:58 +00:00
Karen Germond
53d3a810dd
Fix https://github.com/grafana/grafana/issues/60772 -- typo in alerting-rules-edit-mimir-loki-namespace-group (#60796)
Fix https://github.com/grafana/grafana/issues/60772
2022-12-29 07:03:58 -06:00
George Robinson
1a442de094
Docs: Rephrase opening sentence for Customize notifications (#60560) 2022-12-21 10:51:02 +00:00
Christopher Moyer
3d8890453f
docs: corrects broken links (#60594)
correct broken links
2022-12-21 08:44:23 +00:00
Santiago
d070032065
Alerting: Fix incorrect links/aliases to template docs (#60597) 2022-12-20 22:38:01 +01:00
brendamuir
620cc52863
Fixes Alertmanager links (#60591) 2022-12-20 17:09:34 +00:00
George Robinson
5d4e35c3d5
Docs: Fix links in Using Go's templating language (#60564) 2022-12-20 12:30:43 +00:00
George Robinson
d7b555c405
Docs: Remove old message templates documentation (#60548) 2022-12-20 08:23:42 +00:00
George Robinson
f6aea16894
Docs: Templating notifications (#60109)
* Docs: Templating notifications

* Feedback

* More feedback

* Edit template notifications

* More edits

* Fix typo

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Armand Grillet <2117580+armandgrillet@users.noreply.github.com>
2022-12-19 15:01:18 +00:00
Armand Grillet
9941dfc2b6
Update the Alerting HA docs (#60292)
* Update the Alerting HA docs

* 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/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 HA introduction paragraph

* Apply prettier

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2022-12-19 11:49:42 +01:00
George Robinson
342b0f3668
Alerting: Rename contact point type to receiver in the user interface (#59589)
This commit renames contact point type to integration in the user interface
as "New contact point type" suggests that you are creating a new type,
when instead you are just creating a new integration of a pre-determined type,
such as email or Slack. You can also have two or more integrations of the same
type, something which is not apparent from the current text.

This change will also make it easier to explain the difference between
a contact point integration, and how to configure an integration of a certain type,
such as email.
2022-12-14 20:50:36 +00:00
Jack Baldry
c1c48dd610
Use relative aliases for all non-current Grafana aliases (#60062)
* Use relative aliases for all non-current Grafana aliases

Prevents non-latest documentation "stealing" the page away from latest
and through permanent redirects for latest pages that no longer exist.

The redirected pages are indexed by search engines but our robots.txt
forbids them crawling the non-latest page.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Remove aliases from shared pages

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Rewrite all current latest aliases to be next

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix typo in latest alias

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Remove all current page aliases

find docs/sources -type f -name '*.md' -exec sed -z -i 's#\n *- /docs/grafana/next/[^\n]*\n#\n#' {} \;
find docs/sources -type f -name '*.md' -exec sed -Ez -i 's#\n((aliases:\n *-)|aliases:\n)#\n\2#' {} \;

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Prettier

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-12-09 12:36:04 -04:00
Armand Grillet
64ccbf0a98
Update docs regarding Grafana as an alert receiver (#59938)
* Update docs regarding Grafana as an alert receiver

* Add link to AM docs
2022-12-08 17:31:59 +01:00
brendamuir
5c9d1a4706
Delete broken links in notifications doc (#59785)
* Delete broken links in notifications doc

* changes descendents to children

* deletes broken alertmanager link
2022-12-05 12:53:14 +01:00
George Robinson
311e1e56f2
Docs: Reference Alertmanagers in Notifications docs and move Alertmanager docs (#59673) 2022-12-02 09:41:01 +00:00
George Robinson
4073d044c1
Docs: Consolidate Templating labels and annotations docs into a single page (#59685) 2022-12-02 09:40:48 +00:00
George Robinson
8ed2426e8e
Docs: Improve documentation for notifications (#59504) 2022-12-01 09:57:45 +00:00
George Robinson
c8c1499cd0
Docs: Add docs for labels with dots (#59352) 2022-11-29 13:15:48 +00:00
George Robinson
0af3515e95
Docs: Improve docs for images in notifications (#59033) 2022-11-28 14:11:00 +00:00
George Robinson
e7316ff13f
Docs: Improve Labels and annotations docs (#59325)
This commit makes a number of changes to the docs for Labels and
annotations.

 1. It changes the order in which Labels and annotations are mentioned
    from Annotations and labels to Labels and annotations as this is
    the order shown in the UI when creating and editing alert rules.
    It is also the order in the Prometheus documentation.

 2. It changes most of the documentation explaining what labels and
    annotations are and the differences between them. It also adds
    some paragraphs on Custom Labels.
2022-11-28 14:09:02 +00:00
brendamuir
6c6103d573
Docs: adds workaround for editing provisioned rules using the HTTP API (#59094)
* Docs: adds workaround for editing provisioned rules using api

* updates text

* updates text take two
2022-11-22 11:46:48 +00:00
Sonia Aguilar
082c8ba7a0
Docs: Add step for custom labels in alert form (#59027) 2022-11-22 11:35:54 +01:00
George Robinson
2f878acd9d
Alerting: Add Troubleshooting to Images in notifications docs (#58955) 2022-11-21 11:21:59 +00:00
Sonia Aguilar
97bf3c1dca
Alerting: Move alert rule name to the top left in alert form (#58579)
* Move alert rule name to the top left in alert form, and add a placeholder

* Update docs

* Fix lint error
2022-11-21 09:11:02 +01:00
George Robinson
4da97aef7d
Alerting: Fix metric in Images in Notifications docs (#58954) 2022-11-18 16:28:00 +00:00
Alex Pakalniskis
0e4108f62f
Documentation Update: Minor spelling change (#58933)
chore: minor grammar tweak
2022-11-18 11:34:25 +01:00
Labesse Kévin
c3fef96ee0
docs: code format (#58216) 2022-11-14 10:35:44 +01:00
gotjosh
d748979048
Alerting: Implement the Webex notifier (#58480)
* Alerting: Implement the Webex notifier

Closes https://github.com/grafana/grafana/issues/11750

Signed-off-by: gotjosh <josue.abreu@gmail.com>
2022-11-11 17:27:13 +00:00
Daniel Lee
891ae91c70
docs: fix typo in provisioning docs (#58110)
Fix typo

Co-authored-by: Udlei Nati <udlei@nati.biz>
2022-11-11 12:30:26 +01:00
brendamuir
bd6ac793a0
Docs: adds explore content for alerting (#58573) 2022-11-10 12:35:24 +00:00
brendamuir
f1b6660b54
Docs: fixes alias (#58060)
* Docs: fixes alias

* adds file ext
2022-11-02 17:00:26 -04:00
brendamuir
f34dd29ac4
Docs: adds view notification errors topic (#57820) 2022-10-28 12:44:23 +01:00