Commit Graph

337 Commits

Author SHA1 Message Date
brendamuir
c0c4409abc
Docs: adds set up section with alertmanager, provisioning sections (#55291)
* Docs: adding setup, provisioning docs

* add set up, alertmanager

* Adds link to provisioning from set up page

* renames topics in set up section

* fixes alertmanager link

* removing article for alertmanager

* first connection to oncall

* updating armands intro text

* getting rid of blank line
2022-09-16 17:22:20 +01:00
brendamuir
ab774b47fb
Docs: create new explore page for concepts (#55161)
* Docs: create new explore page for concepts

* Updates weighting of explore section to appear at top

* Weight for fundamentals page
2022-09-14 12:16:59 +01:00
Matthew Jacobson
940d18ad57
Alerting: Sanitize invalid label/annotation names for external alertmanagers (#54537)
* Alerting: Sanitize invalid label/annotation names for external alertmanagers

Grafana's built-in Alertmanager supports both Unicode label keys and values; however, if using an external
Prometheus Alertmanager label keys must be compatible with their data model.
This means label keys must only contain ASCII letters, numbers, as well as underscores and match the regex
`[a-zA-Z_][a-zA-Z0-9_]*`.

Any invalid characters will now be removed or replaced by the Grafana alerting engine before being sent to
the external Alertmanager according to the following rules:

- `Whitespace` will be removed.
- `ASCII characters` will be replaced with `_`.
- `All other characters` will be replaced with their lower-case hex representation.

* Prefix hex replacements with `0x`

* Refactor for clarity

* Apply suggestions from code review

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

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2022-09-07 11:39:39 -04:00
ceh
ad501e770f
Docs: Fix minor typo (#53590) 2022-08-22 18:26:52 +02:00
Eve Meelan
a0cbe548fe
replace relrefs with URLs (#53686) 2022-08-12 13:10:07 -07:00
brendamuir
8fa6489dd4
Docs: fix data source MSSQL link (#52796) 2022-07-26 13:31:29 +02:00
George Robinson
23fc5383d9
Docs: Update docs for images in notifications (#52721) 2022-07-26 10:09:48 +01:00
Robin Tönniges
9c3f9887fc
Updated pushover in Supported notifiers (#52631)
Pushover supports images in notifications since v9.0.2
2022-07-25 17:01:21 +00:00
Med Amine Amara
4d2f2b88b6
docs(alerting): removed a repetition of a word (#52376)
removed a repetition of a word in doc
2022-07-25 16:38:50 +02:00
brendamuir
cf42365fdd
Docs: minor corrections to prefix and naming (#52579) 2022-07-21 12:09:25 +01:00
sunb3am
9a72ebcd99
Docs: Updated links to landing pages for the notifiers (#51875)
* Documentation: Updated links to landing pages for the respective notifiers in alerting 

Updated links for listed notifiers to correctly redirect to their landing pages

* Ran prettier
2022-07-19 04:13:51 +02:00
brendamuir
076851313d
Docs: fixes warning for enterprise customers (#52385)
* Docs: fixes data source links

* fixes unified alerting redirect

* Docs: fixes enterprise customer warning
2022-07-18 12:09:29 +02:00
Christopher Moyer
6177e433ff
updates broken relrefs, removes unneeded file (#52292) 2022-07-14 15:54:09 -07:00
brendamuir
07e03666ad
Docs: fixes data source links (#52196)
* Docs: fixes data source links

* fixes unified alerting redirect
2022-07-14 08:24:53 +01:00
Yuriy Tseretyan
f4606faec2
fix docs with correct instructions to create a silence URL (#52062) 2022-07-12 11:36:01 -04:00
Matthew Jacobson
28dd413c1d
Alerting: Add config disabled_labels to disable reserved labels (#51832)
* Alerting: Add config disabled_labels to disable reserved labels

[unified_alerting.reserved_labels]
disabled_labels

* Replace IsGrafanaFolderDisabled with more generic IsReservedLabelDisabled

* Simplify SchedulerCfg by including UnifiedAlertingSettings
2022-07-11 12:41:40 -04:00
brendamuir
2f41ee7333
Docs: fixes couple of typos (#52031) 2022-07-11 13:04:15 +01:00
Garrett Guillotte
a243dc8713
Fix relrefs in alerting (#51939) 2022-07-08 12:21:56 -07:00
George Robinson
2b2c09b8d5
Docs: Improve docs for differences and limitations (#51905) 2022-07-07 14:49:03 +01:00
George Robinson
ef1fb9d3a3
Docs: Improve docs for images in notifications (#51900) 2022-07-07 14:38:02 +01:00
brendamuir
f6f017edc2
Docs: new data sources topic (#51863)
* Docs: new datasources topic

* Update docs/sources/alerting/fundamentals/data-source-alerting.md

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

* Update docs/sources/alerting/fundamentals/data-source-alerting.md

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

* corrects relrefs

Co-authored-by: George Robinson <george.robinson@grafana.com>
2022-07-07 13:32:00 +01:00
Santiago
93e2a0eddc
fix broken links (#51821) 2022-07-06 12:16:05 -03:00
Santiago
9797744c10
template functions reference and examples moved to corresponding section, description and links fixed (#51654) 2022-07-04 10:38:22 -03:00
brendamuir
64a2c4783f
Docs: adds new alerting diagram (#51638)
* Docs:adds new alerting diagram

* Update docs/sources/alerting/_index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2022-06-30 15:38:17 +01:00
George Robinson
c8fa4a9397
Alerting: Fix documentation for Grafana 9.0 (#51614) 2022-06-30 10:34:08 +01:00
brendamuir
8930bc9042
Docs: new version of landing page for Alerting (#51166)
* Docs: new version of landing page for Alerting

* deletes about topic and adds alias

* Update docs/sources/alerting/_index.md

Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com>

Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com>
2022-06-21 16:21:54 +02:00
George Robinson
624a3240f0
Alerting: Update docs for images in notifications (#50760) 2022-06-21 13:24:48 +02:00
Armand Grillet
9aa440d7d4
Clarify alerting opt-out docs (#51144)
* Clarify alerting opt-out docs

* Update docs/sources/alerting/migrating-alerts/opt-out.md

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

* Update docs/sources/alerting/migrating-alerts/opt-out.md

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

* Update docs/sources/alerting/migrating-alerts/opt-out.md

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

* Update docs/sources/alerting/migrating-alerts/opt-out.md

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

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2022-06-21 04:33:58 -04:00
brendamuir
694fd1c37b
Docs: fixes manage alerting topic (#51100) 2022-06-20 13:24:22 +02:00
Joe Blubaugh
6ffac76520
Alerting: Add Documentation about limits of images in notifications. (#51084)
Because some contact points only support a single image, and the order
of alerts sent to a contact point is not guaranteed, which alert rule's
image is attached to a notification can change from alert to alert. This
documents that behavior.
2022-06-20 14:01:16 +08:00
George Robinson
5736a3c59e
Alerting: Docs on how to template annotations and labels (#51024) 2022-06-17 18:30:33 +01:00
Matthew Jacobson
5dee2ed24c
Alerting: Add first Grafana reserved label grafana_folder (#50262)
* Alerting: Add first Grafana reserved label g_label

g_label holds the title of the folder container the alert. The intention of this label
is to use it as part of the new default notification policy groupBy.

* Add nil check on updateRule labels map

* Disable gocyclo lint on schedule.ruleRoutine

will remove later in a separate refactoring PR to reduce complexity.

* Address doc suggestions

* Update g_folder for rules in folder when folder title changes

* Remove global bus in FolderService

* Modify tests to fit new common g_folder label

* Add changelog entry

* Fix merge conflicts

* Switch GrafanaReservedLabelPrefix from `g_` to `grafana_`
2022-06-17 13:10:49 -04:00
brendamuir
033654f93f
Docs: fixes redirect from unified alerting (#51012)
* Docs: fixes redirect from unified alerting

* fixes mimir alerting rule redirect

* fixes mimir alerting rule redirect

* adds slash to redirect
2022-06-17 11:42:36 +02:00
George Robinson
8c01f28285
Docs: How to template annotations and labels (#50972) 2022-06-17 10:37:43 +01:00
Garrett Guillotte
845cebdee2
Docs: Refactor administration docs (#50592)
* Move data source management to administration

* Move RBAC to administration

* Move team management up a docs org level

* Combine and rename admin preferences docs

* Move plugin management to administration

* Combine plugin management docs

* Combine API key docs

* Combine service account docs

* Combine server user management docs

* Move datasource management to administration

* Move enterprise licenses to administration

* Move CLI out of admin, update links to admin

* Merge org user management docs

* Restructure to Torkel's plan

* Fix typo

* Weigh admin topics for navigation

* Weigh administration topics and align to Torkel's plan

* Move server user management from server admin to admin/user management

* Move configure docker image to setup guide

* Move the remaining server admin docs to the root admin directory

* Reweight docker config
2022-06-16 21:09:16 +02:00
brendamuir
7deb7258ba
Docs: adds video content to Grafana Alerting (#50929)
* Docs: adds video content to grafana alerting

* adds create alerts to managed rule page
2022-06-16 16:11:38 +02:00
Jack Baldry
d0808bdafb
Add redirects for indexed alerting pages (#50918)
Co-authored-by: Brenda Muir <brenda.muir@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Co-authored-by: Brenda Muir <brenda.muir@grafana.com>
2022-06-16 10:32:40 +02:00
George Robinson
06da129210
Docs: Add paragraph about rolling back to opt-out (#50583) 2022-06-10 11:19:20 +01:00
brendamuir
c8914ecd8a
Docs: Fixes typos and adds enterprise note (#50564)
* Fixes typos and space errors

* Docs: adds note for enterprise users

* Run yarn prettier:write

Co-authored-by: Armand Grillet <armand.grillet@outlook.com>
2022-06-10 11:27:08 +02:00
brendamuir
7e2870b7bb
Docs: Updates Grafana Alerting upgrade topics (#50533)
* Updates Grafana Alerting upgrade topics

* Run yarn prettier:write

Co-authored-by: Armand Grillet <armand.grillet@outlook.com>
2022-06-09 20:12:41 +02:00
George Robinson
9d537efb48
Docs: Images in Notifications (#50425) 2022-06-09 12:38:20 +02:00
brendamuir
e0e76f0252
Fixes term Grafana Alerting (#50404) 2022-06-08 13:35:37 +02:00
George Robinson
6e3d58d779
Improve docs for values in custom annotations and labels (#50346) 2022-06-08 10:39:21 +01:00
Gilles De Mey
689f349cda
Docs: add note on alerting limitation for being an alert receiver (#50331)
Co-authored-by: gotjosh <josue.abreu@gmail.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2022-06-08 10:42:43 +02:00
Christopher Moyer
a568d421f8
Docs: Setup refactor (#49739)
* builds out refactored setup topics

* Automatically fix some relrefs with mv-manager

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

* Use refs for tutorials content which is outside of this repository

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

* Manually fix complicated relrefs

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

* consolidates team sync and db encryption topics

* Fix relrefs

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

* updates setup index file

* Convert TOML to YAML

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

* Add current alias for new alerting content

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

* Add current aliases to new setup-grafana and configure-security pages

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

* Update docs/sources/setup-grafana/configure-grafana/_index.md

Co-authored-by: Torkel Ödegaard <torkel@grafana.com>

* moves saml docs, updates order in TOC

* Manually fix relrefs

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

* added usage insights topics, adjusted weights

* corrected relrefs

* Fix relrefs broken in rebase

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

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
2022-06-02 11:57:22 -05:00
Joe Blubaugh
8ad1f4f9be
Add a section to the alerting documents for performance considerations (#49663)
This change adds documentation about how the configuration of Grafana
Alerting affects the performance of the Grafana backend, and how to
control the load that Grafana Alerting generates.

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2022-06-02 20:55:45 +08:00
JitaC
1970c9020a
Docs: Update create alerting rules topics (#49764)
* Updated topic on Grafana managed rule.

* Updated loki and mimir rules and recording rules topics

* Checkin changes.

* Fixed typo
2022-05-27 22:29:59 -04:00
JitaC
f5a3ac855d
Docs: Refactor contact points section of alerting docs (#49758)
* Initial commit

* weight adjustments

* Checkin changes.
2022-05-27 13:37:37 -04:00
Christopher Moyer
8c84d62e3d
Docs: combines all SAML topics into one topic (#49443)
* combines all SAML topics

* resolves merge conflicts

* makes prettier
2022-05-27 07:42:51 -05:00
Jack Baldry
b84294dd27
Convert TOML front matter to YAML (#49690)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-05-26 11:06:25 -04:00