Docs: Setup refactor (#49739)
* builds out refactored setup topics * Automatically fix some relrefs with mv-manager Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Use refs for tutorials content which is outside of this repository Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Manually fix complicated relrefs Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * consolidates team sync and db encryption topics * Fix relrefs Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * updates setup index file * Convert TOML to YAML Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Add current alias for new alerting content Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Add current aliases to new setup-grafana and configure-security pages Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/setup-grafana/configure-grafana/_index.md Co-authored-by: Torkel Ödegaard <torkel@grafana.com> * moves saml docs, updates order in TOC * Manually fix relrefs Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * added usage insights topics, adjusted weights * corrected relrefs * Fix relrefs broken in rebase Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
This commit is contained in:
Christopher Moyer
co-authored by
Torkel Ödegaard
Jack Baldry
Torkel Ödegaard
Jack Baldry
parent
104c4a7630
commit
a568d421f8
@@ -8,23 +8,23 @@ weight: 80
|
||||
|
||||
# About Grafana dashboards
|
||||
|
||||
A dashboard is a set of one or more [panels]({{< relref "../panels/_index.md" >}}) organized and arranged into one or more rows. Grafana ships with a variety of panels making it easy to construct the right queries, and customize the visualization so that you can create the perfect dashboard for your need. Each panel can interact with data from any configured Grafana [data source]({{< relref "../datasources/_index.md" >}}).
|
||||
A dashboard is a set of one or more [panels]({{< relref "../panels/" >}}) organized and arranged into one or more rows. Grafana ships with a variety of panels making it easy to construct the right queries, and customize the visualization so that you can create the perfect dashboard for your need. Each panel can interact with data from any configured Grafana [data source]({{< relref "../datasources/" >}}).
|
||||
|
||||
Dashboard snapshots are static . Queries and expressions cannot be re-executed from snapshots. As a result, if you update any variables in your query or expression, it will not change your dashboard data.
|
||||
|
||||
Before you begin, ensure that you have configured a data source. See also:
|
||||
|
||||
- [Working with Grafana dashboard UI]({{< relref "dashboard-ui/_index.md" >}})
|
||||
- [Dashboard folders]({{< relref "dashboard-folders.md" >}})
|
||||
- [Working with Grafana dashboard UI]({{< relref "dashboard-ui/" >}})
|
||||
- [Dashboard folders]({{< relref "dashboard-folders/" >}})
|
||||
- [Create dashboard]({{< relref "dashboard-create/" >}})
|
||||
- [Manage dashboards]({{< relref "dashboard-manage.md" >}})
|
||||
- [Annotations]({{< relref "annotations.md" >}})
|
||||
- [Playlist]({{< relref "playlist.md" >}})
|
||||
- [Search]({{< relref "search.md" >}})
|
||||
- [Keyboard shortcuts]({{< relref "shortcuts.md" >}})
|
||||
- [Reporting]({{< relref "reporting.md" >}})
|
||||
- [Time range controls]({{< relref "time-range-controls.md" >}})
|
||||
- [Dashboard version history]({{< relref "dashboard-history.md" >}})
|
||||
- [Dashboard export and import]({{< relref "export-import.md" >}})
|
||||
- [Dashboard JSON model]({{< relref "json-model.md" >}})
|
||||
- [Scripted dashboards]({{< relref "scripted-dashboards.md" >}})
|
||||
- [Manage dashboards]({{< relref "dashboard-manage/" >}})
|
||||
- [Annotations]({{< relref "annotations/" >}})
|
||||
- [Playlist]({{< relref "playlist/" >}})
|
||||
- [Search]({{< relref "search/" >}})
|
||||
- [Keyboard shortcuts]({{< relref "shortcuts/" >}})
|
||||
- [Reporting]({{< relref "reporting/" >}})
|
||||
- [Time range controls]({{< relref "time-range-controls/" >}})
|
||||
- [Dashboard version history]({{< relref "dashboard-history/" >}})
|
||||
- [Dashboard export and import]({{< relref "export-import/" >}})
|
||||
- [Dashboard JSON model]({{< relref "json-model/" >}})
|
||||
- [Scripted dashboards]({{< relref "scripted-dashboards/" >}})
|
||||
|
||||
@@ -20,7 +20,7 @@ you can get event description and event tags. The text field can include links t
|
||||
|
||||
## Native annotations
|
||||
|
||||
Grafana comes with a native annotation store and the ability to add annotation events directly from the graph panel or via the [HTTP API]({{< relref "../developers/http_api/annotations.md" >}}).
|
||||
Grafana comes with a native annotation store and the ability to add annotation events directly from the graph panel or via the [HTTP API]({{< relref "../developers/http_api/annotations/" >}}).
|
||||
|
||||
## Adding annotations
|
||||
|
||||
@@ -76,4 +76,4 @@ to show.
|
||||
|
||||
### Annotation query details
|
||||
|
||||
The annotation query options are different for each data source. For information about annotations in a specific data source, refer to the specific [data source]({{< relref "../datasources/_index.md" >}}) topic.
|
||||
The annotation query options are different for each data source. For information about annotations in a specific data source, refer to the specific [data source]({{< relref "../datasources/" >}}) topic.
|
||||
|
||||
@@ -18,7 +18,7 @@ weight: 6
|
||||
|
||||
Folders are a way to organize and group dashboards - very useful if you have a lot of dashboards or multiple teams using the same Grafana instance.
|
||||
|
||||
> **Note:** Only Grafana Admins and Super Admins can create, edit, or delete folders. Refer to [Dashboard permissions]({{< relref "../administration/manage-users-and-permissions/about-users-and-permissions.md#dashboard-permissions" >}}) for more information.
|
||||
> **Note:** Only Grafana Admins and Super Admins can create, edit, or delete folders. Refer to [Dashboard permissions]({{< relref "../administration/manage-users-and-permissions/about-users-and-permissions/#dashboard-permissions" >}}) for more information.
|
||||
|
||||
## How To Create A Folder
|
||||
|
||||
@@ -55,5 +55,5 @@ The Dashboard Folder Page is similar to the Manage Dashboards page and is where
|
||||
|
||||
Permissions can be assigned to a folder and inherited by the containing dashboards. An Access Control List (ACL) is used where
|
||||
**Organization Role**, **Team** and Individual **User** can be assigned permissions. Read the
|
||||
[Dashboard permissions]({{< relref "../administration/manage-users-and-permissions/about-users-and-permissions.md#dashboard-permissions" >}}) docs for more detail
|
||||
[Dashboard permissions]({{< relref "../administration/manage-users-and-permissions/about-users-and-permissions/#dashboard-permissions" >}}) docs for more detail
|
||||
about permissions.
|
||||
|
||||
@@ -10,10 +10,10 @@ weight: 8
|
||||
|
||||
When managing dashboads, you can use:
|
||||
|
||||
- Select a time period for a dashboard using the [Time range controls]({{< relref "time-range-controls.md" >}}) in the upper right of the dashboard.
|
||||
- Select a time period for a dashboard using the [Time range controls]({{< relref "time-range-controls/" >}}) in the upper right of the dashboard.
|
||||
- Tag dashboards.
|
||||
- Use [templating]({{< relref "../variables/_index.md" >}}) to make them more dynamic and interactive.
|
||||
- Use [annotations]({{< relref "annotations.md" >}}) to display event data across panels. This can help correlate the time series data in the panel with other events.
|
||||
- Use [templating]({{< relref "../variables/" >}}) to make them more dynamic and interactive.
|
||||
- Use [annotations]({{< relref "annotations/" >}}) to display event data across panels. This can help correlate the time series data in the panel with other events.
|
||||
- Use the dashboard picker for quick, searchable access to all dashboards in a particular organization.
|
||||
|
||||
You can also [share dashboards]({{< relref "../sharing/share-dashboard.md" >}}) in a variety of ways.
|
||||
You can also [share dashboards]({{< relref "../sharing/share-dashboard/" >}}) in a variety of ways.
|
||||
|
||||
@@ -18,4 +18,4 @@ The dashboard UI has the following sections to allow you to customize the presen
|
||||
- **Dashboard panel** (4) Click the panel title to edit panels.
|
||||
- **Graph legend** (5) Change series colors, y-axis and series visibility directly from the legend.
|
||||
|
||||
For more details, see [Dashboard header]({{< relref "dashboard-header.md" >}}) and [Dashboard rows]({{< relref "dashboard-row.md" >}}).
|
||||
For more details, see [Dashboard header]({{< relref "dashboard-header/" >}}) and [Dashboard rows]({{< relref "dashboard-row/" >}}).
|
||||
|
||||
@@ -16,7 +16,7 @@ Grafana uses a base unit abstraction so that dashboards and panels look great on
|
||||
|
||||
## Create or remove rows
|
||||
|
||||
Use the [repeating rows]({{< relref "../../variables/_index.md#repeating-rows" >}}) functionality to dynamically create or remove entire rows, which can be filled with panels, based on the template variables selected.
|
||||
Use the [repeating rows]({{< relref "../../variables/#repeating-rows" >}}) functionality to dynamically create or remove entire rows, which can be filled with panels, based on the template variables selected.
|
||||
|
||||
## Collapse rows
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ weight: 800
|
||||
|
||||
# Export and import
|
||||
|
||||
Grafana Dashboards can easily be exported and imported, either from the UI or from the [HTTP API]({{< relref "../developers/http_api/dashboard.md#create-update-dashboard" >}}).
|
||||
Grafana Dashboards can easily be exported and imported, either from the UI or from the [HTTP API]({{< relref "../developers/http_api/dashboard/#create-update-dashboard" >}}).
|
||||
|
||||
## Exporting a dashboard
|
||||
|
||||
|
||||
@@ -27,8 +27,8 @@ You can view dashboard previews only when the feature is enabled for your instan
|
||||
|
||||
## 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 "../image-rendering/" >}}) for more information.
|
||||
2. Modify the [configuration file]({{< relref "../administration/configuration.md#configuration-file-location" >}}) to enable the `dashboardPreviews` [feature toggle]({{< relref "../administration/configuration.md#feature_toggles" >}}).
|
||||
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]
|
||||
@@ -44,7 +44,7 @@ Verify that your setup was successful in the dashboard search page. You should s
|
||||
|
||||
The first crawler run should begin approximately five minutes after restarting the Grafana instance.
|
||||
|
||||
In case you see any warnings after clicking on the toggle, check [Grafana server logs]({{< relref "../administration/configuration.md#log" >}}) for more context. The logger used by the Previews Service is named `previews_service`.
|
||||
In case you see any warnings after clicking on the toggle, 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" >}}
|
||||
|
||||
@@ -56,7 +56,7 @@ The dashboard previews crawler is a background process that:
|
||||
- [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 "../administration/configuration.md#dashboard_previews" >}}) for more details.
|
||||
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
|
||||
|
||||
@@ -74,7 +74,7 @@ Modifying a dashboard is the only way of refreshing that dashboard's preview; pr
|
||||
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 "../image-rendering/#rendering-mode" >}}) clustering mode in Image Renderer to further optimize crawler's resource usage.
|
||||
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
|
||||
|
||||
|
||||
@@ -16,4 +16,4 @@ Reporting allows you to generate PDFs from any of your dashboards and have them
|
||||
|
||||
{{< figure src="/static/img/docs/enterprise/reports_list.png" max-width="500px" class="docs-image--no-shadow" >}}
|
||||
|
||||
> Reporting is only available in Grafana Enterprise, v6.4 or later. For more information, refer to [Reporting]({{< relref "../enterprise/reporting.md" >}}) in [Grafana Enterprise]({{< relref "../enterprise/" >}}).
|
||||
> Reporting is only available in Grafana Enterprise, v6.4 or later. For more information, refer to [Reporting]({{< relref "../enterprise/reporting/" >}}) in [Grafana Enterprise]({{< relref "../enterprise/" >}}).
|
||||
|
||||
@@ -123,7 +123,7 @@ For more advanced time settings, click the **Dashboard settings** (gear) icon at
|
||||
|
||||
## Panel time overrides and timeshift
|
||||
|
||||
In [Query options]({{< relref "../panels/query-options.md" >}}), you can override the relative time range for individual panels, causing them to be different than what is selected in the dashboard time picker in the upper right. This allows you to show metrics from different time periods or days at the same time.
|
||||
In [Query options]({{< relref "../panels/query-options/" >}}), you can override the relative time range for individual panels, causing them to be different than what is selected in the dashboard time picker in the upper right. This allows you to show metrics from different time periods or days at the same time.
|
||||
|
||||
> **Note:** Panel time overrides have no effect when the time range for the dashboard is absolute.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user