From 8dee5d33643875539d9f2458e74062808f1de700 Mon Sep 17 00:00:00 2001 From: Artur Wierzbicki Date: Fri, 12 May 2023 21:10:33 +0400 Subject: [PATCH] Previews: remove docs (#68042) remove dashboard preview docs --- .../search/dashboard-previews/index.md | 106 ------------------ .../setup-grafana/configure-grafana/_index.md | 24 ---- .../setup-grafana/image-rendering/_index.md | 23 ---- 3 files changed, 153 deletions(-) delete mode 100644 docs/sources/search/dashboard-previews/index.md diff --git a/docs/sources/search/dashboard-previews/index.md b/docs/sources/search/dashboard-previews/index.md deleted file mode 100644 index d4618860f78..00000000000 --- a/docs/sources/search/dashboard-previews/index.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -aliases: - - ../dashboards/previews/ - - ../reference/previews/ -keywords: - - grafana - - dashboard - - documentation - - previews -title: Dashboard previews -weight: 9 ---- - -# Dashboard previews - -{{< video-embed src="/static/img/docs/dashboards/previews.webm" max-width="950px" >}} - -Dashboard previews provide an overview of all available dashboards. They help you quickly find the right dashboard when the dashboard names aren't enough on their own. - -> **Warning:** The dashboard previews feature is deprecated and will be removed in Grafana v10. - -The dashboard previews feature is an opt-in feature that is disabled by default. You can view dashboard previews after an administrator enables the feature, and after you select the new grid layout. The feature-enablement procedure is outlined in the following section. - -- [Enable dashboard previews](#enable-dashboard-previews) -- [About the dashboard previews crawler](#about-the-dashboard-previews-crawler) -- [Permissions](#permissions) - -## Enable dashboard previews - -1. Install the Image Renderer plugin or set up a remote rendering service. The minimum version of Image Renderer required for the dashboard preview feature `3.4.0`. Refer to [Image rendering]({{< relref "../../setup-grafana/image-rendering/" >}}) for more information. -2. Modify the [configuration file]({{< relref "../../setup-grafana/configure-grafana/#configuration-file-location" >}}) to enable the `dashboardPreviews` [feature toggle]({{< relref "../../setup-grafana/configure-grafana/#feature_toggles" >}}). - -``` -[feature_toggles] -# enable features, separated by spaces -enable = dashboardPreviews -``` - -3. If running Grafana Enterprise with RBAC, enable [service accounts]({{< relref "../../administration/service-accounts/" >}}). - -4. Save your changes. Grafana should reload automatically; we recommend restarting the Grafana server in case of any issues. - -The first crawler run should begin approximately five minutes after Grafana server restart. - -To determine that your setup is successful, select the new grid layout and verify that the dashboard preview placeholders appear. - -{{< video-embed src="/static/img/docs/dashboards/previews-successful-setup.webm" max-width="950px" >}} - -If the dashboard preview placeholders do not appear or if you see any warning messages, check [Grafana server logs]({{< relref "../../setup-grafana/configure-grafana/#log" >}}) for more context. The logger used by the Previews Service is named `previews_service`. - -{{< figure src="/static/img/docs/dashboards/previews-unsuccessful-setup.png" max-width="950px" >}} - -## About the dashboard previews crawler - -The dashboard previews crawler is a background process that: - -- [Prepares a list of dashboards to visit](#preparing-the-dashboard-list) -- [Visits and takes a screenshot of each dashboard](#rendering-previews) -- [Saves the screenshots in persistent storage](#saving-previews) - -The crawler can be configured via the main config file. Check the [dashboard previews section]({{< relref "../../setup-grafana/configure-grafana/#dashboard_previews" >}}) for more details. - -### Preparing the dashboard list - -During the initial crawler run, the list contains all dashboards across all organizations. -During subsequent runs, the list will have fewer elements. It will only contain dashboards that: - -- are new -- have changed since taking their last preview -- haven't changed, but the crawler failed to take their preview during the initial run - -Modifying a dashboard is the only way of refreshing that dashboard's preview; previews do not have a set timeout after which they expire. - -### Rendering previews - -The crawler sends a render request to the Image Renderer for each dashboard in the list. The renderer is then instructed to open the dashboard in kiosk mode, take a screenshot, and scale it down to a small, 320 x 240px thumbnail. The following dashboard in Grafana Play is an example of kiosk mode: https://play.grafana.org/playlists/play/1?kiosk. - -Multiple render requests are issued concurrently to improve performance. The maximum number of concurrent requests can be configured via the `dashboard_previews.crawler.thread_count` config option. -Use the new [contextPerRenderKey]({{< relref "../../setup-grafana/image-rendering/#rendering-mode" >}}) clustering mode in Image Renderer to further optimize crawler's resource usage. - -### Saving previews - -The crawler saves previews and their metadata in Grafana's DB. Preview's metadata contains, among other things, the [dashboard version]({{< relref "../../dashboards/build-dashboards/manage-version-history" >}}) from the time of taking the screenshot. During subsequent runs, the crawler uses the saved version to find stale dashboard previews. - -## Permissions - -### Crawler permissions - -The crawler is set up with the required permissions to display all dashboards and query all data sources. The way the permissions are set up depends on the version of Grafana. - -In OSS and Enterprise Grafana instances without RBAC enabled, the crawler uses a special user with an `Admin` role. -In an Enterprise Grafana instance with RBAC enabled, the crawler uses [service accounts]({{< relref "../../administration/service-accounts/" >}}) with three fixed roles: - -- `fixed:dashboards:reader` -- `fixed:datasources:reader` -- `fixed:folders:reader` - -{{< figure src="/static/img/docs/dashboards/previews-service-account.png" max-width="950px" >}} - -Service accounts are created per organization. They are visible in the service account configuration tab, and use the following naming convention: `dashboard-previews-crawler-{organization_id}`. - -### Preview visibility - -Currently, users can see the previews of all dashboards they have access to. Data source permissions are not yet taken into account - users can see previews of dashboards with data sources they can't see or query. - -Data source permission check work is still ongoing - we will add it before moving the feature out of beta and announcing general availability. diff --git a/docs/sources/setup-grafana/configure-grafana/_index.md b/docs/sources/setup-grafana/configure-grafana/_index.md index 15a877018f8..bf807529227 100644 --- a/docs/sources/setup-grafana/configure-grafana/_index.md +++ b/docs/sources/setup-grafana/configure-grafana/_index.md @@ -2226,30 +2226,6 @@ default_baselayer_config = `{ Set this to `false` to disable loading other custom base maps and hide them in the Grafana UI. Default is `true`. -## [dashboard_previews] - -### [crawler] - -> **Note:** This feature is available in Grafana v9.0 and later versions. - -#### thread_count - -Number of dashboards rendered in parallel. Default is 6 - -#### rendering_timeout - -Timeout passed down to the Image Renderer plugin. It is used in two separate places within a single rendering request - during the initial navigation to the dashboard, and when waiting for all the panels to load. Default is 20s. - -#### max_crawl_duration - -Maximum duration of a single crawl. Default is 1h. - -#### scheduler_interval - -Minimum interval between two subsequent scheduler runs. Default is 12h. - -Refer to the [dashboards previews]({{< relref "../../search/dashboard-previews/" >}}) documentation for detailed instructions. - ## [rbac] Refer to [Role-based access control]({{< relref "../../administration/roles-and-permissions/access-control/" >}}) for more information. diff --git a/docs/sources/setup-grafana/image-rendering/_index.md b/docs/sources/setup-grafana/image-rendering/_index.md index ee4819e263b..5efbf71de4a 100644 --- a/docs/sources/setup-grafana/image-rendering/_index.md +++ b/docs/sources/setup-grafana/image-rendering/_index.md @@ -130,29 +130,6 @@ RENDERING_CLUSTERING_TIMEOUT=30 } ``` -##### Cluster mode `contextPerRenderKey` (experimental) - -> **Note:** This feature is available in Image Renderer v3.4.0 and later versions. - -In `contextPerRenderKey` mode, the plugin will reuse the same [browser context](https://chromedevtools.github.io/devtools-protocol/tot/Target/#method-createBrowserContext) for all rendering requests sharing the same `renderKey` auth cookie and target domain within a short time window. Each new request will open a new page within the existing context. Contexts are closed automatically after 5s of inactivity. - -In the case of `contextPerRenderKey` mode, the `clustering.max_concurrency` option refers to the number of open contexts rather than the number of open pages. There is no way to limit the number of open pages in a context. - -`contextPerRenderKey` was designed to improve the performance of the [dashboard previews crawler]({{< relref "../../search/dashboard-previews/#about-the-dashboard-previews-crawler" >}}). - -```json -{ - "rendering": { - "mode": "clustered", - "clustering": { - "mode": "contextPerRenderKey", - "maxConcurrency": 5, - "timeout": 30 - } - } -} -``` - #### Reusable (experimental) When using the rendering mode `reusable`, one browser instance will be created and reused. A new incognito page will be opened for each request. This mode is experimental since, if the browser instance crashes, it will not automatically be restarted. You can achieve a similar behavior using `clustered` mode with a high `maxConcurrency` setting.