public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: Sync latest master docs with 7.5.x (#33156)

Browse Source 
* Docs: Sync latest master docs with 7.5.x

* remove some remaining next aliases and links

* Docs: Removed v8 doc changes

* fixed merge issue
This commit is contained in:
Torkel Ödegaard
2021-04-22 07:32:32 +02:00
committed by GitHub
parent 5ee4c694ea
commit ceeb381eae
86 changed files with 1928 additions and 502 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/enterprise/enterprise-configuration.md
+35
View File
@@ -326,3 +326,38 @@ A list of headers that are stripped from the outgoing data source and alerting r
### cookie_drop_list
A list of cookies that are stripped from the outgoing data source and alerting requests.
## [caching]
> **Note:** Available in Grafana Enterprise v7.5 and later versions.
> **Note:** The Memcached cache backend is unavailable in Grafana Enterprise v7.5.
When query caching is enabled, Grafana temporarily stores the results of data source queries and serves cached responses to similar requests.
### backend
The caching backend to use when storing cached queries. Options: memory
### enabled
Setting 'enabled' to true enables caching datasource queries for all data sources.
### ttl
The default TTL (time to live) if no other TTL is available.
## [caching.memory]
### gc_interval
When storing cache data in-memory, this setting defines how often a background process cleans up stale data from the in-memory cache. More frequent "garbage collection" can keep memory usage from climbing but will increase CPU usage.
## [caching.redis]
### url
The full Redis URL of your Redis server. Example: `redis://localhost:6739/0`.
### prefix
A string that prefixes all Redis keys. This value must be set if using a shared database in Redis. If `prefix` is empty, then one will not be used.
docs/sources/enterprise/license/license-expiration.md
+7 -1
View File
@@ -39,7 +39,7 @@ Your current data source permissions will keep working as expected, but you'll b
### LDAP authentication
- LDAP synchronization is not affected by an expired license.
- Enhanced LDAP debugging is unavailable.
- Team sync debugging is unavailable.
### SAML authentication
@@ -71,3 +71,9 @@ Vault integration is not affected by an expired license.
### Auditing
Auditing is not affected by an expired license.
### License restrictions
The concurrent session limit remains active for seven days after the expiration date, after which it will be turned off.
The active users limit is turned off immediately.
docs/sources/enterprise/license/license-restrictions.md
+9 -6
View File
@@ -8,10 +8,14 @@ weight = 300
# License restrictions
Enterprise licenses are limited by the number of active users, a license expiration date, and the URL of the Grafana instance.
Enterprise licenses are limited by the number of active users, the license expiration date, and the URL of the Grafana instance.
## User limits
Users are limited by the number of active users and the number of concurrent sessions for a given account.
### Active users limit
Grafana licenses allow for a certain number of active users per instance. An active user is any user that has signed in to Grafana within the past 30 days.
In the context of licensing, each user is classified as either a viewer or an editor:
@@ -19,7 +23,7 @@ In the context of licensing, each user is classified as either a viewer or an ed
- An editor is a user who has permission to edit and save a dashboard. Examples of editors are as follows:
- Grafana server administrators.
- Users who are assigned an organizational role of Editor or Admin.
- Users that have been granted Admin or Edit permissions at the dashboard or folder level. Refer to [Dashboard and folder permissions]({{< relref "../../permissions/dashboard_folder_permissions.md" >}}).
- Users that have been granted Admin or Edit permissions at the dashboard or folder level. Refer to [Dashboard and folder permissions]({{< relref "../../permissions/dashboard-folder-permissions.md" >}}.
- A viewer is a user with the Viewer role, which does not permit the user to save a dashboard.
Restrictions are applied separately for viewers and editors.
@@ -52,11 +56,10 @@ This CSV report helps to identify users, teams, and roles that have been granted
To download the report:
1. Hover your cursor over the **Server Admin** (shield) icon in the side menu and then click **Licensing**.
2. At the bottom of the page, click **Download report**.
1. At the bottom of the page, click **Download report**.
## Update license restrictions
To increase the number of licensed users within Grafana, extend a license, or change your licensed URL, contact [Grafana support](https://grafana.com/profile/org#support) or your Grafana Labs account team. They will update your license, which you can activate from within Grafana.
To increase the number of licensed users within Grafana, extend a license, or change your licensed URL, contact [Grafana support](https://grafana.com/profile/org#support) or your Grafana Labs account team. They will update your license, which you can activate from within Grafana.
For instructions on how to activate your license after it is updated, refer to
[Activate an Enterprise license]({{< relref "./activate-license.md" >}})
For instructions on how to activate your license after it is updated, refer to [Activate an Enterprise license]({{< relref "./activate-license.md" >}}).
docs/sources/enterprise/query-caching.md
+28
View File
@@ -0,0 +1,28 @@
+++
title = "Query caching"
description = "Grafana Enterprise data source query caching"
keywords = ["grafana", "plugins", "query", "caching"]
weight = 110
+++
# Query caching
> **Note:** Query caching is available behind the `caching` feature flag in Grafana Enterprise 7.5+.
When query caching is enabled, Grafana temporarily stores the results of data source queries. When you or another user submit the exact same query again, the results will come back from the cache instead of from the data source (like Splunk or ServiceNow) itself.
Query caching currently works for all backend data sources. You can enable the cache globally and configure the cache duration (also called Time to Live, or TTL). The cache can either be in-memory or in Redis.
## Query caching benefits
- Faster dashboard load times, especially for popular dashboards.
- Reduced API costs.
- Reduced likelihood that APIs will rate-limit or throttle requests.
## Enable query caching
To enable and configure query caching, please refer the the [Query caching section of Enterprise Configuration]({{< relref "./enterprise-configuration.md#caching" >}}).
## Sending a request without cache
If the data source query request contains an `X-Cache-Skip` header, then Grafana skips the caching middleware, and does not search the cache for a response. This can be particularly useful when debugging data source queries using cURL.
docs/sources/enterprise/reporting.md
+1 -1
View File
@@ -157,7 +157,7 @@ If the time zone is set differently between your Grafana server and its remote i
## Choose template variables
> ** Note:** Available in Grafana Enterprise version 7.5+ (behind `templateVariables` feature flag).
> ** Note:** Available in Grafana Enterprise version 7.5+ (behind `reportVariables` feature flag).
You can configure report-specific template variables for the dashboard on the report page. The variables that you select will override the variables from the dashboard, and they are used when rendering a PDF file of the report. For detailed information about using template variables, refer to the [Templates and variables]({{< relref "../variables/_index.md" >}}) section.
docs/sources/enterprise/usage-insights/improved-search.md
+1 -4
View File
@@ -18,7 +18,4 @@ There are several sort options:
- Views total
- Views 30 days
`Errors 30 days` and `Views 30 days` are based on a calculated sorting index that weighs errors and views that happened within the past day more heavily than those that happened over the past 30 days.
{{< docs-imagebox img="/img/docs/enterprise/improved_search.png" max-width="650px" class="docs-image--no-shadow" >}}
{{< docs-imagebox img="/img/docs/enterprise/improved-search-7-5.png" max-width="650px" class="docs-image--no-shadow" >}}
docs/sources/enterprise/white-labeling.md
+14 -4
View File
@@ -63,23 +63,33 @@ The configuration file in Grafana Enterprise contains the following options. Eac
# Set to complete URL to override apple/ios icon
;apple_touch_icon =
```
Below is an example for how to replace the default footer and help links with two custom links.
You can replace the default footer links (Documentation, Support, Community) and even add your own custom links.
An example follows for replacing the default footer and help links with new custom links.
```ini
footer_links = support guides
footer_links = support guides extracustom
footer_links_support_text = Support
footer_links_support_url = http://your.support.site
footer_links_guides_text = Guides
footer_links_guides_url = http://your.guides.site
footer_links_extracustom_text = Custom text
footer_links_extracustom_url = http://your.custom.site
```
Here is the same example using environment variables instead of the custom.ini or grafana.ini file.
```
GF_WHITE_LABELING_FOOTER_LINKS=support guides
GF_WHITE_LABELING_FOOTER_LINKS=support guides extracustom
GF_WHITE_LABELING_FOOTER_LINKS_SUPPORT_TEXT=Support
GF_WHITE_LABELING_FOOTER_LINKS_SUPPORT_URL=http://your.support.site
GF_WHITE_LABELING_FOOTER_LINKS_GUIDES_TEXT=Guides
GF_WHITE_LABELING_FOOTER_LINKS_GUIDES_URL=http://your.guides.site
GF_WHITE_LABELING_FOOTER_LINKS_EXTRACUSTOM_TEXT=Custom Text
GF_WHITE_LABELING_FOOTER_LINKS_EXTRACUSTOM_URL=http://your.custom.site
```
> **Note:** The following two links are always present in the footer:
- Grafana edition
- Grafana version with build number
If you specify `footer_links` or `GF_WHITE_LABELING_FOOTER_LINKS`, then all other default links are removed from the footer and only what is specified is included.