Commit Graph

455 Commits

Author SHA1 Message Date
Grot (@grafanabot) 6db244abb8 [v9.5.x] Docs: adds legacy topics (#69941)
Docs: adds legacy topics (#69898)

* adds legacy topics

* moves legacy and adds deprecation note

* Merge branch 'alerting-docs-support-escalations' of https://github.com/grafana/grafana into alerting-docs-support-escalations

* adds description

* fixes relrefs

* removes relrefs

* removes relrefs

* fixes links

* Adds description frontmatter

* fixing typo

* adds frontmatter

* fix spelling error

(cherry picked from commit be196a4ad0)

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-06-13 06:45:37 +00:00
Grot (@grafanabot) a1d66bf368 [v9.5.x] Update cascading front matter to use sequence form (#69380)
* Update cascading front matter to use sequence form (#67094)

* Update cascading front matter to use sequence form

The map form does not override the sequence form that is used in the website repository to specify the default labels.
For more information, refer to https://github.com/grafana/writers-toolkit/pull/234.

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

* Remove useless alias

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

* Update labels for pages noted in code review

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

* Move all product labeling to the project index file

All changes can be made in a single place.

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

* Move all individual page product labels to project index file

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

* Shorten YAML

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

* Add newlines to aid readability

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

* Document front matter ordering

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

* Rewrite labels for breaking-changes pages

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

* updated labels for whats new and breaking changes

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
(cherry picked from commit f29b058927)

* Remove breaking changes section that is not in this version of the docs

Could be confusing to readers.

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

* Remove changes that do not relate to this version

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2023-06-01 15:00:04 +01:00
Jack Baldry e4fb61b854 Revert "[v9.5.x] Update cascading front matter to use sequence form" (#69378)
Revert "[v9.5.x] Update cascading front matter to use sequence form (#69327)"

This reverts commit 0f9f72d46b.
2023-06-01 09:48:47 -04:00
Grot (@grafanabot) 0f9f72d46b [v9.5.x] Update cascading front matter to use sequence form (#69327)
* Update cascading front matter to use sequence form (#67094)

* Update cascading front matter to use sequence form

The map form does not override the sequence form that is used in the website repository to specify the default labels.
For more information, refer to https://github.com/grafana/writers-toolkit/pull/234.

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

* Remove useless alias

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

* Update labels for pages noted in code review

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

* Move all product labeling to the project index file

All changes can be made in a single place.

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

* Move all individual page product labels to project index file

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

* Shorten YAML

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

* Add newlines to aid readability

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

* Document front matter ordering

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

* Rewrite labels for breaking-changes pages

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

* updated labels for whats new and breaking changes

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
(cherry picked from commit f29b058927)

* Remove confusing target

This target does not exist in this version.

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-06-01 10:55:35 +01:00
Grot (@grafanabot) 16f3df46f2 [v9.5.x] Docs: Add JSON format for webhook notifications to differences (#69055)
Docs: Add JSON format for webhook notifications to differences (#68786)

(cherry picked from commit 65e2df7a2e)

Co-authored-by: George Robinson <george.robinson@grafana.com>
2023-05-25 10:15:46 +01:00
Jack Baldry 99359710ab Revert "[v9.5.x] [feat] docs; update admonition syntax" (#68989)
Revert "[v9.5.x] [feat] docs; update admonition syntax (#68856)"

This reverts commit 08ea5c94c6.

I believe that because of automatic conflict resolution, this backport PR contained a number of extra changes that were not part of the update to use admonition syntax.

I'm first going to revert this PR to prevent the confusing behavior in PRs like #68832.

If we still want admonition changes backported, we can open a new PR which I would like to be a reviewer on to double check.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-05-24 14:55:04 +01:00
Grot (@grafanabot) 08ea5c94c6 [v9.5.x] [feat] docs; update admonition syntax (#68856)
[feat] docs; update admonition syntax (#68842)

* [feat] docs; update admonition syntax

- Standardizes according to style conventions: https://grafana.com/docs/writers-toolkit/style-guide/style-conventions/#admonitions
- Prepares docs for better, uniform admonition style.

* Remove false positives and irregularities

* false positive removal

* Update docs/sources/datasources/mysql/_index.md

* Update docs/sources/developers/angular_deprecation/angular-plugins.md

* fix link errors

* Prettify some nested blockquotes

* remoe unnecessary admonition

(cherry picked from commit 1c4bb9ca00)

Co-authored-by: Matt Dodson <47385188+MattDodsonEnglish@users.noreply.github.com>
2023-05-23 07:46:35 -05:00
Grot (@grafanabot) a0f253c62b [v9.5.x] docs: add legacy alerting deprecation notice (#68354)
docs: add legacy alerting deprecation notice (#68292)

Co-authored-by: Armand Grillet <2117580+armandgrillet@users.noreply.github.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
(cherry picked from commit 4310f574db)

Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com>
2023-05-12 11:41:30 +00:00
Grot (@grafanabot) 58c9a64e88 [v9.5.x] Docs: Fix broken link for no data and error handling (#67653)
Docs: Fix broken link for no data and error handling (#67617)

Fix broken link for no data and error handling

(cherry picked from commit 1013a3e253)

Co-authored-by: Alfredo <109958902+alfredo-d@users.noreply.github.com>
2023-05-02 19:06:54 +00:00
Grot (@grafanabot) 5bb4a9c89f [v9.5.x] Docs: updates time ranges and alert rule doc (#66945)
Docs: updates time ranges and alert rule doc (#66760)

(cherry picked from commit 4d2570ad72)

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-04-20 14:19:56 +03:00
Grot (@grafanabot) 3fb37e26b5 [v9.5.x] Alerting: Allow provenance disable in alerting provisioning API (#66761)
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>
(cherry picked from commit f64a89727e)

Co-authored-by: Alex Moreno <alexander.moreno@grafana.com>
2023-04-18 15:34:44 +02:00
Grot (@grafanabot) 9afddd77bd [v9.5.x] Update index.md (#66718)
Update index.md (#66698)

The useful links were down as they were using /docs/grafana/next/ instead of /docs/grafana/latest/ in the path

(cherry picked from commit 58e3b3a90e)

Co-authored-by: Sébastien Dauphin <dauphin.sebastien@gmail.com>
2023-04-18 14:02:08 +02:00
Grot (@grafanabot) bd63388bc5 [v9.5.x] Docs: Un-draft 'Configure Integrations' docs (#66715)
Docs: Un-draft 'Configure Integrations' docs (#66699)

* Docs: Un-draft 'Configure Integrations' docs

* fix typo

(cherry picked from commit a113d94bbb)

Co-authored-by: Santiago <santiagohernandez.1997@gmail.com>
2023-04-18 08:59:57 +02:00
Grot (@grafanabot) 0b9ef6d3f4 [v9.5.x] docs: nav update notes for videos (#66519)
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>
(cherry picked from commit 1b46d2f5bd)

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-04-13 14:57:27 -04:00
Grot (@grafanabot) 8f9edf19a3 [v9.5.x] Docs: Add example to extract a specific label value (#66360)
Docs: Add the index function

(cherry picked from commit a39190b613)

Co-authored-by: Simon Crute <simonc6372@users.noreply.github.com>
2023-04-12 14:39:33 +02:00
Grot (@grafanabot) 7159c79069 [v9.5.x] Docs: updates to error handling (#66236)
Docs: updates to error handling (#65599)

* Docs: updates to error handling

* ran prettier

(cherry picked from commit a164b794ce)

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-04-11 09:21:03 +02: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