mirror of https://github.com/grafana/grafana
docs: Refactors remaining enterprise topics, corrects relrefs (#57707)
* moves topics, correct relrefs * Update docs/sources/dashboards/create-reports/index.md Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com> * Update docs/sources/administration/data-source-management/index.md Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com> * Update docs/sources/setup-grafana/configure-security/audit-grafana.md Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com> * Update docs/sources/setup-grafana/configure-security/configure-request-security.md Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com> * Update docs/sources/setup-grafana/configure-security/configure-team-sync.md Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com> * Update docs/sources/administration/data-source-management/index.md Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com> * Update docs/sources/dashboards/create-reports/index.md Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com> * Update docs/sources/dashboards/create-reports/index.md Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com> * Update docs/sources/administration/recorded-queries/index.md Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com> * Update docs/sources/dashboards/create-reports/index.md Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com> * Update docs/sources/dashboards/create-reports/index.md Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com> * Update docs/sources/dashboards/create-reports/index.md Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com> * Update docs/sources/dashboards/create-reports/index.md Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com> * Update docs/sources/dashboards/create-reports/index.md Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com> * Update docs/sources/dashboards/create-reports/index.md Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com> * Update docs/sources/dashboards/create-reports/index.md Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com> * removes link that goes nowhere Co-authored-by: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com>pull/57695/head^2
Christopher Moyer
3 years ago
committed by
GitHub
parent
f34dd29ac4
commit
b9a0576638
@ -1,102 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/enterprise/ |
||||
description: Grafana Enterprise overview |
||||
keywords: |
||||
- grafana |
||||
- documentation |
||||
- datasource |
||||
- permissions |
||||
- ldap |
||||
- licensing |
||||
- enterprise |
||||
- insights |
||||
- reporting |
||||
title: Grafana Enterprise |
||||
weight: 150 |
||||
--- |
||||
|
||||
# Grafana Enterprise |
||||
|
||||
Grafana Enterprise is a commercial edition of Grafana that includes additional features not found in the open source version. |
||||
|
||||
Building on everything you already know and love about Grafana open source, Grafana Enterprise includes [exclusive datasource plugins]({{< relref "#enterprise-plugins">}}) and [additional features]({{< relref "#enterprise-features">}}). You also get 24x7x365 support and training from the core Grafana team. |
||||
|
||||
To learn more about Grafana Enterprise, refer to [our product page](https://grafana.com/enterprise). |
||||
|
||||
## Enterprise features in Grafana Cloud |
||||
|
||||
Many Grafana Enterprise features are also available in [Grafana Cloud]({{< ref "/docs/grafana-cloud" >}}) Pro and Advanced accounts. For details, refer to [the Grafana Cloud features table](https://grafana.com/pricing/#featuresTable) and [Enterprise features available to Grafana Cloud Pro and Advanced accounts]({{< ref "/docs/grafana-cloud/reference/enterprise-features" >}}). |
||||
|
||||
## Authentication |
||||
|
||||
Grafana Enterprise includes integrations with more ways to authenticate your users and enhanced authentication capabilities. |
||||
|
||||
### Team sync |
||||
|
||||
[Team sync]({{< relref "../setup-grafana/configure-security/configure-team-sync/" >}}) allows you to set up synchronization between teams in Grafana and teams in your auth provider so that your users automatically end up in the right team. |
||||
|
||||
Supported auth providers: |
||||
|
||||
- [Auth Proxy]({{< relref "../setup-grafana/configure-security/configure-authentication/auth-proxy/#team-sync-enterprise-only" >}}) |
||||
- [Azure AD OAuth]({{< relref "../setup-grafana/configure-security/configure-authentication/azuread/#team-sync-enterprise-only" >}}) |
||||
- [GitHub OAuth]({{< relref "../setup-grafana/configure-security/configure-authentication/github/#team-sync-enterprise-only" >}}) |
||||
- [GitLab OAuth]({{< relref "../setup-grafana/configure-security/configure-authentication/gitlab/#team-sync-enterprise-only" >}}) |
||||
- [LDAP]({{< relref "../setup-grafana/configure-security/configure-authentication/enhanced-ldap/#ldap-group-synchronization-for-teams" >}}) |
||||
- [Okta]({{< relref "../setup-grafana/configure-security/configure-authentication/okta/#team-sync-enterprise-only" >}}) |
||||
- [SAML]({{< relref "../setup-grafana/configure-security/configure-authentication/saml/#configure-team-sync" >}}) |
||||
|
||||
### Enhanced LDAP integration |
||||
|
||||
With [enhanced LDAP integration]({{< relref "../setup-grafana/configure-security/configure-authentication/enhanced-ldap/" >}}), you can set up active LDAP synchronization. |
||||
|
||||
### SAML authentication |
||||
|
||||
[SAML authentication]({{< relref "../setup-grafana/configure-security/configure-authentication/saml/" >}}) enables users to authenticate with single sign-on services that use Security Assertion Markup Language (SAML). |
||||
|
||||
### Protected roles |
||||
|
||||
With [protected roles]({{< relref "../setup-grafana/configure-security/configure-authentication/#protected-roles" >}}), you can define user roles that are exempt from being converted from one authentication type to another when changing auth providers. |
||||
|
||||
## Enterprise features |
||||
|
||||
Grafana Enterprise adds the following features: |
||||
|
||||
- [Role-based access control]({{< relref "../administration/roles-and-permissions/access-control/" >}}) to control access with role-based permissions. |
||||
- [Data source permissions]({{< relref "../administration/data-source-management/" >}}) to restrict query access to specific teams and users. |
||||
- [Data source query caching]({{< relref "query-caching" >}}) to temporarily store query results in Grafana to reduce data source load and rate limiting. |
||||
- [Reporting]({{< relref "../dashboards/create-reports/" >}}) to generate a PDF report from any dashboard and set up a schedule to have it emailed to whoever you choose. |
||||
- [Export dashboard as PDF]({{< relref "../dashboards/share-dashboards-panels/#export-dashboard-as-pdf" >}}) |
||||
- [Custom branding]({{< relref "../setup-grafana/configure-grafana/configure-custom-branding/" >}}) to customize Grafana from the brand and logo to the footer links. |
||||
- [Usage insights]({{< relref "../dashboards/assess-dashboard-usage/" >}}) to understand how your Grafana instance is used. |
||||
- [Recorded queries]({{< relref "recorded-queries" >}}) to see trends over time for your data sources. |
||||
- [Vault integration]({{< relref "../setup-grafana/configure-security/configure-database-encryption/integrate-with-hashicorp-vault/" >}}) to manage your configuration or provisioning secrets with Vault. |
||||
- [Auditing]({{< relref "../setup-grafana/configure-security/audit-grafana/" >}}) tracks important changes to your Grafana instance to help you manage and mitigate suspicious activity and meet compliance requirements. |
||||
- [Request security]({{< relref "../setup-grafana/configure-security/configure-request-security/" >}}) makes it possible to restrict outgoing requests from the Grafana server. |
||||
- [Settings updates at runtime]({{< relref "settings-updates" >}}) allows you to update Grafana settings at runtime without requiring a restart. |
||||
|
||||
## Enterprise data sources |
||||
|
||||
With a Grafana Enterprise license, you also get access to premium data sources, including: |
||||
|
||||
- [AppDynamics](https://grafana.com/grafana/plugins/dlopes7-appdynamics-datasource) |
||||
- [Azure Devops](https://grafana.com/grafana/plugins/grafana-azuredevops-datasource) |
||||
- [DataDog](https://grafana.com/grafana/plugins/grafana-datadog-datasource) |
||||
- [Dynatrace](https://grafana.com/grafana/plugins/grafana-dynatrace-datasource) |
||||
- [Gitlab](https://grafana.com/grafana/plugins/grafana-gitlab-datasource) |
||||
- [Honeycomb](https://grafana.com/grafana/plugins/grafana-honeycomb-datasource) |
||||
- [Jira](https://grafana.com/grafana/plugins/grafana-jira-datasource) |
||||
- [MongoDB](https://grafana.com/grafana/plugins/grafana-mongodb-datasource) |
||||
- [New Relic](https://grafana.com/grafana/plugins/grafana-newrelic-datasource) |
||||
- [Oracle Database](https://grafana.com/grafana/plugins/grafana-oracle-datasource) |
||||
- [Salesforce](https://grafana.com/grafana/plugins/grafana-salesforce-datasource) |
||||
- [SAP HANA®](https://grafana.com/grafana/plugins/grafana-saphana-datasource) |
||||
- [ServiceNow](https://grafana.com/grafana/plugins/grafana-servicenow-datasource) |
||||
- [Snowflake](https://grafana.com/grafana/plugins/grafana-snowflake-datasource) |
||||
- [Splunk](https://grafana.com/grafana/plugins/grafana-splunk-datasource) |
||||
- [Splunk Infrastructure monitoring (SignalFx)](https://grafana.com/grafana/plugins/grafana-splunk-monitoring-datasource) |
||||
- [Wavefront](https://grafana.com/grafana/plugins/grafana-wavefront-datasource) |
||||
|
||||
## Try Grafana Enterprise |
||||
|
||||
To purchase or obtain a trial license, contact the Grafana Labs [Sales Team](https://grafana.com/contact?about=support&topic=Grafana%20Enterprise). |
||||
@ -1,97 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/enterprise/query-caching/ |
||||
description: Grafana Enterprise data source query caching |
||||
keywords: |
||||
- grafana |
||||
- plugins |
||||
- query |
||||
- caching |
||||
title: Query caching |
||||
weight: 300 |
||||
--- |
||||
|
||||
# Query caching |
||||
|
||||
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 works for all backend data sources. You can enable the cache globally and configure the cache duration (also called Time to Live, or TTL). |
||||
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise/" >}}) and [Grafana Cloud Pro and Advanced]({{< ref "/grafana-cloud" >}}). |
||||
|
||||
The following cache backends are available: in-memory, Redis, and Memcached. |
||||
|
||||
> **Note:** Storing cached queries in-memory can increase Grafana's memory footprint. In production environments, a Redis or Memcached backend is highly recommended. |
||||
|
||||
When a panel queries a cached data source, the time until this query fetches fresh data is determined by the panel's **interval.** This means that wider panels and dashboards with shorter time ranges fetch new data more frequently than narrower panels and dashboards with longer time ranges. |
||||
|
||||
Interval is visible in a panel's [query options]({{< relref "../panels-visualizations/query-transform-data/" >}}). It is calculated like this: `(max data points) / time range`. Max data points are calculated based on the width of the panel. For example, a full-width panel on a dashboard with a time range of `last 7 days` will retrieve fresh data every 10 minutes. In this example, cached data for this panel will be served for up to 10 minutes before Grafana queries the data source again and returns new data. |
||||
|
||||
You can make a panel retrieve fresh data more frequently by increasing the **Max data points** setting in the panel's [query options]({{< relref "../panels-visualizations/query-transform-data/" >}}). |
||||
|
||||
## Query caching benefits |
||||
|
||||
- Faster dashboard load times, especially for popular dashboards. |
||||
- Reduced API costs. |
||||
- Reduced likelihood that APIs will rate-limit or throttle requests. |
||||
|
||||
## Data sources that work with query caching |
||||
|
||||
Query caching works for all [Enterprise data sources](https://grafana.com/grafana/plugins/?type=datasource&enterprise=1) as well as the following [built-in data sources]({{< relref "../datasources/" >}}): |
||||
|
||||
- CloudWatch Metrics |
||||
- Google Cloud Monitoring |
||||
- InfluxDB |
||||
- Microsoft SQL Server |
||||
- MySQL |
||||
- Postgres |
||||
- Tempo |
||||
|
||||
Some data sources, such as Elasticsearch, Prometheus, and Loki, cache queries themselves, so Grafana query caching does not improve performance. |
||||
|
||||
Query caching also works for all data sources that include a backend. More specifically, caching works with data sources that extend the `DataSourceWithBackend` class in the plugins SDK. |
||||
|
||||
To tell if a data source works with query caching, follow the instructions below to **Enable and Configure query caching**. If caching is enabled in Grafana but the Caching tab is not visible for the given data source, then query caching is not available for that data source. |
||||
|
||||
## Enable and configure query caching |
||||
|
||||
You must be an Org admin or Grafana admin to enable query caching for a data source. For more information on Grafana roles and permissions, refer to [About users and permissions]({{< relref "../administration/roles-and-permissions/" >}}). |
||||
|
||||
By default, data source queries are not cached. To enable query caching for a single data source: |
||||
|
||||
1. On the side menu, click Configuration > Data Sources. |
||||
1. In the data source list, click the data source that you want to turn on caching for. |
||||
1. Open the Cache tab. |
||||
1. Press the Enable button. |
||||
1. (Optional) Choose custom TTLs for the data source's queries and resources caching. If you skip this step, then Grafana uses the default TTL. |
||||
|
||||
> **Note:** If query caching is enabled and the Cache tab is not visible in a data source's settings, then query caching is not available for that data source. |
||||
|
||||
To configure global settings for query caching, refer to the [Query caching section of Enterprise Configuration]({{< relref "../setup-grafana/configure-grafana/enterprise-configuration/#caching" >}}). |
||||
|
||||
## Disable query caching |
||||
|
||||
To disable query caching for a single data source: |
||||
|
||||
1. On the side menu, click Configuration > Data Sources. |
||||
1. In the data source list, click the data source that you want to turn off caching for. |
||||
1. In the Cache tab, click Disable. |
||||
|
||||
To disable query caching for an entire Grafana instance, set the `enabled` flag to `false` in the [Query caching section of Enterprise Configuration]({{< relref "../setup-grafana/configure-grafana/enterprise-configuration/#caching" >}}). You will no longer see the Cache tab on any data sources, and no data source queries will be cached. |
||||
|
||||
## Clear cache |
||||
|
||||
If you experience performance issues or repeated queries become slower to execute, consider clearing your cache. |
||||
|
||||
> **Note:** This action impacts all cache-enabled data sources. If you are using Memcached, the system clears all data from the Memcached instance. |
||||
|
||||
**To clear the cache**: |
||||
|
||||
1. Sign in to Grafana and click **Settings > Data Sources**. |
||||
1. Select a data source. |
||||
1. Click the **Cache** tab. |
||||
1. Click **Clear cache**. |
||||
|
||||
## Sending a request without cache |
||||
|
||||
If a 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. |
||||
Loading…
Reference in new issue