Commit Graph

3169 Commits

Author SHA1 Message Date
Grot (@grafanabot)
510093e96b Doc: Info about $__rate_interval for naive users (#36576) (#36946)
* Doc: Info about $__rate_interval for naive users

<!--

Thank you for sending a pull request! Here are some tips:

1. If this is your first time, please read our contribution guide at https://github.com/grafana/grafana/blob/main/CONTRIBUTING.md

2. Ensure you include and run the appropriate tests as part of your Pull Request.

3. In a new feature or configuration option, an update to the documentation is necessary. Everything related to the documentation is under the docs folder in the root of the repository.

4. If the Pull Request is a work in progress, make use of GitHub's "Draft PR" feature and mark it as such.

5. If you can not merge your Pull Request due to a merge conflict, Rebase it. This gets it in sync with the main branch.

6. Name your PR as "<FeatureArea>: Describe your change", e.g. Alerting: Prevent race condition. If it's a fix or feature relevant for the changelog describe the user impact in the title. The PR title is used to auto-generate the changelog for issues marked with the "add to changelog" label.

-->

**What this PR does / why we need it**:

For Prometheus newbies (i.e. most of us), it seems like $__rate_interval should be widely used, but the documentation doesn't tell us that. So I added more about why it's good, and an explicit recommendation that it can be a good default value for use if (like most of us) you don't really understand how to choose an interval. (Let me know if that's not actually the case, but that's what I took away from https://github.com/grafana/grafana/issues/21417)

Also fixed a few typos in the existing doc.

**Which issue(s) this PR fixes**:

<!--

- Automatically closes linked issue when the Pull Request is merged.

Usage: "Fixes #<issue number>", or "Fixes (paste link of issue)"

-->

Fixes #

**Special notes for your reviewer**:

* Edits based on suggestions from @beorn7

* Update docs/sources/datasources/prometheus.md

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

Co-authored-by: Ivana Huckova <30407135+ivanahuckova@users.noreply.github.com>
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
Co-authored-by: Ivana <ivana.huckova@gmail.com>
(cherry picked from commit 79747b419b)

Co-authored-by: axlrosen <alexrosen@alum.mit.edu>
2021-07-20 13:49:47 +02:00
Grot (@grafanabot)
e364772301 live: add to v8 upgrading section (#36661) (#36940)
(cherry picked from commit 8eeeb02a70)

Co-authored-by: Alexander Emelin <frvzmb@gmail.com>
2021-07-20 11:27:36 +02:00
Grot (@grafanabot)
b4eea4e159 Alerting: Update docs to mention the requirement of persistent disks (#36808) (#36921)
Signed-off-by: Ganesh Vernekar <ganeshvern@gmail.com>
(cherry picked from commit 34699713ea)

Co-authored-by: Ganesh Vernekar <15064823+codesome@users.noreply.github.com>
2021-07-20 08:44:11 +02:00
Grot (@grafanabot)
d73668c900 live: mention HA limitations in administration docs (#36752) (#36926)
(cherry picked from commit 48941da02e)

Co-authored-by: Alexander Emelin <frvzmb@gmail.com>
2021-07-19 19:35:52 +02:00
Marcus Andersson
5ac4e8ff94 [v8.0.x] Docs: added documentation for the "prepare time series"-transformation. (#36837)
* cherry-pick

* cherry-pick
2021-07-16 12:16:45 +02:00
Grot (@grafanabot)
33c81fca5e ReleaseNotes: Updated changelog and release notes for 7.5.10 (#36802) (#36818)
* ReleaseNotes: Updated changelog and release notes for 7.5.10

* added link to the release note.s

Co-authored-by: Marcus Andersson <marcus.andersson@grafana.com>
(cherry picked from commit dc5778c303)
2021-07-16 09:27:06 +02:00
Grot (@grafanabot)
964d312501 ReleaseNotes: Updated changelog and release notes for 8.0.6 (#36751) (#36801)
* ReleaseNotes: Updated changelog and release notes for 8.0.6

* Fix changelog entry for #36737

* Fix release note entry for #36737

* Add new release for 8.0.6

Co-authored-by: kay delaney <45561153+kaydelaney@users.noreply.github.com>
(cherry picked from commit fdad8558ee)
2021-07-15 15:38:43 +02:00
Grot (@grafanabot)
beeef8b96b Update queries.md (#31941) (#36765)
* Update queries.md

Completing some examples to allow newbie people to understand relative time and time shift time

* Update docs/sources/panels/queries.md

Co-authored-by: Geshi <ohayo@geshii.moe>

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
Co-authored-by: Geshi <ohayo@geshii.moe>
(cherry picked from commit e8d5b2431e)

Co-authored-by: castillo92 <37965565+castillo92@users.noreply.github.com>
2021-07-14 18:47:21 +02:00
Grot (@grafanabot)
2575e64e8a Add ValueString to the documentation for alerts (#36654) (#36676)
(cherry picked from commit 36cb396568)

Co-authored-by: George Robinson <85952834+gerobinson@users.noreply.github.com>
2021-07-13 14:20:58 +01:00
Grot (@grafanabot)
1734acbc9f live: better overview in docs (#36506) (#36577)
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
(cherry picked from commit 10a942aad0)

Co-authored-by: Alexander Emelin <frvzmb@gmail.com>
2021-07-08 20:28:08 +02:00
Grot (@grafanabot)
2d406f13de ReleaseNotes: Updated changelog and release notes for 8.0.5 (#36554) (#36566)
* ReleaseNotes: Updated changelog and release notes for 8.0.5

* Update _index.md

* Update CHANGELOG.md

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

Co-authored-by: Tobias Skarhed <1438972+tskarhed@users.noreply.github.com>
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
(cherry picked from commit 6266a9e77a)
2021-07-08 17:38:14 +02:00
Grot (@grafanabot)
18c547d695 Live: document allowed_origins (#36433) (#36495)
(cherry picked from commit e60950a8c7)

Co-authored-by: Alexander Emelin <frvzmb@gmail.com>
2021-07-07 10:56:43 -07:00
achatterjee-grafana
5cdd8dfed1 Docs: Removed folder and 3 files within. (#36487) 2021-07-06 21:13:25 +02:00
Grot (@grafanabot)
0131a8ef05 Docs: Fix Azure Monitor refs (#36458) (#36478)
* Docs: Fix Azure Monitor refs

* more fixes

Co-authored-by: Robby Milo <robbymilo@gmail.com>
(cherry picked from commit eabf3fb674)

Co-authored-by: Josh Hunt <joshhunt@users.noreply.github.com>
2021-07-06 16:47:56 +02:00
Grot (@grafanabot)
fd515d1318 Folders: Return 409 Conflict status when folder already exists (#36429) (#36461)
* Return 409 Conflict when trying to post folder that already exists

* Fix tests

* Update documentation for new error message in folders api

(cherry picked from commit a18d3007a7)

Co-authored-by: Dimitris Sotirakis <dimitrios.sotirakis@grafana.com>
2021-07-06 11:32:58 +02:00
Grot (@grafanabot)
fc45cf178e Allow white labeling loading logo (#36174) (#36386)
* Allow to whitelabeling loading logo

* Add loading_logo to documentation

* Change loading_logo to loading_logo_url

(cherry picked from commit ef05596e07)

Co-authored-by: Selene <selenepinillos@gmail.com>
2021-07-05 09:50:57 +03:00
Grot (@grafanabot)
1b23e38a86 AzureMonitor: Refresh documentation (#35371) (#36397)
* AzureMonitor: Refresh documentation

* logs/kusto

* finish up logs

* variables for log analytics

* Apply suggestions from code review

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

* finish up main topics

* finish docs?

* typos and other review comments

* add link to sample arg queries

* split up azure docs

* workaround weird code duplication issue

* Update docs/sources/datasources/azuremonitor/template-variables.md

Co-authored-by: Sarah Zinger <sarahzinger@users.noreply.github.com>

* Apply suggestions from code review

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

* feedback

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
Co-authored-by: Sarah Zinger <sarahzinger@users.noreply.github.com>
(cherry picked from commit ca5379d64d)

Co-authored-by: Josh Hunt <joshhunt@users.noreply.github.com>
2021-07-02 17:17:24 +02:00
Grot (@grafanabot)
7eb704f49d Docs: Update bar-gauge-panel.md (#36250) (#36395)
may be a mistake here?

(cherry picked from commit 379ed0a6f7)

Co-authored-by: dreamChenp12 <86648316+dreamChenp12@users.noreply.github.com>
2021-07-02 17:13:35 +02:00
Grot (@grafanabot)
df2500a928 Docs: Add $__rate_interval variable to global variables (#36378) (#36391)
* Add  variable documentation to global variables

* Update docs/sources/variables/variable-types/global-variables.md

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

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
(cherry picked from commit 0ca6fdd310)

Co-authored-by: Ivana Huckova <30407135+ivanahuckova@users.noreply.github.com>
2021-07-02 16:38:24 +02:00
Grot (@grafanabot)
1a598bf75e Docs: Improve title and documentation for share shortened link in Explore (#36380) (#36392)
* Improve title and documentation for share shortened link in Explore

* Update docs/sources/explore/_index.md

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

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
(cherry picked from commit 09e49f6118)

Co-authored-by: Ivana Huckova <30407135+ivanahuckova@users.noreply.github.com>
2021-07-02 16:34:22 +02:00
Grot (@grafanabot)
468523a1ce Docs: Add security warning about using Grafana 8 alerts with multiple organisations (#36308) (#36354)
* Docs: Add security warning about using Grafana 8 alerts with multiple orgs

(cherry picked from commit d525a5a469)

Co-authored-by: Sofia Papagiannaki <papagian@users.noreply.github.com>
2021-07-01 18:53:20 +03:00
Grot (@grafanabot)
740aedbcbb ReleaseNotes: Updated changelog and release notes for 8.0.4 (#36347) (#36356)
* ReleaseNotes: Updated changelog and release notes for 8.0.4

* Update _index.md

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>
(cherry picked from commit 3cce67c044)
2021-07-01 17:49:17 +02:00
Grot (@grafanabot)
2ca6b89d8f Update _index.md (#36248) (#36272)
Spelling error on line 18.
aerts -> alerts

(cherry picked from commit 603d1cddb8)

Co-authored-by: Dawnpool <57010815+Dawnpool@users.noreply.github.com>
2021-06-29 10:32:03 -04:00
Grot (@grafanabot)
469b805515 [Alerting] Update documentation with regards to clustering (#36261) (#36264)
* [Alerting] Update documentation with regards to clustering

* 8.1 not 8.2

(cherry picked from commit 91751d7e38)

Co-authored-by: gotjosh <josue@grafana.com>
2021-06-29 07:56:38 -04:00
Grot (@grafanabot)
89ac0a79ad Update whats-new-in-v8-0.md (#36249) (#36251)
Double periods to a single period

(cherry picked from commit 228372522b)

Co-authored-by: Dawnpool <57010815+Dawnpool@users.noreply.github.com>
2021-06-29 09:36:48 +02:00
Grot (@grafanabot)
4410fe538d AccessControl: Fix docs link to localhost (#36233) (#36234)
* AccessControl Correct link to localhost

* Removed extra parenthesis in relref definition

(cherry picked from commit d42d874240)

Co-authored-by: Gabriel MABILLE <gamab@users.noreply.github.com>
2021-06-28 21:40:31 +02:00
Grot (@grafanabot)
1d2bbce1cf Added note about location of the default home dashboard. (#36231) (#36232)
(cherry picked from commit cdc780e9c6)

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2021-06-28 21:08:36 +02:00
Grot (@grafanabot)
392dfd7e15 Doc: Updated broken relrefs to "Value mappings in topic "State timeline". (#36225) (#36227)
* Updated broken relrefs and adjusted some weights.

* Fixed. There was some issue with ", rendering OK in local build.

(cherry picked from commit 258b3b7078)

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2021-06-28 17:50:58 +02:00
Grot (@grafanabot)
28c0f8c49e fix broken link to play (#36148) (#36183)
closes https://github.com/grafana/grafana/issues/36103

(cherry picked from commit e6e7ba209c)

Co-authored-by: Matt Abrams <37156449+zuchka@users.noreply.github.com>
2021-06-25 20:41:37 +02:00
Grot (@grafanabot)
592cf2ac72 Docs: Document caching defaults in enterprise config (#36181) (#36182)
* Docs: Document caching defaults in enterprise config

Signed-off-by: Dave Henderson <dave.henderson@grafana.com>

* adding missed period

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

* more missed periods!

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

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
(cherry picked from commit 3ba97ee4ef)

Co-authored-by: Dave Henderson <dhenderson@gmail.com>
2021-06-25 14:28:26 -04:00
achatterjee-grafana
a1972c0f5b Added note that anonymous access permission is no longer available. (#36142) (#36173) 2021-06-25 11:13:55 -04:00
Grot (@grafanabot)
60074192e9 put environmental variable in inline code (#36100) (#36123)
this puts the code in question in the same style as the other environmental variables on the page

(cherry picked from commit 6b0c75cfd6)

Co-authored-by: Matt Abrams <37156449+zuchka@users.noreply.github.com>
2021-06-24 13:58:49 -04:00
Grot (@grafanabot)
1e77c2941b Docs: Add note about time series replacing graph vis (#36101) (#36135)
(cherry picked from commit 4f84a09286)

Co-authored-by: Ben Bodenmiller <bbodenmiller@gmail.com>
2021-06-24 17:19:19 +02:00
Grot (@grafanabot)
37bef2d0b2 add note about HA limitation (#36112) (#36129)
(cherry picked from commit ea8aee0432)

Co-authored-by: Will Browne <wbrowne@users.noreply.github.com>
2021-06-24 16:40:56 +02:00
Grot (@grafanabot)
833014d924 fix typo in template (#36082) (#36090)
(cherry picked from commit e91f12bde3)

Co-authored-by: Jan Steinke <jan.steinke@gmail.com>
2021-06-23 14:09:57 -04:00
Grot (@grafanabot)
c447ff2581 Updated content to specify method to use to get keyboard shortcuts wh… (#36084) (#36088)
* Updated content to specify method to use to get keyboard shortcuts when user is on Windows.

* Added changes from doc review.

(cherry picked from commit 5da8f3e258)

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2021-06-23 18:58:16 +02:00
Grot (@grafanabot)
d38a50c2f3 Docs: document cortex/loki data source caveats for alerting (#36074) (#36078)
* Document cortex/loki datasource caveats

* Update docs/sources/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-rule.md

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

* Update docs/sources/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-rule.md

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

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
(cherry picked from commit d427b57c0e)

Co-authored-by: Domas <domas.lapinskas@grafana.com>
2021-06-23 10:51:44 -04:00
Grot (@grafanabot)
f0fb1edb7c ReleaseNotes: Updated changelog and release notes for 7.5.9 (#36057) (#36076)
* ReleaseNotes: Updated changelog and release notes for 7.5.9

* Add link to notes

* Apply suggestions from code review

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

Co-authored-by: Andrej Ocenas <mr.ocenas@gmail.com>
Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>
(cherry picked from commit 49a64f8d44)
2021-06-23 15:57:18 +02:00
Grot (@grafanabot)
901cc09416 Update custom-panel-option-editors.md (#36005) (#36006)
Variable name fix

(cherry picked from commit f84a74018c)

Co-authored-by: DBaldovskiy <d.baldovskiy@mail.ru>
2021-06-22 09:39:32 -04:00
Grot (@grafanabot)
e9e67c3d98 ReleaseNotes: Updated changelog and release notes for 8.0.3 (#35936) (#35938)
* ReleaseNotes: Updated changelog and release notes for 8.0.3

* Update _index.md

Co-authored-by: Giordano Ricci <me@giordanoricci.com>
(cherry picked from commit fb91302e52)
2021-06-18 13:13:35 +02:00
Grot (@grafanabot)
e01b1285b9 Docs/SSE: Misc updates and corrections (#35882) (#35889)
* Docs/SSE: Misc updates and coorections

* Update docs/sources/panels/expressions.md

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

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
(cherry picked from commit fe61d20794)

Co-authored-by: Kyle Brandt <kyle@grafana.com>
2021-06-17 17:05:45 +02:00
Grot (@grafanabot)
14a76fecf1 Docs: Link to the new alerting API spec (#35812) (#35888)
* Docs: Link to the new alerting API spec

* Update docs/sources/http_api/alerting.md

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

* Update docs/sources/http_api/alerting.md

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

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
(cherry picked from commit a42ace4d4c)

Co-authored-by: Sofia Papagiannaki <papagian@users.noreply.github.com>
2021-06-17 16:34:33 +02:00
Grot (@grafanabot)
dd4f6f383d Fix spelling mistake in docs for expressions (#35873) (#35877)
(cherry picked from commit 066189588f)

Co-authored-by: George Robinson <85952834+gerobinson@users.noreply.github.com>
2021-06-17 09:45:36 -04:00
Grot (@grafanabot)
23931ef3af ReleaseNotes: Updated changelog and release notes for 7.5.8 (#35703) (#35826)
* ReleaseNotes: Updated changelog and release notes for 7.5.8

* Add missing 7.5.8 link

* Update 7.5.8 release date

Co-authored-by: Piotr Jamróz <pm.jamroz@gmail.com>
(cherry picked from commit ef59020f3d)
2021-06-16 16:51:01 +02:00
Grot (@grafanabot)
36b94c5a67 doc: fix link to label and detected fields doc (#35609) (#35777)
* Fix link to label and detected fields doc

* Update docs/sources/datasources/loki.md

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

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
(cherry picked from commit 368637c35a)

Co-authored-by: Andrea Scarpino <andrea@scarpino.dev>
2021-06-15 21:14:20 +02:00
Grot (@grafanabot)
55829f1646 Plugins: Improve wording around allow_loading_unsigned_plugins configuration (#35731) (#35775)
* improve wording

* Update docs/sources/administration/configuration.md

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

* Update docs/sources/administration/configuration.md

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

* Update conf/sample.ini

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

* Update conf/defaults.ini

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

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
(cherry picked from commit 89d8dedece)

Co-authored-by: Will Browne <wbrowne@users.noreply.github.com>
2021-06-15 13:45:01 -04:00
Grot (@grafanabot)
c78da2c50c Docs: Add upgrade/breaking note about SQL data sources and data frames (#35766) (#35771)
Add upgrade/breaking note about SQL data sources and data frames.

Ref #35534

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
(cherry picked from commit 283572fcbc)

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
2021-06-15 18:37:34 +02:00
Grot (@grafanabot)
4fd5765354 Docs: Clarify data streaming with plugins documentation (#35576) (#35696)
(cherry picked from commit 898c314946)

Co-authored-by: Alexander Emelin <frvzmb@gmail.com>
2021-06-15 11:21:40 -04:00
Grot (@grafanabot)
17a091dfb6 Docs: Document migration of dashboard alert permissions (#35559) (#35764)
* Docs: Document migration of dashbard alert permissions

* Add reference to the configuration

* Apply suggestions from code review

* Apply suggestions from code review

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

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
(cherry picked from commit 33bfd6fa53)

Co-authored-by: Sofia Papagiannaki <papagian@users.noreply.github.com>
2021-06-15 17:03:00 +02:00
Grot (@grafanabot)
d86e6c072e doc: fix link to Loki's doc (#35611) (#35671)
(cherry picked from commit 74a6e6d973)

Co-authored-by: Andrea Scarpino <andrea@scarpino.dev>
2021-06-14 17:58:17 +02:00