Commit Graph

158 Commits

Author SHA1 Message Date
achatterjee-grafana
adbe383456
Update alert doc structure (#34659)
* Restructured and fixed broken relrefs.

* Added relrefs.

* created shared alerts section.
2021-05-25 10:51:28 -04:00
David Parrott
9b518669dd
Alerting WIP update documentation (#34524)
* update alerts index.md

* pr feedback
2021-05-24 20:57:58 +02:00
achatterjee-grafana
1e30a378af
Docs: Added place folder topic and some placeholder topics (#34334)
* Added placehodler topic and beginning of topic about differences.

* Removed content that is creating broken relrefs.

* Update configure-all-fields.md

* links fixed

* Update _index.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2021-05-18 14:33:16 -07:00
Diana Payton
db29a8a8de
Docs: Replace next with latest in aliases (#33054) 2021-04-15 23:08:58 +02:00
Torkel Ödegaard
9873809547
Docs: Sync master docs against next version (#32602)
Co-authored-by: Robby Milo <robbymilo@gmail.com>
2021-04-12 09:42:10 +02:00
Sofia Papagiannaki
ea202513cd
Docs: Rephrase Alert execution section in Alerting (#32631)
* Docs: Rephrase Alert execution section in Alerting

* Small fix

datasources -> data sources

* Rephrase alert execution
2021-04-06 12:58:22 -04:00
Diana Payton
ec624aa1ef
Docs: Add Grafana basics section (#32693)
* moved files

* single sourcing

* Update _index.md

* Update heatmap.md

* Update _index.md

* Update _index.md

* Fixed 7 broken relrefs

* Fixed one more broken relref.

Co-authored-by: achatterjee-grafana <aparajita.chatterjee@grafana.com>
2021-04-05 13:06:14 -07:00
achatterjee-grafana
552c4bf124
Fixed issue 25389 (#32514)
* Updated hyperlink to instructions in Chinese.

* Rearranging content.
2021-03-30 14:06:08 -04:00
Dewald Viljoen
6fa53a1ee4
Alerting: Allow sending notification tags to Opsgenie as extra properties (#30332)
* Alerting: Opsgenie send tags as extra properties

Allow users to select where to send notification tags when alerting via
OpsGenie. Supports sending tags as key/value details, concatenated
strings in tags or both.

Users will be able to see their tags as key/values under extra
properties in an alert on the Opsgenie UI. These key/values can
then be used in the platform for routing, templating etc.

  * Configurable delivery to either tags, extra properties or both

  * Default to current behaviour (tags only)

  * Support both so users can transition from tags to details

Add docs and clean up references

* Alerting: Add additional arg for Opsgenie tests

The NewEvalContext function now requires a 'PluginRequestValidator' argument.
As our test does not use the validator we can specify 'nil' to satisfy the
function and allow our test to pass as expected.

* Alerting: Opsgenie doc fixes

Accept suggested changes for Opsgenie docs

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* Alerting: Opsgenie provisioning settings docs

Add the new setting to the provisioning docs

* Alerting: Opsgenie doc typo correction

Move the comma (,) out of the preformatting tags for the setting value

* Alerting: Opsgenie refactor send switches

Refactor the send switches to be methods on the OpsgenieNotiefier
itself. This also cleans up the method names so that the code reads
a bit more logically as:

if we should send details: send details
if we should send tags: send tags

This avoids the calling code needing to care about passing the state
and allows an engineer working in the `createAlert` function to focus
on the results of applying the logic instead.

* Alerting: Opsgenie docs rename note


Rename the note heading to match the number to more clearly link them.

* Alerting: Opsgenie use standard reference to note

Refer to the note below as per recommendation and standards.

Fixes #30331

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2021-03-24 17:07:26 +01:00
Ottavio M. Hartman
7a9a52c317
Alerting: Enable Alert rule severity tag to override VictorOps Severity setting (#29392)
* add severity to victorops

* Update docs, add test

* Fix spelling and lint

* fix resolving not working

* Update docs/sources/alerting/notifications.md

* Update docs/sources/alerting/notifications.md

* Update docs/sources/alerting/notifications.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* Update docs/sources/alerting/notifications.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* remove table, update supported alert notifiers

* add docs

* 7.4->7.5

* fix

* Update docs/sources/alerting/notifications.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2021-03-18 09:50:07 -04:00
Ivana Huckova
2a2a6a3bfa
Add Loki to list of alerting data sources (#31650) 2021-03-05 11:30:56 +01:00
Labesse Kévin
bd0d051438
Alerting: PagerDuty: adding current state to the payload (#29270)
* adding state to the payload

* fix test

* fix linter

* documentation payload current state

* Apply suggestions from code review

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2021-03-02 17:50:51 +01:00
Suraj Nath
127effc8ab
remove squadcast details from docs (#31413)
squadcast was removed from table in https://github.com/grafana/grafana/pull/23213 but we missed the details paragraph, remove that.
2021-02-23 09:17:40 -05:00
Will Browne
f4e12c1c19
Docs: Fix bad image path for alert notification template (#30911) 2021-02-04 18:11:55 +01:00
Diana Payton
1c4bf2fa48
Docs: Add server view folder (#30849)
* changed weights

* Updated links

* link and weight updates

* Update docs/sources/administration/view-server/view-server-settings.md

Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>

* Update docs/sources/administration/view-server/view-server-stats.md

Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>

* Update docs/sources/administration/view-server/view-server-settings.md

Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>

Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>
2021-02-03 08:25:46 -08:00
Ash Caire
4ed283e7bf
Alerting: Customise OK notification priorities for Pushover notifier (#30169)
* pushover: Customise OK notification priorities

* Apply suggestions from code review

* Fix build failure

Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>

* Update pkg/services/alerting/notifiers/pushover.go

Co-authored-by: Sofia Papagiannaki <papagian@users.noreply.github.com>

* Update docs

* Apply suggestions from code review

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
Co-authored-by: Sofia Papagiannaki <papagian@users.noreply.github.com>
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2021-02-03 10:57:18 +02:00
Will Browne
c9da053e5d
Alerting: Evaluate data templating in alert rule name and message (#29908)
* evaluate Go style template

* inlince func

* add test case

* PR feedback and add tests for templte data map func

* Add test case

Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>

* do regex check

* ensure ecape

* small cleanup

* dont exit on template execution errors

* add info tooltip

* add docs

* switch from go tmpl to regex

* update docs/comments

* update tooltip wording

* update docs wording

* add simple test

* avoid .MustCompile

* point to labels in docs

* update docs

* fix docs links

* remove line

* fix lint

* add note about multiple labels

* propagate labels for CM

* update docs

* remove whitespace

* update task title

* update docs

* pr feedback

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
2021-01-19 22:02:44 +01:00
achatterjee-grafana
1bc0cff736
Share panel dashboard (#30147)
* Checking in changes.

* Change to title.

* More changes.

* More changes, removed share panel and dashboard topics from dashboards folder.

* Check in changes.

* More changes.

* Metadata and title changes.

* Update docs/sources/sharing/share-panel.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/sharing/share-panel.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/sharing/share-panel.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* removed extra space

* Update docs/sources/dashboards/_index.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/sharing/_index.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/sharing/share-dashboard.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* More changes.

* Update docs/sources/sharing/share-dashboard.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* minor change.

* Updated with correct relref link.

* Changes Snapshot to snapshot.

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2021-01-08 16:45:09 -05:00
Diana Payton
97a104598a
Docs: Remove survey (#29549)
* removed the survey code

* Update _index.md
2020-12-09 07:55:50 -08:00
Diana Payton
90081be9b8
Docs: Changed image format (#29658) 2020-12-07 08:42:10 -08:00
Todd Campbell
643f790753
Alerting: Add support for Sensu Go notification channel (#28012)
* Add support for Sensu Go notification channel

Similar to current support for the older "Core" version of
Sensu, this commit add support for the newer version.

Closes #19908

Signed-off-by: Todd Campbell <todd@sensu.io>

* fix linter errors

Signed-off-by: Todd Campbell <todd@sensu.io>

* Apply suggestions from code review

PR review suggestions

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>

* Fix no new variables error

* Replace convey testing with testify

Signed-off-by: Todd Campbell <todd@sensu.io>

* Wording suggestions

Signed-off-by: Todd Campbell <todd@sensu.io>

* Add docker compose environment for testing/maintenance

Signed-off-by: Todd Campbell <todd@sensu.io>

* Renamed and fixed docker-compose.yaml to work in devenv

Signed-off-by: Todd Campbell <todd@sensu.io>

* Change sensugo web UI port to 3080 so as not to conflict with grafana

Signed-off-by: Todd Campbell <todd@sensu.io>

* Apply suggestions from code review

Set the API key as a secure value.

Co-authored-by: Sofia Papagiannaki <papagian@users.noreply.github.com>

* Add Sensu Go information to notifications doc

Signed-off-by: Todd Campbell <todd@sensu.io>

* Update pkg/services/alerting/notifiers/sensugo.go

Co-authored-by: Sofia Papagiannaki <papagian@users.noreply.github.com>

* change assert to require for Error/NoError tests

Signed-off-by: Todd Campbell <todd@sensu.io>

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
Co-authored-by: Sofia Papagiannaki <papagian@users.noreply.github.com>
2020-11-27 19:09:24 +02:00
achatterjee-grafana
445291eb80
Docs: Fixed broken relrefs and chanfed TOC entry name from Alerting to Alerts. (#29251) 2020-11-20 09:30:30 +01:00
Robby Milo
abee02dbcd
Docs: updates for file-based menu (#28500)
* initial

* cleanup

* remove bad aliases

* cleanup, fix links

* add docs-file-based-command

* update docs

* update readme

* fix broken links

* fix spelling

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-11-09 12:26:49 -08:00
ndeevy
97262fb8fc
Docs: Made usage of config/configuration consistent #19270 (#28167)
Rebased ndeevy:docs-config/configuration-consistency-update from grafana/master to resolve conflicts

Co-authored-by: ndeevy <ndeevy@redhat.com>
2020-11-03 12:09:49 +01:00
Diana Payton
5254a7ec5d
Docs: Add survey content (#28446)
* Update change-home-dashboard.md

* added survey code

Added survey blurb.

* Update whats-new-in-v7-3.md

* minor edits
2020-10-22 13:22:34 -07:00
Darryl
2b312d24c4
Docs: Remove and update vague link text #27824 (#28055) 2020-10-07 09:31:16 -07:00
achatterjee-grafana
add777ad40
Change metadata of doc topics (#27943)
* Changes. to metadata in Manage users

* changes to install section

* Added titile

* More changes.

* Updated administration folder metadata, moved 2 files from installation folder.

* Added links to Administration landing page, other metadata changes worked out.

* Updated alerting section metadata.

* Updated metadata of Auth section. Broke index and created separate Grafana Authentication section.

* Added correct weight.

* Updated metadata for the Best practices section.

* Updated metadata in templates, broke Overview topic.

* Updated subment Variable types metadata

* Fixed yaml file and H1 description of Variables syntax topic.

* Couple more metadata changes.

* Added aliases files, as suggested by Diana.
2020-10-01 17:37:26 -04:00
DECarreras
54df058b95
Docs: Fixed lazy numbering in all documentation files (#27975) 2020-10-01 12:45:05 -04:00
Nitesh Koushik S
f9ab6975ba
Document Update (#27806)
* Document Update

Capitalizing the words

* Document Update

Changes made as per the suggestion
2020-09-25 10:22:43 -04:00
Nitesh Koushik S
4da2fa9973
Document update (#27807)
Grammar correction
2020-09-25 09:49:21 -04:00
Andrei Lavrov
8253b9ddb3
Alerting: override PagerDuty 'dedup_key' via tags (#27356)
* Alerting: override PagerDuty 'dedup_key' via tags

Added ability to override PagerDuty 'dedup_key' via Alert tags

Updated unit tests

* Updated documentation

* add comma

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* add space

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-09-07 18:42:06 +02:00
Vishwa Krishnakumar
999009bd57
Docs: Added Zenduty Grafana integration to the Grafana notifications documentation page (#27069)
* Added Zenduty Grafana integration to the notifications page

Signed-off-by: Vishwa Krishnakumar <vishwa306@gmail.com>

* Added Zenduty Grafana integration to the list of notifiers table

Signed-off-by: Vishwa Krishnakumar <vishwa306@gmail.com>
2020-08-20 08:03:45 -07:00
Diana Payton
76230215c5
Docs: Update notifications.md (#26624) 2020-07-27 08:42:25 -07:00
Sofia Papagiannaki
4bb3f66569
Stackdriver: Rename Stackdriver to Google Cloud Monitoring (#25807)
* Update backend

* Update frontend

* Keep old plugin id

* Update docs

* Place doc images to a new directory

* Legacy support for stackdriver-auto alignment

* Consistent plugin name

* Apply suggestions from code review

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
Co-authored-by: Tobias Skarhed <1438972+tskarhed@users.noreply.github.com>

* Update docs

* Update public/app/plugins/datasource/cloud-monitoring/README.md

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>

* Add reference to the data source formerly being named Stackdriver

* Update pkg/models/datasource.go

Co-authored-by: Carl Bergquist <carl@grafana.com>

* Fix gofmt

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
Co-authored-by: Tobias Skarhed <1438972+tskarhed@users.noreply.github.com>
Co-authored-by: Carl Bergquist <carl@grafana.com>
2020-06-30 18:47:13 +03:00
Mitsuhiro Tanda
9f82cd4713
Slack: Support use of chat.postMessage (#25818)
* set bearer token if token is provided
* update slack notification document

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
2020-06-26 20:47:06 +02:00
Mohit Nain
69eb5afdf7
Docs: Typo correction (#25791)
Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
2020-06-25 01:45:22 +02:00
Diana Payton
78996516af
Docs: Update configuration.md (#25707)
* Update configuration.md

* moved configuration.md to administration folder

* updated links

* Added quota section

* Update upgrading.md

* Update configuration.md

* Update configuration.md

* Update configuration.md

* Updating links

* Update configuration.md

* Update configuration.md

* Update configuration.md

Reworked the security options

* Update configuration.md

* Update configuration.md

* Update provisioning.md

* Update provisioning.md

* Update configuration.md

* Update configuration.md

* Update docs/sources/administration/configuration.md

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
2020-06-23 09:56:44 -07:00
Kaveet Laxmidas
b5b1b9d64e
Docs: Fix broken link to Slack documentation (#25720)
This change fixes a link broken due to link formatting on the docs.

The issue is present here, in the last sentence: https://grafana.com/docs/grafana/latest/alerting/notifications/#slack
2020-06-22 11:18:33 +02:00
Carl Bergquist
35e2b87b61
removes text about alert messages supporting variables (#25622)
fixes #25605
2020-06-16 14:50:52 +02:00
David Wittman
a9d34a3e6f
Docs: Images in alerts require an ext provider (#25466)
Be more explicit about the fact that providing images in alert notifications requires an external image storage provider. Previously this read as if it was only necessary for publicly accessible images, but even if they are served from Grafana, the administrator must set up the "local" image provider in the configuration.
2020-06-09 07:28:23 -07:00
Andrew Burian
a0e5f51d05
Alerting: Remove message from PagerDuty summary field (#24813)
closes #16930
2020-05-25 21:01:29 +02:00
Victor Coutellier
3a0f2dc160
Alerting: Adds support for multiple URLs in Alertmanager notifier (#24196)
* Alerting: Adds support for multiple URLs in Alertmanager notifier

Adds support for multiple URLs in Alertmanager notifier following
alertmanager documentation for high availability setup.
Update the documentation for alertmanager notifier.

Closes #24195

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
Co-authored-by: bergquist <carl.bergquist@gmail.com>
2020-05-20 08:49:53 +02:00
Diana Payton
150d9b2a77
Docs: fixing links (#24757) 2020-05-15 14:33:37 -07:00
Diana Payton
0e53b15375
Docs: Update links for 7.0 (#24751)
* update menu

* updated alert list

* Update alert-list-panel.md

* Update alert-list-panel.md

* Update bar-gauge-panel.md

* Delete bar_gauge.md

* Delete dashlist.md

* Update dashboard-list-panel.md

* deleted old panels

* Update gauge-panel.md

* Update graph-panel.md

* Update heatmap.md

* Update logs-panel.md

* Update news-panel.md

* Updated stat panel

* Update table-panel.md

* Update text-panel.md

* Fixed broken links

* Update _index.md

* Update alerts-overview.md

* Update add-a-panel.md

* Update field-configuration-options.md

* removed beta text

* Update inspect-panel.md

* Update panel-editor.md

* Update thresholds.md

* Update transformations.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update _index.md

* Update transformations.md
2020-05-15 13:58:39 -07:00
Diana Payton
59ffe4f413
Docs: Rewrite alerting docs (#24653)
* updated menu and added alerts-overview.md

* Delete metrics.md

* Update menu.yaml

* changed file name and updated menu

* Update create-alerts.md

* added file and link

* Create view-alerts.md

* added content and links

* Update pause-an-alert.md

* added content and links

* edited notification content

* updated link

* Update docs/sources/alerting/create-alerts.md

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>

* Applied marcus e. edits

* Update docs/sources/alerting/alerts-overview.md

Co-authored-by: Carl Bergquist <carl@grafana.com>

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
Co-authored-by: Carl Bergquist <carl@grafana.com>
2020-05-14 09:19:15 -07:00
Amal
c075576f3a
Minor correction in documentation (#24472) 2020-05-13 15:46:27 +02:00
Amal
8f4c795a99
Docs: Placed a comma, for readability (#24187) 2020-05-05 10:52:54 -07:00
Amal
9945713a7b
Grammatical correction in doc (#24127) 2020-04-30 23:57:57 +02:00
Johannes Midgren
4c80eb7537
Docs: Change header levels of last three sections (#23587)
The last three sections of this document are not rendered on https://grafana.com/docs/grafana/latest/alerting/notifications 
It seems like in all other instances (other .md docs of this project), level one headers are only used at the top of the page, so I assume using level two headers will make them show. Level two headers do also match the overall structure of the documentation.
2020-04-15 10:31:22 -07:00
Carl Bergquist
0f0481efaa
removes squadcast from docs (#23213)
removes squadcast since its not a core alert notifier. Mentioning all
services that support the Grafana webhook is not feasible for our docs
2020-03-31 09:07:07 +02:00