Commit Graph

1847 Commits

Author SHA1 Message Date
Björn Rabenstein
e9bcee30fa Improve documentation for the Prometheus data source (#21415)
Besides minor language corrections, this tries in particular to
provide some clarity about the `step` setting in the Prometheus range
query and the `$__interval` variable:

- First of all: They are both always the same.

- What's really confusing (and arguably really un-helpful) is that the
  _Min time interval_ is multiplied by the resolution
  factor. Therefore, I just state the fact here now but don't add
  anything like "This should be the scrape interval" because it is not
  true (if resolution is `1/10`, a meaningful _Min time interval_ is
  generally a tenth of the scrape interval).

- More helpful is the _Min step_ parameter, because it is not
  multiplied by the resolution factor (which I have now stated
  explicitly). Of course, the _Min time interval_ has to be set to
  something small so that the _Min step_ parameter can kick in.

It would be good if we could also override the _Min time interval_
tool tip because that is where most people will look, and the current,
very Graphite-centric tool tip is very confusing for the Prometheus
query editor, in particular because it doesn't have any hint about the
resolution factor being applied. See #21413.

Signed-off-by: beorn7 <beorn@grafana.com>
2020-01-10 13:51:32 +01:00
Martin Lehmann
418cb9a8da Docs: Remove comment about upcoming alerting for singlestat and table panels (#21416)
This might help with the general tone of voice in https://github.com/grafana/grafana/issues/6983 😕
2020-01-09 14:02:08 +01:00
Leonard Gram
d22e53bba8
Docs: explain how to setup the apt repo without helpers (#21194)
* Docs: explain how to setup the apt repo without helpers

* Docs: re-structured apt install docs

* Update docs/sources/installation/debian.md

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

* Update docs/sources/installation/debian.md

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

* Docs: improvements based on feedback

* Docs: appending is safer if the user for some reason wants both beta and non beta

* Docs: repo -> repository

* Update docs/sources/installation/debian.md

Co-Authored-By: Arve Knudsen <arve.knudsen@gmail.com>

* Update docs/sources/installation/debian.md

Co-Authored-By: Arve Knudsen <arve.knudsen@gmail.com>

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
2020-01-08 10:38:31 +01:00
Raghu Chinnannan
b4fa27b8a4 Docs: Added Squadcast notifications (#21372)
- Added Squadcast section 
- Added Squadcast to the **All supported notifiers** table.
2020-01-07 12:59:53 +01:00
Emil Hessman
f0764ceda8 Docs: Use https scheme for Grafana playground links (#21360) 2020-01-06 08:25:13 -08:00
Robby Milo
90d20ec5af
fix docs links (#21359) 2020-01-06 17:16:14 +01:00
Andrej Ocenas
27a308a3a4 Docs: Fix link (#21358) 2020-01-06 07:43:01 -08:00
Emil Hessman
06dee734bd Docs: Fix InfluxDB templated dashboard link (#21343) 2020-01-06 07:32:27 -08:00
Emil Hessman
aa58a21833 docs: fix influxdb templated dashboard link (#21336)
Fixes #21320
2020-01-03 15:12:38 -08:00
Diana Payton
8febceb67a
Docs: Update Windows.md (#21333)
Updated instructions to reflect the changes to the installation page.
2020-01-03 15:10:57 -08:00
Diana Payton
534e343c71
Docs: Update security.md (#20981)
* Update security.md

* Update security.md

* Update docs/sources/installation/security.md

Co-Authored-By: Dan Cech <dcech@grafana.com>

* Update security.md

* Update security.md

* Update security.md

Co-authored-by: Dan Cech <dan@aussiedan.com>
2020-01-02 13:51:49 -08:00
JJ Asghar
1764c2417f Docs: Added sudo and removed $ where inconsistent. (#21314)
I standardized the readme for `sudo` and removed the `$`.

Now you can copy paste the commands and just "install" via the rpm
based distros.

Signed-off-by: JJ Asghar <jjasghar@gmail.com>
Signed-off-by: JJ Asghar <awesome@ibm.com>
2020-01-02 07:40:09 -08:00
Paul Emmerich
42032f6c03 ImgUploader: add support for non-amazon S3 (#20354)
* imguploader: add support for non-Amazon S3 endpoints and forcing of path-style S3 addressing

fixes #11240

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
2020-01-02 15:10:20 +01:00
Serhii Varakuta
48a93a5bd3 Docs: Update provisioning.md (#21303) 2019-12-31 07:32:05 -08:00
Diana Payton
ea934048f0
Docs: Update alerting_notification_channels.md (#21245)
* Update alerting_notification_channels.md

Minor edits and fixed stacked heading issue.

* Update docs/sources/http_api/alerting_notification_channels.md

Co-Authored-By: Marcus Efraimsson <marcus.efraimsson@gmail.com>

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
2019-12-31 07:30:53 -08:00
Diana Payton
355b906493
Docs: Fixed broken links in Basic Concepts (#21035)
* Fixed broken links

* Update basic_concepts.md

* Fix REF_NOT_FOUND errors

* add shortcode

Co-authored-by: Robby Milo <robbymilo@gmail.com>
2019-12-30 08:04:02 -08:00
Diana Payton
71411490bf
Docs: Edited Windows install instructions (#20780)
* Edited Windows install instructions

Moved one section from Windows install guide to developer-guide.md. Edited some content in windows.md and will add questions.

* Updated per comments

* Fixed broken links in basic_concepts.md

* Revert "Fixed broken links in basic_concepts.md"

This reverts commit e524ea9e7b.

* Update windows.md
2019-12-30 07:53:38 -08:00
Diana Payton
de1e51448a Docs: Update troubleshooting.md (#21244)
Fixed a few minor grammar errors.

Fixes #19295
2019-12-30 08:38:51 +01:00
Alexandre de Verteuil
4f10dca058 Fix internal links in http_api/dashboard.md (#21255) 2019-12-30 08:38:08 +01:00
Marcus Efraimsson
4835539248
Docs: Fix aliases/redirects (#21241)
Makes all aliases rooted to /docs/grafana/latest.

Fixes #21240
2019-12-30 08:17:03 +01:00
Dave Henderson
e2375593fc Docs: Document tracing.jaeger configuration (#21181)
* Docs: Document tracing.jaeger configuration

Signed-off-by: Dave Henderson <dhenderson@gmail.com>

* Apply suggestions from code review

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

* Grammar fixes

Signed-off-by: Dave Henderson <dhenderson@gmail.com>

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2019-12-30 08:15:49 +01:00
Zach Bagnall
d0360de8f1 Alerting: Add configurable severity support for PagerDuty notifier (#19425)
* Pagerduty notifier: configurable severity

Instead of hardcoding `critical` make it configurable per notification channel instance.

* fix html

* Add a test to ensure default severity is correct

* Notifications doc

* Add a non-default test

* Add err check on NewJson (all tests)

* Add default severity (critical) to AlertNotificationEditCtrl class
2019-12-24 09:32:05 +02:00
Maisy Kim
e031cbb1a1 Docs: fix typo (#21190) 2019-12-23 14:21:38 -08:00
yeungalan0
15fed09c48 Docks: Update provisioning.md with proper Slack settings (#21227)
From the below link seems that these are the proper slack settings, and I was able to test/verify. 
https://github.com/grafana/grafana/blob/master/pkg/services/alerting/notifiers/slack.go
2019-12-23 07:45:06 -08:00
Dan Cech
5addf9fafd
docs: rename premium plugins to enterprise plugins (#21222)
* rename premium plugins to enterprise plugins

* Update docs/sources/enterprise/_index.md

Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2019-12-20 18:40:25 -05:00
Diana Payton
6cad058018
Docs: Fix broken link in debian.md (#21199)
Fixes #21169
2019-12-19 15:09:25 -08:00
Leonard Gram
f33a917af2
Docs: fix ordering of apt setup (#21192) 2019-12-19 15:48:16 +01:00
Sriramajeyam
88aab3e6c1 Docs: Fix Azure ad generic OAuth code markdown formatting (#21189) 2019-12-19 15:27:05 +01:00
Leonard Gram
15547290c1
docs: rendering plugin required for reporting (#21162)
* docs: rendering plugin required for reporting

* Update docs/sources/features/reporting.md

Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2019-12-19 14:55:18 +01:00
Sriramajeyam
06347e3f86 [docs] Azure monitor link in templating (#21173)
Docs: Added missing azure monitor reference in Templating topic.
2019-12-18 07:30:12 -08:00
michael-az
5b3ff90377 Alerting: Add more information to webhook notifications (#20420)
Adds the orgId, dashboardId and panelId of the Webhook alert notifier.
2019-12-18 14:03:59 +01:00
Diana Payton
c91a20f822
Docs: Fix broken link in loki.md (#21098)
Fixed broken video link
2019-12-13 17:21:11 -08:00
Jerry Ylilammi
e27ab89aed Postgres/MySQL/MSSQL: Adds support for region annotations (#20752)
Adds support for region annotations in Postgres, MySQL and 
MSSQL data sources by adding a column named timeend to 
annotation query.

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

Closes #20918
Ref #10589
2019-12-13 17:25:36 +01:00
Diana Payton
c27262c50c
Docs: Update configuration.md for #3349 (#21069)
* Update configuration.md

Updated logs section and clarified some of the file location and commenting information.

* Update docs/sources/installation/configuration.md

Co-Authored-By: Marcus Efraimsson <marcus.efraimsson@gmail.com>
2019-12-12 11:19:41 -08:00
Alexander Morozov
06bf7e8ef1 OAuth: Removes send_client_credentials_via_post setting (#20044)
Removes send_client_credentials_via_post oauth setting and 
use auto-detect mechanism instead.
By these changes also fixes statichcheck errors

Ref #8968
2019-12-12 20:00:56 +01:00
Itamar Turner-Trauring
70e38ec352 OpenTSDB: Adding lookup limit to OpenTSDB datasource settings (#20647)
* feat: adding lookup limit to OpenTSDB settings

Adding lookup to OpenTSDB datasource settings and using it in the datasource for tag value lookup and suggest

* Document the change.

* feat: UI for configuring OpenTSDB lookup limit.

* Apply prettier.

* Fix compilation error.
2019-12-12 09:02:50 +01:00
Sebastian Markgraf
7d6bd78e0b Docs: Change checkout to check out where necessary (#20926)
Fixes #20775
2019-12-10 10:23:07 -08:00
Sofia Papagiannaki
3f48033b38
Docs: Update datasource API examples (#20951)
* Update requests and responses

* Add basic auth example
2019-12-10 15:30:06 +02:00
Diana Payton
1d2a7a2c37 Docs: Update debian.md (#20910)
Minor edits
2019-12-06 12:04:29 +01:00
Diana Payton
4a25ec0d36
Docs: Update debian-ubuntu installation instructions (#20875)
* Update debian-ubuntu installation

Major rework of debian.md, minor updates to a configuration.md and upgrading.md.

* updated docs

Updated per Torkel's comments

* Update debian.md

Added wget to common properties install command

* Update docs/sources/installation/debian.md

Co-Authored-By: Dan Cech <dcech@grafana.com>

* Update docs/sources/installation/debian.md

Co-Authored-By: Dan Cech <dcech@grafana.com>

* Update docs/sources/installation/debian.md

Co-Authored-By: Dan Cech <dcech@grafana.com>

* Update docs/sources/installation/debian.md

Co-Authored-By: Dan Cech <dcech@grafana.com>

* Update docs/sources/installation/debian.md

Co-Authored-By: Dan Cech <dcech@grafana.com>

* Update docs/sources/installation/debian.md

Co-Authored-By: Dan Cech <dcech@grafana.com>

* Update docs/sources/installation/debian.md

Co-Authored-By: Dan Cech <dcech@grafana.com>

* Apply suggestions from code review

Co-Authored-By: Dan Cech <dcech@grafana.com>

* Update upgrading.md

* Update upgrading.md

* Update debian.md

Added ARM link
2019-12-05 10:51:08 -08:00
Robby Milo
d8984d211c
fix notifications page (#20903) 2019-12-05 17:12:00 +01:00
Robby Milo
cbd81ffeb8 Docs: update content to work with website repo (#20693)
Updates the docs to work with the website repo - mainly 
relative link updates.
Adds a menu.yaml file to build the sidebar menu (no longer 
using front matter weight).
2019-12-05 13:09:57 +01:00
Marcus Andersson
7a710737ae Gauge/BarGauge: Added support for value mapping of "no data"-state to text/value (#20842)
* FieldDisplay: added support for value mapping of no data state.

 Committer: Marcus Andersson <marcus.andersson@grafana.com>

* FieldDisplay: fixed issue when switching between modes and display numeric was null.

* ValueMapping: introduced a private function for checking null values.

* FieldDisplay: refactoring of test setup to reduce duplication.

* Docs: added info about new 'no data' value to text mapping.

* Docs: improved according to feedback. Reverted prettier formatting changes.

* FieldDisplay: removed unused import.
2019-12-04 14:29:42 +01:00
Andrej Ocenas
700b93a75c
Docs: Add section about derived fields for Loki (#20648) 2019-12-03 23:38:25 +01:00
Diana Payton
5cd4ffffe3
Remove screencasts.md (#20845)
Deleted file and removed link
2019-12-03 13:24:08 -08:00
Diana Payton
363bd1174a
Update requirements.md (#20778)
* Update requirements.md

Thoroughly read through and edited requirements.md

* Update requirements.md

Changed line 41 to Grafana data source proxy
2019-12-03 08:06:43 -08:00
Dima Ryskin
2027e1aaee AlertNotifier: Support alert tags in OpsGenie notifier (#20810)
* support alert tags in OpsGenie notifier

* update readme: OpsGenie alert tags support

* lintfix: remove redundant string formatting
2019-12-03 11:54:37 +01:00
Manaswini Das
fad098c9d1 Docs: Remove typo from mssql.md (#20748) 2019-11-29 07:38:53 -08:00
Ernie Hershey
5cfc681175 Docs: Clean up influxdb.md (#20618)
* Clean up influxdb.md

Mostly typos, some wording consistency and clarification

* feature-rich

Co-Authored-By: Marcus Olsson <olsson.e.marcus@gmail.com>

* Query editor wording

Co-Authored-By: Marcus Olsson <olsson.e.marcus@gmail.com>

* Update docs/sources/features/datasources/influxdb.md

Co-Authored-By: Marcus Olsson <olsson.e.marcus@gmail.com>

* One less "you can"

Co-Authored-By: Marcus Olsson <olsson.e.marcus@gmail.com>

* Query example wording

Co-Authored-By: Marcus Olsson <olsson.e.marcus@gmail.com>

* Remove extraneous newline

* Use less words

Co-Authored-By: Marcus Olsson <olsson.e.marcus@gmail.com>

* Remove more newlines

* Use present tense

* Add missing 'to'

* Summary fixup

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

* Down with gerunds in headers

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

* consistent tenses

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

* Remove br html tag #1

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

* Remove br html tag #2

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

* Less future tense

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

* Spell out location of annotations view

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

* Query input fixups

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

* More detail on where to access InfluxDB editor

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

* Provisioning fixups

Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2019-11-27 08:45:08 -08:00
Hans-Peter Schadler
616e2eb29f Documentation: Add missing blank in docker run command (#20705) 2019-11-27 15:45:45 +01:00