Commit Graph

547 Commits

Author SHA1 Message Date
brendamuir 4d2570ad72
Docs: updates time ranges and alert rule doc (#66760) 2023-04-20 13:14:19 +02:00
Alex Moreno f64a89727e
Alerting: Allow provenance disable in alerting provisioning API (#63650)
* Allow provenance None in alert rule update and rule group replace

* Allow provenance None in contact point update

* Allow updating policies to none by sending x-disable-provenance header

* Allow mute timings to disable provenance with x-disable-provenance header

* Allow disabling provenance by using x-disable-provenance header

* Add provenance helper to lower the cyclomatic complexity

* Do not downgrade provenance except un ReplaceRuleGroup

* Add function explanation and change error handling

* Add docs for x-disable-provenance changes (#66300)

* Add docs for x-disable-provenance changes

* Apply suggestions from code review

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

* Update _index.md

---------

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/_index.md

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

* Add error message check in tests

* Change docs

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: George Robinson <george.robinson@grafana.com>
2023-04-18 15:10:36 +02:00
brendamuir 9fad5d938d
Docs: removes alerting video blurb version (#66748) 2023-04-18 13:09:08 +02:00
Sébastien Dauphin 58e3b3a90e
Update index.md (#66698)
The useful links were down as they were using /docs/grafana/next/ instead of /docs/grafana/latest/ in the path
2023-04-18 08:11:54 +02:00
Santiago a113d94bbb
Docs: Un-draft 'Configure Integrations' docs (#66699)
* Docs: Un-draft 'Configure Integrations' docs

* fix typo
2023-04-18 08:01:52 +02:00
Isabel 1b46d2f5bd
docs: nav update notes for videos (#66506)
* nav related notes for videos

* wording edit

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* wording edits

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

---------

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
2023-04-13 14:34:56 -04:00
brendamuir a164b794ce
Docs: updates to error handling (#65599)
* Docs: updates to error handling

* ran prettier
2023-04-11 09:08:55 +02:00
Simon Crute a39190b613
Docs: Add the index function 2023-04-05 15:49:57 +03:00
Matthew Jacobson b9dc04139a
Alerting: Respect "For" Duration for NoData alerts (#65574)
* Alerting: Respect "For" Duration for NoData alerts

This change modifies `resultNoData` to be more inline with the logic of the other state handlers.

The main effects of this are:

1) NoData states with NoDataState config set to Alerting will respect "For" duration.
2) Prevents zero value in StartsAt and EndsAt for alerts that have only even been in normal state. This includes state transitions from NoDataState=OK and ExecErrState=OK.
3) Better state transition logging.
2023-03-31 19:05:15 +03:00
Ashley Harrison e39c3b76dd
Navigation: Rename Alerts & incidents to Alerts & IRM (#65635)
update Alerts & incidents to Alerts & IRM
2023-03-31 09:40:06 +01:00
brendamuir c77aa11545
Docs: updates type to integration (#65591)
* Docs: updates type to integration

* fixes link

* fixes links
2023-03-30 10:23:06 +02:00
Santiago 7b92849508
Alerting: Add CustomDetails field in PagerDuty contact point (#64860)
* Alerting: Add CustomDetails for PagerDuty

* fix default value for 'severity' from 'error' to 'critical'

* minimal docs for notifiers, specifying config for PagerDuty

* replace notifier -> integration

* replace notifier -> integration
2023-03-29 10:35:01 -03:00
Isabel a5c5db3e91
docs: nav updates for alerting (#65300)
* navigation related updates - text only

* navigation related updates

* navigation related text updates

* navigation related text updates

* navigation related text and image updates
2023-03-23 13:26:16 -07:00
annelaurefroment 7b7e417629
Updating documentation on alerting HA (#65064) 2023-03-23 11:34:38 +00:00
Martin Beentjes 0464aebc8e
Docs: Use correct function in labels and annotations docs (#65032)
Use correct function in labels and annotations docs
2023-03-23 10:10:49 +01:00
brendamuir e243db6e6b
Docs: fixes intro title (#65174)
fixes intro title
2023-03-22 12:53:40 +01:00
brendamuir 89c65e22d3
Docs: fix numbering and rename topic (#65093)
* Docs: fix numbering and rename topic

* fixes typo

* removes full stops

* deletes :
2023-03-21 13:37:00 +01:00
Jack Baldry ebb54aea8d
Fix website build errors both for Grafana and content mounted in Grafana Cloud (#64794)
* Fix reference to Grafana CLI

- Make relref for relative permalink
- Use relative path for unambiguous resolution

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

* Fix alerting relref anchor format

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

* Avoid ambiguous relref lookups by forcing relative resolution

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

* Remove reference to non-existent shared page

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

* Fix links broken in Grafana Cloud using absolute relrefs

By resolving the relref absolutely, it refers to the same location
regardless of mounted directory.

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

* Remove trailing slash for bundle independent resolution

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

* Fix typo

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

* For now, avoid Hugo checking cross repository /docs/grafana-cloud link

The path is unlikely to change in the short term and this makes CI
completely green for now.

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

* No need to specify path for in page anchors

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

* Fix prose

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-03-15 17:06:31 +00:00
Jack Baldry 72e50431df
Update page labels to better reflect contents (#64606)
* Set correct products labels on Grafana Cloud and Enterprise pages

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

* Add cloud label to all alerting docs

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-03-10 17:23:03 +00:00
George Robinson 1898e76dd6
Docs: Last iteration on docs for images in notifications (#64392)
This commit includes some minor rephrasing to the Requirements and
Limitations of the Images in notification feature.
2023-03-09 09:59:25 +00:00
brendamuir 14208c4c42
Docs: Updates default template link (#64485)
Updates default template link
2023-03-09 09:18:36 +01:00
Gilles De Mey 6827f97b78
Docs: update the current documentation on notification policies (#64316)
Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
2023-03-08 17:18:17 +01:00
George Robinson 9d9421154e
Docs: Update Images in notifications docs to be more readable and instructive (#64227) 2023-03-07 10:52:33 +00:00
Matt Dodson 0099b23291
Docs, update for american English spelling (#63331)
Docs, update for american english
2023-03-06 06:39:56 -06:00
George Robinson fed59b1d43
Docs: Meta-monitoring docs for Grafana and Mimir (#63752)
* Docs: (WIP) Meta-monitoring docs for Grafana and Mimir

* Update metrics for Grafana Managed Alerts

* Fix spelling mistake

* Add docs for Alertamanager, including high-availability mode

* Comment undefined metrics

---------

Co-authored-by: Armand Grillet <2117580+armandgrillet@users.noreply.github.com>
2023-03-03 15:34:02 +01:00
George Robinson c9497dc533
Docs: Improved docs for templating labels and annotations (#63539) 2023-02-23 08:51:46 +00:00
George Robinson 18fec707fd
Docs: Fix numbering in templating docs (#63577) 2023-02-22 17:36:00 +00:00
George Robinson 740bcf64ce
Docs: Delete old templating notifications docs page (#63547) 2023-02-22 10:12:29 +00:00
George Robinson 85457156e3
Docs: Remove duplicate docs on images in notifications (#63474) 2023-02-20 12:58:04 -05:00
George Robinson 0e9201c522
Docs: Uploading images from disk supported in Slack (#63443) 2023-02-20 17:39:10 +00:00
George Robinson 92248fe977
Docs: Upload images from disk supported in Telegram (#63442) 2023-02-20 18:33:19 +01:00
George Robinson 005f5ca1df
Alerting: Fix confusing comment about screenshots in default.ini and docs (#63346) 2023-02-20 09:59:45 +00:00
Santiago f43993d43f
Docs: Fix redaction error in notification policies docs (#63112)
fix redaction error in notification policies docs
2023-02-08 16:18:49 -03:00
Sonia Aguilar 46cbcc813b
Alerting: Fix default_template.go link in docs (#62885)
Fix default_template.go link in docs
2023-02-03 17:27:13 +01:00
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
Armand Grillet 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
brendamuir 1d53a6f57e
Docs: Change GA to Alerting (#57811)
* Docs: Change GA to Alerting

* typos
2022-10-28 10:28:02 +01:00
brendamuir 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
brendamuir f9d2801249
Docs: alerting refactor (#57804)
* Docs: alerting refactor

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

* performance limitations

* typo

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

* adds hover over error icon detail
2022-10-27 11:19:03 +01:00
brendamuir 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
Armand Grillet 42871fcb2a
Clarify notification policies. (#57465) 2022-10-24 09:46:04 +01:00
brendamuir af17123b5f
Docs: fixes silences typo (#57418) 2022-10-21 12:48:33 +01:00
brendamuir ee6ff18122
Docs: fixes endpoint for mimir (#57330) 2022-10-20 09:39:19 +01:00
brendamuir b7feb34acf
Fix broken relrefs (#57092)
* Fixes relrefs

* Fixes more relrefs
2022-10-17 08:54:00 -07:00
brendamuir ecc252429e
Docs alerting: copy edit terraform provisioning (#55978) (#57068) 2022-10-17 11:48:39 +02:00
Christopher Moyer 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
brendamuir d6fa12c5bc
Docs: updates numbering (#56695)
* Docs: updates numbering

* removes full stop
2022-10-11 12:58:15 +01:00
brendamuir 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
brendamuir 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
brendamuir db68fa358f
Docs: removes duplicate sentence in silences (#56629) 2022-10-10 06:56:21 -04:00
brendamuir 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
brendamuir 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
Yuriy Tseretyan 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
brendamuir 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
brendamuir 43dc92d12c
fix index file for website (#55907) 2022-09-28 13:06:38 +02:00
brendamuir 4ba757e7b8
Update Alerting provisioning docs (#55892) 2022-09-28 11:03:36 +02:00
brendamuir 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
Vladimir 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
Martin Lehmann 85c26ea908
Alerting: Fix a typo in alerting rule annotation docs (#55730) 2022-09-27 10:56:22 +01:00
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