376 Commits

Author SHA1 Message Date
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
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
082c8ba7a0 Docs: Add step for custom labels in alert form (#59027) 2022-11-22 11:35:54 +01:00
2f878acd9d Alerting: Add Troubleshooting to Images in notifications docs (#58955) 2022-11-21 11:21:59 +00:00
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
4da97aef7d Alerting: Fix metric in Images in Notifications docs (#58954) 2022-11-18 16:28:00 +00:00
0e4108f62f Documentation Update: Minor spelling change (#58933)
chore: minor grammar tweak
2022-11-18 11:34:25 +01:00
c3fef96ee0 docs: code format (#58216) 2022-11-14 10:35:44 +01:00
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
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
bd6ac793a0 Docs: adds explore content for alerting (#58573) 2022-11-10 12:35:24 +00:00
f1b6660b54 Docs: fixes alias (#58060)
* Docs: fixes alias

* adds file ext
2022-11-02 17:00:26 -04:00
f34dd29ac4 Docs: adds view notification errors topic (#57820) 2022-10-28 12:44:23 +01:00
ee7adc081b Remove Sensu from docs (#57812)
We do not support Sensu in Grafana Alerting, only Sensu Go.
2022-10-28 12:40:46 +01:00
1d53a6f57e Docs: Change GA to Alerting (#57811)
* Docs: Change GA to Alerting

* typos
2022-10-28 10:28:02 +01:00
5edd511461 Docs: fixes alerting links (#57805)
* Docs: fixes alerting links

* fixes grafana relrefs to alerting

* changing GA to Alerting
2022-10-28 10:01:43 +01:00
f9d2801249 Docs: alerting refactor (#57804)
* Docs: alerting refactor

* fixes broken relrefs
2022-10-28 09:58:39 +02:00
998093a280 Docs: more refactoring for alerting (#57741)
* docs: more refactoring alerting

* performance limitations

* typo

* fix relrefs
2022-10-27 13:21:02 +01:00
279ac50d59 Docs: refactors notifications in alerting (#57734)
* Refactors noticifacations section

* adds hover over error icon detail
2022-10-27 11:19:03 +01:00
596b4fecb0 Docs: Refactors notifications in alerting (#57653)
* Refactors notifications in alerting

* Fixes broken links

* adds headings

* fixes broken links

* Adds line space and intro sentences
2022-10-26 19:07:49 +01:00
42871fcb2a Clarify notification policies. (#57465) 2022-10-24 09:46:04 +01:00
af17123b5f Docs: fixes silences typo (#57418) 2022-10-21 12:48:33 +01:00
ee6ff18122 Docs: fixes endpoint for mimir (#57330) 2022-10-20 09:39:19 +01:00
b7feb34acf Fix broken relrefs (#57092)
* Fixes relrefs

* Fixes more relrefs
2022-10-17 08:54:00 -07:00
ecc252429e Docs alerting: copy edit terraform provisioning (#55978) (#57068) 2022-10-17 11:48:39 +02:00
414d536186 Docs: refactors config panels and visualizations, corrects relrefs (#55940)
* refactors config panels and visualizations, corrects relrefs

* adds an alias

* Remove some old content

* moves visualizations topic to the root

* moves out panels and visualization topics to the root

* adds move and resize panel to add/organize panel; creates a create dashboard topic under build dashboards; adjusts context of add a panel to be from within an existing dashboard

* updates aliases

* creates search at root, moves dashboard preview to search, creates standalone search dashboard topic

* moves Set dashboard time range to use-dashboards, creates modify dashboard settings and adds moves Modify dashboard time settings to that topic

* moves existing query-options topic from working with panels to configure-panel-visualizations, moves panel time overrides and timeshift content to query options

* Moving things to better category, fixing links, improving ordering

* Move panel inspector to main panel topic

* completes partial fix of relrefs

* relref fixes con't

* restructures remaining panels topics

* more relref fixes

* Minor fix

* Minor tweak

* finishes fixing relrefs

Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2022-10-11 15:31:20 -05:00
d6fa12c5bc Docs: updates numbering (#56695)
* Docs: updates numbering

* removes full stop
2022-10-11 12:58:15 +01:00
8a3294dcdf Docs: adds external Alertmanager config (#56636)
* Docs: adds external Alertmanager config

* Adds link to add external alertmanager

* updating with george feedbacj
2022-10-11 11:29:11 +01:00
137d332d4f Docs: deletes provisioning from grafana and adds link (#56637)
* Docs: deletes provisioning from grafana and adds link

* updates link
2022-10-10 13:30:23 +01:00
db68fa358f Docs: removes duplicate sentence in silences (#56629) 2022-10-10 06:56:21 -04:00
a84edb274b Docs: changes alert groupings to groups (#56617)
* Docs: changes alert groupings to groups

* One more alert grouping
2022-10-10 12:41:14 +02:00
939caa67a2 Docs: adds alertmanager overview (#56527)
* Docs: adds alertmanager overview

* updating with georges feedback

* adds deprecation note to API docs

* update to provisioning instuctions
2022-10-07 10:26:51 +01:00
1e16dd5b7c Docs: Update Grafana Alerting migration article to mention paused alert rules (#55590)
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2022-10-03 09:45:09 -04:00
ebdc13ed86 Docs alerting: copy edit terraform provisioning (#55978)
* Docs alerting: copy edit terraform provisioning

* changes intro sentence for explore
2022-09-29 10:19:16 +02:00
43dc92d12c fix index file for website (#55907) 2022-09-28 13:06:38 +02:00
4ba757e7b8 Update Alerting provisioning docs (#55892) 2022-09-28 11:03:36 +02:00
b7f356df31 Docs: adds terraform provisioning docs (#55660)
* Docs: adds set up section and alertmanager

* deletes info that got copied to new file
2022-09-28 09:18:46 +01:00
efef672d19 Documentation: clarify label matching (#55650)
* Documentation: clarify label matching

Behaviour in case of multiple matchers is not documented, but my experiments show they are reduced using logical AND. Please validate the updated description.

* Accept wording suggestion

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

* Accept suggestion for docs/sources/alerting/fundamentals/annotation-label/labels-and-label-matchers.md

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

* Improve wording according to review suggestions

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2022-09-28 09:06:04 +01:00
85c26ea908 Alerting: Fix a typo in alerting rule annotation docs (#55730) 2022-09-27 10:56:22 +01:00
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
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
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
a0cbe548fe replace relrefs with URLs (#53686) 2022-08-12 13:10:07 -07:00
8fa6489dd4 Docs: fix data source MSSQL link (#52796) 2022-07-26 13:31:29 +02:00
23fc5383d9 Docs: Update docs for images in notifications (#52721) 2022-07-26 10:09:48 +01:00
9c3f9887fc Updated pushover in Supported notifiers (#52631)
Pushover supports images in notifications since v9.0.2
2022-07-25 17:01:21 +00:00
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
cf42365fdd Docs: minor corrections to prefix and naming (#52579) 2022-07-21 12:09:25 +01:00
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