IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-20 11:48:34 -06:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Reorganize Dashboards and add note for escalations issue 2013 (#46902)

Browse Source 
* Initial commit.

* Update version number

* Initial commit.

* More formatting changes. Also added URL links.

* Ran prettier.
This commit is contained in:
achatterjee-grafana 2022-03-24 09:46:08 -04:00 committed by GitHub
parent 8329cd59f6
commit c42b0d7498
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 129 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
docs/sources/dashboards/_index.md
View File

@ -4,58 +4,25 @@ aliases = ["/docs/grafana/latest/features/dashboard/dashboards/"]
weight = 80
+++
# Dashboard overview
# About Grafana dashboards
A _dashboard_ is a set of one or more panels organized and arranged into one or more rows. Grafana ships with a variety of Panels. Grafana makes it easy to construct the right queries, and customize the display properties so that you can create the perfect dashboard for your need. Each panel can interact with data from any configured Grafana Data Source (currently Graphite, Prometheus, Elasticsearch, InfluxDB, OpenTSDB, MySQL, PostgreSQL, Microsoft SQL Server and AWS Cloudwatch).
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" >}}).
## Dashboard UI
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.
<img src="/static/img/docs/v50/dashboard_annotated.png" class="no-shadow" width="700px">
Before you begin, ensure that you have configured a data source. See also:
1. Zoom out time range
1. Time picker dropdown. Here you can access relative time range options, auto refresh options and set custom absolute time ranges.
1. Manual refresh button. Will cause all panels to refresh (fetch new data).
1. Dashboard panel. Click the panel title to edit panels.
1. Graph legend. You can change series colors, y-axis and series visibility directly from the legend.
## Dashboard header
Click the new Dashboard link on the right side of the Dashboard picker. You now have a blank Dashboard.
<img class="no-shadow" src="/static/img/docs/v50/top_nav_annotated.png" width="580px">
The image above shows you the top header for a Dashboard.
1. Side menubar toggle: This toggles the side menu, allowing you to focus on the data presented in the dashboard. The side menu provides access to features unrelated to a Dashboard such as Users, Organizations, and Data Sources.
1. Dashboard dropdown: This dropdown shows you which Dashboard you are currently viewing, and allows you to easily switch to a new Dashboard. From here you can also create a new Dashboard or folder, import existing Dashboards, and manage Dashboard playlists.
1. Add Panel: Adds a new panel to the current Dashboard.
1. Star Dashboard: Star (or unstar) the current Dashboard. Starred Dashboards will show up on your own Home Dashboard by default, and are a convenient way to mark Dashboards that you're interested in.
1. Share Dashboard: Share the current dashboard by creating a link or create a static Snapshot of it. Make sure the Dashboard is saved before sharing.
1. Save dashboard: The current Dashboard will be saved with the current Dashboard name.
1. Settings: Manage Dashboard settings and features such as Templating and Annotations.
## Manage dashboards
The time period for the dashboard can be controlled by the [Time range controls]({{< relref "time-range-controls.md" >}}) in the upper right of the dashboard.
Dashboards can use [templating]({{< relref "../variables/_index.md" >}}) to make them more dynamic and interactive.
Dashboards can 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.
You can [share dashboards]({{< relref "../sharing/share-dashboard.md" >}}) in a variety of ways.
Dashboards can be tagged, and the dashboard picker provides quick, searchable access to all dashboards in a particular organization.
## Rows
A _row_ is a logical divider within a dashboard. It is used to group panels together.
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.
We use a unit abstraction so that Grafana looks great on all screen sizes.
> **Note:** With MaxDataPoint functionality, Grafana can show you the perfect number of data points, regardless of resolution or time range.
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.
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.
- [Working with Grafana dashboard UI]({{< relref "./dashboard-ui/_index.md" >}})
- [Dashboard folders]({{< relref "./dashboard-folders.md" >}})
- [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" >}})

6
docs/sources/dashboards/annotations.md
View File

@ -2,16 +2,16 @@
title = "Annotations"
keywords = ["grafana", "annotations", "documentation", "guide"]
aliases = ["/docs/grafana/latest/reference/annotations/"]
weight = 2
weight = 9
+++
# Annotations
{{< figure src="/static/img/docs/v46/annotations.png" max-width="800px" >}}
Annotations provide a way to mark points on the graph with rich events. When you hover over an annotation
you can get event description and event tags. The text field can include links to other systems with more detail.
{{< figure src="/static/img/docs/v46/annotations.png" max-width="800px" >}}
## 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 "../http_api/annotations.md" >}}).

11
docs/sources/dashboards/dashboard-create.md Normal file
View File

@ -0,0 +1,11 @@
+++
title = "Create dashboards"
aliases = ["/docs/grafana/latest/features/dashboard/dashboards/"]
weight = 7
+++
## Create dashboard
To create a new dashboard:
Click the new dashboard link on the right side of the time picker. A blank dashboard is created.

17
docs/sources/dashboards/dashboard-manage.md Normal file
View File

@ -0,0 +1,17 @@
+++
title = "Manage dashboards"
aliases = ["/docs/grafana/latest/features/dashboard/dashboards/"]
weight = 8
+++
## Manage dashboards
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.
- 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 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.

19
docs/sources/dashboards/dashboard-ui/_index.md Normal file
View File

@ -0,0 +1,19 @@
+++
title = " Dashboard UI"
aliases = ["/docs/grafana/latest/features/dashboard/dashboards/"]
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.md" >}}) and [Dashboard rows]({{< relref "./dashboard-row.md" >}}).

21
docs/sources/dashboards/dashboard-ui/dashboard-header.md Normal file
View File

@ -0,0 +1,21 @@
+++
title = "Dashboard header"
aliases = ["/docs/grafana/latest/features/dashboard/dashboards/"]
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 homw 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.

21
docs/sources/dashboards/dashboard-ui/dashboard-row.md Normal file
View File

@ -0,0 +1,21 @@
+++
title = "Dashboard rows"
aliases = ["/docs/grafana/latest/features/dashboard/dashboards/"]
weight = 80
+++
# Dshboard 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/_index.md#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.

2
docs/sources/dashboards/dashboard_folders.md
View File

@ -2,7 +2,7 @@
title = "Dashboard Folders"
keywords = ["grafana", "dashboard", "dashboard folders", "folder", "folders", "documentation", "guide"]
aliases = ["/docs/grafana/latest/reference/dashboard_folders/"]
weight = 3
weight = 6
+++
# Dashboard Folders

6
docs/sources/dashboards/dashboard_history.md
View File

@ -1,11 +1,11 @@
+++
title = "Dashboard Version History"
title = "Dashboard version history"
keywords = ["grafana", "dashboard", "documentation", "version", "history"]
aliases = ["/docs/grafana/latest/reference/dashboard_history/"]
weight = 100
weight = 14
+++
# Dashboard Version History
# Dashboard version history
Whenever you save a version of your dashboard, a copy of that version is saved so that previous versions of your dashboard are never lost. A list of these versions is available by entering the dashboard settings and then selecting "Versions" in the left side menu.

16
docs/sources/dashboards/playlist.md
View File

@ -2,17 +2,23 @@
title = "Playlist"
keywords = ["grafana", "dashboard", "documentation", "playlist"]
aliases = ["/docs/grafana/latest/reference/playlist/"]
weight = 4
weight = 9
+++
# Playlist
A playlist displays a list of dashboards that are in a sequence. Use a playlist to build situational awareness or to present your metrics to your team or visitors. Grafana automatically scales dashboards to any resolution, which makes them perfect for big screens. This topic has the following sections:
- [Access, share, and control a playlist](#access-share-and-control-a-playlist)
- [Create a playlist](#create-a-playlist)
- [Edit or delete a playlist](#edit-or-delete-a-playlist)
- [Share a playlist](#share-a-playlist-in-a-view-mode)
- [Playlist](#playlist)
- [Access, share, and control a playlist](#access-share-and-control-a-playlist)
- [Access playlist](#access-playlist)
- [Start a playlist](#start-a-playlist)
- [Control a playlist](#control-a-playlist)
- [Create a playlist](#create-a-playlist)
- [Edit or delete a playlist](#edit-or-delete-a-playlist)
- [Edit a playlist](#edit-a-playlist)
- [Delete a playlist](#delete-a-playlist)
- [Share a playlist in a view mode](#share-a-playlist-in-a-view-mode)
## Access, share, and control a playlist

2
docs/sources/dashboards/reporting.md
View File

@ -3,7 +3,7 @@ title = "Reporting"
description = ""
keywords = ["grafana", "reporting"]
aliases = ["/docs/grafana/latest/administration/reports"]
weight = 8
weight = 10
+++
# Reporting

2
docs/sources/dashboards/search.md
View File

@ -2,7 +2,7 @@
title = "Search"
keywords = ["grafana", "dashboard", "documentation", "search"]
aliases =["/docs/grafana/latest/reference/search/"]
weight = 5
weight = 9
+++
# Dashboard Search

2
docs/sources/dashboards/shortcuts.md
View File

@ -1,6 +1,6 @@
+++
title = "Keyboard shortcuts"
weight = 7
weight = 10
+++
# Keyboard shortcuts

2
docs/sources/dashboards/time-range-controls.md
View File

@ -2,7 +2,7 @@
title = "Time range controls"
keywords = ["grafana", "dashboard", "documentation", "time range"]
aliases = ["/docs/grafana/latest/reference/timerange/"]
weight = 7
weight = 13
+++
# Time range controls