mirror of https://github.com/grafana/grafana
Docs: combines use dashboard content into single topic (#51527)
* combines use dashboard content into single topic * Some minor updates * corrects spelling Co-authored-by: Torkel Ödegaard <torkel@grafana.com>pull/51558/head^2
Christopher Moyer
3 years ago
committed by
GitHub
parent
48501d5bb7
commit
40e72c6de3
@ -1,21 +0,0 @@ |
|||||||
--- |
|
||||||
aliases: |
|
||||||
- /docs/grafana/latest/dashboards/dashboard-ui/ |
|
||||||
- /docs/grafana/latest/features/dashboard/dashboards/ |
|
||||||
title: ' Dashboard UI' |
|
||||||
weight: 2 |
|
||||||
--- |
|
||||||
|
|
||||||
# Working with Grafana dashboard UI |
|
||||||
|
|
||||||
The dashboard UI has the following sections to allow you to customize the presentation of data. |
|
||||||
|
|
||||||
<img src="/static/img/docs/v50/dashboard_annotated.png" class="no-shadow" width="700px"> |
|
||||||
|
|
||||||
- **Zoom out time range** (1) |
|
||||||
- **Time picker dropdown** (2). Access relative time range options, auto refresh options and set custom absolute time ranges. |
|
||||||
- **Manual refresh option** (3) Fetch new data. |
|
||||||
- **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/" >}}) and [Dashboard rows]({{< relref "dashboard-row/" >}}). |
|
||||||
@ -1,23 +0,0 @@ |
|||||||
--- |
|
||||||
aliases: |
|
||||||
- /docs/grafana/latest/dashboards/dashboard-ui/dashboard-header/ |
|
||||||
- /docs/grafana/latest/features/dashboard/dashboards/ |
|
||||||
title: Dashboard header |
|
||||||
weight: 80 |
|
||||||
--- |
|
||||||
|
|
||||||
## Dashboard header |
|
||||||
|
|
||||||
The dashboard header has the following sections. |
|
||||||
|
|
||||||
<img class="no-shadow" src="/static/img/docs/v50/top_nav_annotated.png" width="580px"> |
|
||||||
|
|
||||||
- **Side menubar toggle** (1): This option toggles the side menu. It provides access to features unrelated to a dashboard such as users, organizations, data sources, and alerting. |
|
||||||
- **Dashboard dropdown** (2): Use this option to view the current dashboard name. From here, you can: |
|
||||||
- Select another dashboard name to easily switch to that dashboard. |
|
||||||
- Create a new dashboard or folder, import existing dashboards, and manage dashboard playlists. |
|
||||||
- **Add panel** (3): Use this option to add a new panel to the current dashboard. |
|
||||||
- **Star dashboard** (4): Use this option to star (or unstar) the current dashboard. Starred dashboards show up on your own home dashboard by default. It is a convenient way to mark Dashboards that you're interested in. |
|
||||||
- **Share dashboard** (5): Use this option to share the current dashboard by creating a link or create a static snapshot of it. You must save the dashboard before sharing. |
|
||||||
- **Save dashboard** (6): Use this option to save the current dashboard using its current name. |
|
||||||
- **Settings** (7): Use this option to manage dashboard settings and configure templates and annotations. |
|
||||||
@ -1,23 +0,0 @@ |
|||||||
--- |
|
||||||
aliases: |
|
||||||
- /docs/grafana/latest/dashboards/dashboard-ui/dashboard-row/ |
|
||||||
- /docs/grafana/latest/features/dashboard/dashboards/ |
|
||||||
title: Dashboard rows |
|
||||||
weight: 80 |
|
||||||
--- |
|
||||||
|
|
||||||
# Dashboard rows |
|
||||||
|
|
||||||
A dashboard row is a logical divider within a dashboard. It is used to group panels together. |
|
||||||
|
|
||||||
Grafana uses a base unit abstraction so that dashboards and panels look great on all screen sizes. Dashboard rows are always 12 “units” wide. These units are automatically scaled dependent on the horizontal resolution of your browser. You can control the relative width of panels within a row by setting their specific width. |
|
||||||
|
|
||||||
> **Note:** With MaxDataPoint functionality, Grafana can show you the perfect number of data points, regardless of resolution or time range. |
|
||||||
|
|
||||||
## Create or remove rows |
|
||||||
|
|
||||||
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 |
|
||||||
|
|
||||||
Collapse a row by clicking on the row title. If you save a dashboard with a row collapsed, then it saves in that state and does not load those graphs until you expand the row. |
|
||||||
@ -1,49 +0,0 @@ |
|||||||
--- |
|
||||||
aliases: |
|
||||||
- /docs/grafana/latest/dashboards/search/ |
|
||||||
- /docs/grafana/latest/reference/search/ |
|
||||||
keywords: |
|
||||||
- grafana |
|
||||||
- dashboard |
|
||||||
- documentation |
|
||||||
- search |
|
||||||
title: Search |
|
||||||
weight: 9 |
|
||||||
--- |
|
||||||
|
|
||||||
# Dashboard Search |
|
||||||
|
|
||||||
Dashboards can be searched by the dashboard name, filtered by one (or many) tags or filtered by starred status. The dashboard search is accessed through the dashboard picker, available in the dashboard top nav area. The dashboard search can also be opened by using the shortcut `F`. |
|
||||||
|
|
||||||
<img class="no-shadow" src="/static/img/docs/v50/dashboard_search_annotated.png" width="700px"> |
|
||||||
|
|
||||||
1. `Search Bar`: The search bar allows you to enter any string and search both database and file based dashboards in real-time. |
|
||||||
1. `Starred`: Here you find all your starred dashboards. |
|
||||||
1. `Recent`: Here you find the latest created dashboards. |
|
||||||
1. `Folders`: The tags filter allows you to filter the list by dashboard tags. |
|
||||||
1. `Root`: The root contains all dashboards that are not placed in a folder. |
|
||||||
1. `Tags`: The tags filter allows you to filter the list by dashboard tags. |
|
||||||
|
|
||||||
When using only a keyboard, you can use your keyboard arrow keys to navigate the results, hit enter to open the selected dashboard. |
|
||||||
|
|
||||||
## Find by dashboard name |
|
||||||
|
|
||||||
Begin typing any part of the desired dashboard names in the search bar. Search will return results for any partial string match in real-time, as you type. |
|
||||||
|
|
||||||
Dashboard search is: |
|
||||||
|
|
||||||
- Real-time |
|
||||||
- _Not_ case sensitive |
|
||||||
- Functional across stored _and_ file based dashboards. |
|
||||||
|
|
||||||
## Filter by Tag(s) |
|
||||||
|
|
||||||
Tags are a great way to organize your dashboards, especially as the number of dashboards grow. Tags can be added and managed in the dashboard `Settings`. |
|
||||||
|
|
||||||
To filter the dashboard list by tag, click on any tag appearing in the right column. The list may be further filtered by clicking on additional tags: |
|
||||||
|
|
||||||
Alternately, to see a list of all available tags, click the tags dropdown menu. All tags will be shown, and when a tag is selected, the dashboard search will be instantly filtered: |
|
||||||
|
|
||||||
When using only a keyboard: `tab` to focus on the _tags_ link, `▼` down arrow key to find a tag and select with the `Enter` key. |
|
||||||
|
|
||||||
> **Note:** When multiple tags are selected, Grafana will show dashboards that include **all**. |
|
||||||
@ -1,18 +0,0 @@ |
|||||||
--- |
|
||||||
aliases: |
|
||||||
- /docs/grafana/latest/dashboards/shortcuts/ |
|
||||||
title: Keyboard shortcuts |
|
||||||
weight: 10 |
|
||||||
--- |
|
||||||
|
|
||||||
# Keyboard shortcuts |
|
||||||
|
|
||||||
Grafana has a number of keyboard shortcuts available. Press `?` or `h` on your keyboard to display all keyboard shortcuts available in your version of Grafana. |
|
||||||
|
|
||||||
**Popular shortcuts:** |
|
||||||
|
|
||||||
- Ctrl+S saves the current dashboard. |
|
||||||
- Ctrl+F opens the dashboard finder / search. |
|
||||||
- Ctrl+H hides all controls (good for tv displays). |
|
||||||
- Ctrl+K opens the command palette. |
|
||||||
- Press Escape to exit graph when in fullscreen or edit mode. |
|
||||||
@ -0,0 +1,115 @@ |
|||||||
|
--- |
||||||
|
aliases: |
||||||
|
- /docs/grafana/latest/dashboards/dashboard-ui/ |
||||||
|
- /docs/grafana/latest/dashboards/dashboard-ui/dashboard-header/ |
||||||
|
- /docs/grafana/latest/features/dashboard/dashboards/ |
||||||
|
- /docs/grafana/latest/dashboards/dashboard-ui/dashboard-row/ |
||||||
|
- /docs/grafana/latest/features/dashboard/dashboards/ |
||||||
|
- /docs/grafana/latest/dashboards/shortcuts/ |
||||||
|
- /docs/grafana/latest/dashboards/search/ |
||||||
|
- /docs/grafana/latest/reference/search/ |
||||||
|
title: 'Use dashboards' |
||||||
|
menuTitle: Use dashboards |
||||||
|
weight: 2 |
||||||
|
keywords: |
||||||
|
- dashboard |
||||||
|
- search |
||||||
|
- shortcuts |
||||||
|
--- |
||||||
|
|
||||||
|
# Use dashboards |
||||||
|
|
||||||
|
The dashboard UI has the following sections to allow you to customize the presentation of data. |
||||||
|
|
||||||
|
{{< figure src="/static/img/docs/v50/dashboard_annotated.png" class="no-shadow" width="700px" >}} |
||||||
|
|
||||||
|
- **Zoom out time range** (1) |
||||||
|
- **Time picker dropdown** (2). Access relative time range options, auto refresh options and set custom absolute time ranges. |
||||||
|
- **Refresh option** (3) Click to trigger queries or set auto refresh. |
||||||
|
- **Dashboard panel** (4) Click the panel title to open panel menu. |
||||||
|
- **Graph legend** (5) Change series colors, y-axis and series visibility directly from the legend. |
||||||
|
|
||||||
|
For more details, see [Dashboard header]({{< relref "#dashboard-header" >}}) and [Dashboard rows]({{< relref "#dashboard-rows" >}}). |
||||||
|
|
||||||
|
## Dashboard header |
||||||
|
|
||||||
|
The dashboard header has the following sections. |
||||||
|
|
||||||
|
{{< figure src="/static/img/docs/v50/top_nav_annotated.png" width="450px" >}} |
||||||
|
|
||||||
|
- **Dashboard title** (2): This also opens the dashboard search when clicked. |
||||||
|
- **Add panel** (3): Use this option to add a new panel or row to the current dashboard. |
||||||
|
- **Star dashboard** (4): Use this option to star (or unstar) the current dashboard. Starred dashboards show up on your own home dashboard by default. It is a convenient way to mark Dashboards that you're interested in. |
||||||
|
- **Share dashboard** (5): Use this option to share the current dashboard by link or snapshot. You can also export the dashboard definition from the share modal. |
||||||
|
- **Save dashboard** (6): Use this option to save the current dashboard using its current name. |
||||||
|
- **Settings** (7): Use this option to open dashboard settings. Here you change dashboard name, folder, tags as well as manage variables and annotation queries. |
||||||
|
|
||||||
|
## Dashboard panels |
||||||
|
|
||||||
|
The main building block of dashboard is the panel. You add new panels via the `Add panel` button at the top of the dashboard. This will add view at the top where you can choose if you want to add a new panel, row or library panel. Library panels are panels that can be shared (reused) in many dashboards. You can move panels around by just dragging the panel header. To resize panel use the lower right corner. |
||||||
|
|
||||||
|
## Dashboard rows |
||||||
|
|
||||||
|
A dashboard row is a logical divider within a dashboard. It is used to group panels together. Rows can be collapsed or expanded allowing you to hide parts of the dashboard. Panels inside a collapsed row will not issue any queries. |
||||||
|
|
||||||
|
Use the [repeating rows]({{< relref "../panels/add-panels-dynamically/configure-repeating-rows" >}}) to dynamically create rows based on a template variable. |
||||||
|
|
||||||
|
## Keyboard shortcuts |
||||||
|
|
||||||
|
Grafana has a number of keyboard shortcuts available. Press `?` or `h` on your keyboard to display all keyboard shortcuts available in your version of Grafana. |
||||||
|
|
||||||
|
- `Ctrl+S`: Saves the current dashboard. |
||||||
|
- `f`: Opens the dashboard finder / search. |
||||||
|
- `d+k`: Toggle kiosk mode (hides the menu). |
||||||
|
- `d+e`: Expand all rows. |
||||||
|
- `d+s`: Dashboard settings. |
||||||
|
- `Ctrl+K`: Opens the command palette. |
||||||
|
- `Esc`: Exits panel when in fullscreen view or edit mode. Also returns you to the dashboard from dashboard settings. |
||||||
|
|
||||||
|
**Focused Panel** |
||||||
|
|
||||||
|
By hovering over a panel with the mouse you can use some shortcuts that will target that panel. |
||||||
|
|
||||||
|
- `e`: Toggle panel edit view |
||||||
|
- `v`: Toggle panel fullscreen view |
||||||
|
- `ps`: Open Panel Share Modal |
||||||
|
- `pd`: Duplicate Panel |
||||||
|
- `pr`: Remove Panel |
||||||
|
- `pl`: Toggle panel legend |
||||||
|
|
||||||
|
## Dashboard Search |
||||||
|
|
||||||
|
Dashboards can be searched by the dashboard name, filtered by one (or many) tags or filtered by starred status. The dashboard search is accessed through the dashboard picker, available in the dashboard top nav area. The dashboard search can also be opened by using the shortcut `F`. |
||||||
|
|
||||||
|
{{< figure src="/static/img/docs/v50/dashboard_search_annotated.png" width="700px" >}} |
||||||
|
|
||||||
|
1. `Search Bar`: The search bar allows you to enter any string and search both database and file based dashboards in real-time. |
||||||
|
1. `Starred`: Here you find all your starred dashboards. |
||||||
|
1. `Recent`: Here you find the latest created dashboards. |
||||||
|
1. `Folders`: The tags filter allows you to filter the list by dashboard tags. |
||||||
|
1. `Root`: The root contains all dashboards that are not placed in a folder. |
||||||
|
1. `Tags`: The tags filter allows you to filter the list by dashboard tags. |
||||||
|
|
||||||
|
When using only a keyboard, you can use your keyboard arrow keys to navigate the results, hit enter to open the selected dashboard. |
||||||
|
|
||||||
|
### Find by dashboard name |
||||||
|
|
||||||
|
Begin typing any part of the desired dashboard names in the search bar. Search will return results for any partial string match in real-time, as you type. |
||||||
|
|
||||||
|
Dashboard search is: |
||||||
|
|
||||||
|
- Real-time |
||||||
|
- _Not_ case sensitive |
||||||
|
- Functional across stored _and_ file based dashboards. |
||||||
|
|
||||||
|
### Filter by Tag(s) |
||||||
|
|
||||||
|
Tags are a great way to organize your dashboards, especially as the number of dashboards grow. Tags can be added and managed in the dashboard `Settings`. |
||||||
|
|
||||||
|
To filter the dashboard list by tag, click on any tag appearing in the right column. The list may be further filtered by clicking on additional tags: |
||||||
|
|
||||||
|
Alternately, to see a list of all available tags, click the tags dropdown menu. All tags will be shown, and when a tag is selected, the dashboard search will be instantly filtered: |
||||||
|
|
||||||
|
When using only a keyboard: `tab` to focus on the _tags_ link, `▼` down arrow key to find a tag and select with the `Enter` key. |
||||||
|
|
||||||
|
> **Note:** When multiple tags are selected, Grafana will show dashboards that include **all**. |
||||||
Loading…
Reference in new issue