Commit Graph

3290 Commits

Author SHA1 Message Date
Eunice Kim
ee51df3715
Geomap: Document the Geomap plugin (#37221)
* Add base layer documentation

* Add initial overlay documentation

* Fix title of overlays

* Fix typos

* Add details on each overlay options

* Add location doc

* Address comments

* Address comments

* Address Base layer comments

* Address data layer comments

* Update image names

* Change titles to sentence case

* Follow UI for capitalizations
2021-07-27 22:47:38 +02:00
Alexander Emelin
75bd0bbacd
live: experimental HA with Redis (#36787)
Grafana 8.1.0 will include experimental high availability setup support by
using Redis PUB/SUB and data structures for inter-node state sharing.
This commit documents this but also explicitly marks feature as experimental
since integration of Live with Redis may slightly evolve with time as soon as
we get more understanding about Grafana Live usage scenarios.
2021-07-27 10:40:00 +03:00
Nathan Rodman
5f0bc252bc
Alerting: support label matcher syntax in alert rule list filter (#36408)
* Add filter parsing to rule list filters

* Add unit tests for label parsing

* Make label operators an enum

* add example for parsing function

* Update labels operator regex

* Add tests to rule list for filtering

* add additional test for testing alert instances filtering

* Use tooltip for query syntax example

* refactor to use Matchers for filtering

* Update docs for label filtering on rules list

* style fixes
2021-07-26 12:05:49 -07:00
jmrieger
81b98745c0
Docs: Add missing backtick in time range table (#37209) 2021-07-26 11:12:49 -04:00
Olof Bourghardt
5d101fece1
Docs: add documentation with regards to the new prettify function (#36856)
* Docs: add information about prettify function

* Docs: add info in logs-panel

* Docs: update prettify function in logs-integration

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

* Docs: update prettify function in logs-panel

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

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2021-07-26 16:20:29 +02:00
achatterjee-grafana
72cac20e1d
Removed note about frequent changes. (#37119) 2021-07-23 11:27:21 -04:00
Grot (@grafanabot)
c39a4e9c4e
ReleaseNotes: Updated changelog and release notes for 8.1.0-beta2 (#37150)
* ReleaseNotes: Updated changelog and release notes for 8.1.0-beta2

* Update CHANGELOG.md

* Update release-notes-8-1-0-beta2.md

* Update CHANGELOG.md

* Update release-notes-8-1-0-beta2.md

* Update release-notes-8-1-0-beta2.md

* Update CHANGELOG.md

Co-authored-by: Will Browne <wbrowne@users.noreply.github.com>
2021-07-23 13:34:13 +02:00
Grot (@grafanabot)
3b875def76
ReleaseNotes: Updated changelog and release notes for 8.1.0-beta2 (#37144)
* ReleaseNotes: Updated changelog and release notes for 8.1.0-beta2

* Update docs/sources/release-notes/release-notes-8-1-0-beta2.md

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

Co-authored-by: Will Browne <wbrowne@users.noreply.github.com>
Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>
2021-07-23 12:48:28 +02:00
Will Browne
0069d13929
Docs: Add 8.1.0 beta1 and beta2 release note links (#37140) 2021-07-23 13:00:23 +03:00
achatterjee-grafana
013218e075
Doc: first draft of 8.1 what's new (#37021)
* Create whats-new-in-v8-1.md

* Updated index page.

* Fixed two relrefs.

* Added section for annotation panel
2021-07-22 14:27:32 -04:00
Dan Cech
5a56594f0c
add instructions for managing redirects when moving docs pages around (#37113) 2021-07-22 13:46:40 -04:00
Grot (@grafanabot)
ddde5a5f2d
ReleaseNotes: Updated changelog and release notes for 8.1.0-beta1 (#37111) 2021-07-22 18:10:11 +02:00
George Robinson
2f4c893cf3
Expand the value string in annotations and labels of alerts (#37051)
This commit makes it possible to use the value string in
annotations and labels for alerts with "{{ $value }}"
2021-07-22 15:20:44 +01:00
yuwaMSFT2
ad1f792b8b
Auth: Pass user role to Grafana using auth proxy (#36729)
* Pass role to Grafana using auth proxy

By default, the role will be applied to the default org of the user.
If the request uses the standard header "X-Grafana-Org-Id", the role will be applied to the specified org

Tested in both unit test and manually E2E

* Address comment: only allow the user role to be applied to the default org

Co-authored-by: Leonard Gram <leo@xlson.com>
2021-07-22 15:49:58 +02:00
Sofia Papagiannaki
b96dd1877c
Folder API: optionally force deleting Grafana 8 alerts when deleting a folder (or error) (#36427)
* Folder API: Add an optional query parameter for allowing deleting a  folder containing rules

* Update frontend

- Set forceDeleteRules=true when frontend deletes a folder
- Improve modal text

* Update docs

* Apply suggestions from code review

Co-authored-by: gotjosh <josue@grafana.com>
Co-authored-by: Nathan Rodman <nathanrodman@gmail.com>
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2021-07-22 12:27:13 +03:00
Serge Zaitsev
9f36e36c89
Pick changes from PR 33811, use UID in dashboard navlinks (#36899)
* pick changes from PR 33811, use UID in dashboard navlinks

* use proper spelling for UID

* add uid to the plugin schema

* Update docs/sources/developers/plugins/plugin.schema.json

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

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2021-07-22 09:11:33 +02:00
Sofia Papagiannaki
7815ed511f
Alerting: Refactor API endpoints for fetching alert rules (#37055)
* Refactor ruler API endpoint for listing rules

* Refactor prometheus API endpoint for listing rules

* Update HTTP API docs
2021-07-22 09:53:14 +03:00
Ryan McKinley
e604e69d93
Geomap: default basemap config cleanup (#37069) 2021-07-21 13:48:20 -07:00
achatterjee-grafana
f26f76df5a
Added placeholder topics. (#37074) 2021-07-21 22:25:32 +02:00
achatterjee-grafana
4b348fa4a7
Added Pro and Advanced (#37073) 2021-07-21 22:01:13 +02:00
achatterjee-grafana
a306135de5
Added Grafana cloud references to the 4 topics. (#37071) 2021-07-21 15:00:35 -04:00
Eunice Kim
3b0d7fc00b
Geomap: Base layer server configuration (#37041) 2021-07-21 17:54:05 +02:00
Heds Simons
f8118cceaf
docs: Update Admin allow_embedding clickjacking link. (#31490)
Signed-off-by: Heds Simons <heds@whaleway.net>
2021-07-21 09:13:02 -04:00
Maria Alexandra
3fb80ac474
Docs: update annotations docs to include typeahead support for tags (#36718)
* Docs: update annotations docs to include typeahead support for tags

* Docs: Update Http API annotations including new endpoint to query by tags


Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2021-07-21 10:23:15 +02:00
Dan Cech
50b7674b58
fix alerting docs aliases so we redirect instead of 404 old urls (#37037)
* fix alerting docs aliases so we redirect instead of 404 old urls

* add missing alias
2021-07-20 20:34:23 -04:00
axlrosen
79747b419b
Doc: Info about $__rate_interval for naive users (#36576)
* 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>
2021-07-20 13:25:24 +02:00
Ganesh Vernekar
5806c66825
Alerting: Fix the table markdown docs (#36901)
Signed-off-by: Ganesh Vernekar <ganeshvern@gmail.com>
2021-07-20 15:37:19 +05:30
Alexander Emelin
8eeeb02a70
live: add to v8 upgrading section (#36661) 2021-07-20 11:58:24 +03:00
Vardan Torosyan
140bb4cc56
Access control docs: Add a note indicating that Explore can be managed by fine-grained access control (#36703)
* Access control: Add FGAC permissions to Admins for Explore access

* Remove unnecessary change
2021-07-20 09:03:28 +02:00
Alexander Emelin
48941da02e
live: mention HA limitations in administration docs (#36752) 2021-07-19 20:05:08 +03:00
Ganesh Vernekar
34699713ea
Alerting: Update docs to mention the requirement of persistent disks (#36808)
Signed-off-by: Ganesh Vernekar <ganeshvern@gmail.com>
2021-07-19 17:51:33 +02:00
Djairho Geuens
4cadbba686
Email: Allow configuration of content types for email notifications (#34530)
* Alerting: Allow configuration of content types for email notifications

* Fix lint error

* Improves email templates

* Improve configuration documentation

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

* Improve code comments

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

* Improve configuration documentation

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

* Improve email template

* Remove unnecessary predeclaration

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

* Adds handling for unrecognized content type

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

* Move utility function outside of util package

* Fixes syntax

* Remove unused package

* Fix lint error

* improve email templates

* Fix test

* Alerting: Allow configuration of content types for email notifications

* Fix lint error

* Improves email templates

* Improve configuration documentation

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

* Improve code comments

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

* Improve configuration documentation

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

* Improve email template

* Remove unnecessary predeclaration

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

* Adds handling for unrecognized content type

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

* Move utility function outside of util package

* Fixes syntax

* Remove unused package

* Fix lint error

* improve email templates

* Fix test

* Fix comment style

Co-authored-by: Ganesh Vernekar <15064823+codesome@users.noreply.github.com>

* Fix template formatting

* Add test and improve error handling

* Fix test

* Fix formatting

* Fix formatting

* Improve documentation and regenerates txt template

* Update docs/sources/administration/configuration.md

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

Co-authored-by: Djairho Geuens <djairho.geuens@ae.be>
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
Co-authored-by: Ganesh Vernekar <15064823+codesome@users.noreply.github.com>
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2021-07-19 13:31:51 +03:00
Leon Sorokin
248b442ca3
Docs: fix link to status-history on visualizations index page (#36873) 2021-07-17 00:45:36 -05:00
Dominik Prokop
a6aab7d0c9
Docs: Add time series annotations docs (#36657)
* Docs: Add time series annotations docs

* Review
2021-07-16 12:33:00 +02:00
Marcus Andersson
8e386b9da5
Docs: added documentation for the "prepare time series"-transformation. (#36761)
* added documentation for the prepare time series transformation.

* Update docs/sources/developers/plugins/data-frames.md

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>

* Update docs/sources/panels/transformations/types-options.md

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>

* Update docs/sources/panels/transformations/types-options.md

Co-authored-by: Marcus Olsson <marcus.olsson@hey.com>

* Update docs/sources/panels/transformations/types-options.md

Co-authored-by: Marcus Olsson <marcus.olsson@hey.com>

* changed according to feedbcak.

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>
Co-authored-by: Marcus Olsson <marcus.olsson@hey.com>
2021-07-16 10:41:15 +02:00
Grot (@grafanabot)
dc5778c303
ReleaseNotes: Updated changelog and release notes for 7.5.10 (#36802)
* 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>
2021-07-15 18:04:42 +02:00
Giordano Ricci
f6b83a4f47
Elasticsearch: Add frozen indices search support (#36018)
* Revert "Revert "Elasticsearch: add frozen indices search support (#27472)" (#27726)"

This reverts commit 4c7131425b.

* Make label width a bit more consistent

* Add documentation for X-Pack & Frozen Indices support in Elasticsearch

* Change UI & docs casing

* create default empty dataframe

* Remove backticks and simplify regex

* small doc improvement
2021-07-15 15:52:02 +02:00
Grot (@grafanabot)
fdad8558ee
ReleaseNotes: Updated changelog and release notes for 8.0.6 (#36751)
* 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>
2021-07-15 15:15:36 +02:00
George Robinson
456dac1303
Expand the value of math and reduce expressions in annotations and labels (#36611)
* Expand the value of math and reduce expressions in annotations and labels

This commit makes it possible to use the values of reduce and math
expressions in annotations and labels via their RefIDs. It uses the
Stringer interface to ensure that "{{ $values.A }}" still prints the
value in decimal format while also making the labels for each RefID
available with "{{ $values.A.Labels }}" and the float64 value with
"{{ $values.A.Value }}"
2021-07-15 13:10:56 +01:00
Torkel Ödegaard
9b329804e1
Docs: New index page with list of all visualizations and panels (#36756)
* New index pages and some new images

* Update

* Update graph-color-scheme.md

Small grammar fix

* Update pie-chart-panel.md

Small fix for caption

* Update _index.md

Minor grammatical change and missing comma.

* Update graph-color-scheme.md

Another small grammar tweak

* Adding color scheme docs

* Updated image captions

* Added missing panels

* Updates

* fixes

* Align on naming

* Fix

Co-authored-by: Petros Kolyvas <code@petros.io>
2021-07-15 07:57:33 +02:00
Joseph Robinson
2f595fa144
Docs:Adjust azuread.md for Powershell UUID command (#27323)
* Docs:Adjust azuread.md for Powershell UUID command

Why this change is needed:

-Update the docs to include more Unique ID information for Windows users. This is intended to improve user experience.
-Adjust passive to active voice where it improves the documentation.
-Checking for style guide compliance.

Closes issue: #23094

* Update azuread.md

Fixed typo "possibile".

* Update docs/sources/auth/azuread.md

fix capital letter U and G.

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

* Update docs/sources/auth/azuread.md

Adjust punctuation for clarity.

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

* Update docs/sources/auth/azuread.md

Place Note in correct bold markup following style guide.

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

* Update docs/sources/auth/azuread.md

Bold markup for UI fields.

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

* Update docs/sources/auth/azuread.md

Capital for id > ID.

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

* Including suggestions as noted by Diana Payton

* adjusting object IDs to match the docs.microsoft style
* using bold for UI elements
* Other fixes as needed

Update docs/sources/auth/azuread.md

Capital for id > ID.

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

* Update docs/sources/auth/azuread.md

Add the adverb to place the next step directly after the previous step in sequence.

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

* Update docs/sources/auth/azuread.md

Change remaining lowercase "id" use to upper case "ID" when it
appears in text.

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

* Applying achatterjee's suggestions

Accepting the changes:

* Adding in articles
* Adjusting prepositions
* Other changes as requests

Completing this commit through the Github web interface for added speed.

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@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-07-14 18:55:25 +02:00
shuotli
5c5c3bdd94
AzureMonitor: Improve Azure Resource Graph docs (#34450)
* Add macros in ARG doc

* Update docs/sources/datasources/azuremonitor.md

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

* Update docs/sources/datasources/azuremonitor.md

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

* Update docs/sources/datasources/azuremonitor.md

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

* Update docs/sources/datasources/azuremonitor.md

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

* Update docs/sources/datasources/azuremonitor.md

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

* Update docs/sources/datasources/azuremonitor.md

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

* Update docs/sources/datasources/azuremonitor.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>
2021-07-14 18:23:07 +02:00
castillo92
e8d5b2431e
Update queries.md (#31941)
* 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>
2021-07-14 18:22:23 +02:00
Carrie Crowe
c21b4eb602
Update configuration.md (#30695)
* Update configuration.md

Corrected several typos and included words that were originally left out to ensure proper grammar in document.

* Update docs/sources/administration/configuration.md

Co-authored-by: Dave Henderson <dhenderson@gmail.com>

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
Co-authored-by: Dave Henderson <dhenderson@gmail.com>
2021-07-14 18:19:26 +02:00
Mitch Seaman
f77f3d8a9d
Add AGPL license update to 8.0 changelog, release notes, What's New (#36742)
* add license change to changelog, release notes, and whats new

* wording update to match other headers
2021-07-14 07:52:03 -06:00
Torkel Ödegaard
f29f190e73
Docs: Docs for Rows to fields and Config from query transformations (#36713)
* Docs: Docs for new transformations rows to fields and config from query results

* Added config from query docs

* refinement

* Same lists everywhere

* minor tweak

* Added beta and version notices
2021-07-14 13:16:09 +02:00
Jeffrey Jansma
b81d7eb886
Documentation: Update image_rendering.md to include libgbm1 (#35850)
* Update image_rendering.md

* Updated with feedback 

Updated with feedback
2021-07-13 14:01:59 +02:00
Domas
32a551b4ca
Alerting: add toggle in Loki/Prom datasource config to opt out of alerting ui (#36552)
* wip

* fix useIsRuleEditable

* test for detecting editable-ness of a rules datasource

* tests!

* fix lint errors

* add alerting ui opt-out toggle to loki and prom datasources

* 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-07-12 15:06:09 -07:00
George Robinson
36cb396568
Add ValueString to the documentation for alerts (#36654) 2021-07-12 17:20:42 +01:00
Zoltán Bedi
c02ead9113
Tracing: add way to configure trace to logs start and end time (#34995)
* Tracing: add way to configure trace to logs start and end time

* Use the span's time by default

* Update docs

* Update time inputs to use strings instead of number

* Support negative values as well

* Add info about using negative value

* Don't round up Loki range

* Update docs/sources/datasources/jaeger.md

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

* Wording for doc

* Round adjusted start and end time

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2021-07-12 11:25:41 +02:00