diff --git a/docs/sources/administration/organization-preferences/_index.md b/docs/sources/administration/organization-preferences/_index.md index 98094f28af5..2d69cace737 100644 --- a/docs/sources/administration/organization-preferences/_index.md +++ b/docs/sources/administration/organization-preferences/_index.md @@ -147,7 +147,7 @@ Organization administrators can choose a default timezone for their organization 1. Hover your cursor over the **Configuration** (gear) icon. 1. Click **Preferences**. -1. Click to select an option in the **Timezone** list. **Default** is either the browser local timezone or the timezone selected at a higher level. Refer to [Time range controls]({{< relref "../../dashboards/time-range-controls/" >}}) for more information about Grafana time settings. +1. Click to select an option in the **Timezone** list. **Default** is either the browser local timezone or the timezone selected at a higher level. Refer to [Time range controls]({{< relref "../../dashboards/manage-dashboards/#configure-dashboard-time-range-controls" >}}) for more information about Grafana time settings. 1. Click **Save**. ### Set team timezone @@ -157,7 +157,7 @@ Organization administrators and team administrators can choose a default timezon 1. Hover your cursor over the **Configuration** (gear) icon in the side menu. 1. Click **Teams**. Grafana displays the team list. 1. Click on the team you that you want to change the timezone for and then navigate to the **Settings** tab. -1. Click to select an option in the **Timezone** list. **Default** is either the browser local timezone or the timezone selected at a higher level. Refer to [Time range controls]({{< relref "../../dashboards/time-range-controls/" >}}) for more information about Grafana time settings. +1. Click to select an option in the **Timezone** list. **Default** is either the browser local timezone or the timezone selected at a higher level. Refer to [[Time range controls]({{< relref "../../dashboards/manage-dashboards/#configure-dashboard-time-range-controls" >}}) for more information about Grafana time settings. 1. Click **Save**. ### Set your personal timezone @@ -165,7 +165,7 @@ Organization administrators and team administrators can choose a default timezon You can change the timezone for your user account. This setting overrides timezone settings at higher levels. 1. On the left menu, hover your cursor over your avatar and then click **Preferences**. -1. Click to select an option in the **Timezone** list. **Default** is either the browser local timezone or the timezone selected at a higher level. Refer to [Time range controls]({{< relref "../../dashboards/time-range-controls/" >}}) for more information about Grafana time settings. +1. Click to select an option in the **Timezone** list. **Default** is either the browser local timezone or the timezone selected at a higher level. Refer to [Time range controls]({{< relref "../../dashboards/manage-dashboards/#configure-dashboard-time-range-controls" >}}) for more information about Grafana time settings. 1. Click **Save**. ## Change the default home dashboard diff --git a/docs/sources/administration/roles-and-permissions/access-control/_index.md b/docs/sources/administration/roles-and-permissions/access-control/_index.md index 2057cd9d1cb..7f84ef7a171 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/_index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/_index.md @@ -82,7 +82,7 @@ Assign fixed roles when the basic roles do not meet your permission requirements - [Dashboards and folders]({{< relref "../../../dashboards/" >}}) - [Data sources]({{< relref "../../../datasources/" >}}) - [Explore]({{< relref "../../../explore/" >}}) -- [Folders]({{< relref "../../../dashboards/dashboard-folders/" >}}) +- [Folders]({{< relref "../../../dashboards/manage-dashboards/#create-a-dashboard-folder" >}}) - [LDAP]({{< relref "../../../setup-grafana/configure-security/configure-authentication/ldap/" >}}) - [Licenses]({{< relref "../../stats-and-license/" >}}) - [Organizations]({{< relref "../../organization-management/" >}}) diff --git a/docs/sources/dashboards/_index.md b/docs/sources/dashboards/_index.md index 0a87fea41eb..6863bfd9f55 100644 --- a/docs/sources/dashboards/_index.md +++ b/docs/sources/dashboards/_index.md @@ -10,14 +10,14 @@ weight: 80 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 "../administration/data-source-management/" >}}). -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. +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: - [Use dashboards]({{< relref "use-dashboards/" >}}) -- [Dashboard folders]({{< relref "dashboard-folders/" >}}) +- [Create dashboard folders]({{< relref "./manage-dashboards/#create-a-dashboard-folder" >}}) - [Add and organize panels]({{< relref "add-organize-panels/" >}}) -- [Manage dashboards]({{< relref "dashboard-manage/" >}}) +- [Manage dashboards]({{< relref "./manage-dashboards" >}}) - [Public dashboards]({{< relref "dashboard-public/" >}}) - [Annotations]({{< relref "annotations/" >}}) - [Playlist]({{< relref "./create-manage-playlists/" >}}) @@ -26,4 +26,3 @@ Before you begin, ensure that you have configured a data source. See also: - [Dashboard version history]({{< relref "dashboard-history/" >}}) - [Dashboard export and import]({{< relref "export-import/" >}}) - [Dashboard JSON model]({{< relref "json-model/" >}}) -- [Scripted dashboards]({{< relref "scripted-dashboards/" >}}) diff --git a/docs/sources/dashboards/add-organize-panels/index.md b/docs/sources/dashboards/add-organize-panels/index.md index e0bded34f93..a80d286195d 100644 --- a/docs/sources/dashboards/add-organize-panels/index.md +++ b/docs/sources/dashboards/add-organize-panels/index.md @@ -36,7 +36,7 @@ This section describes the areas of the Grafana panel editor. - **Table view:** Convert any visualization to a table so that you can see the data. Table views are useful for troubleshooting. - **Fill:** The visualization preview fills the available space. If you change the width of the side pane or height of the bottom pane the visualization changes to fill the available space. - **Actual:** The visualization preview will have the exact size as the size on the dashboard. If not enough space is available, the visualization will scale down preserving the aspect ratio. - - **Time range controls:** For more information, refer to [Time range controls]({{< relref "time-range-controls/" >}}). + - **Time range controls:** For more information, refer to [Time range controls]({{< relref "../manage-dashboards/#configure-dashboard-time-range-controls" >}}). 1. Data section: The data section contains tabs where you enter queries, transform your data, and create alert rules (if applicable). diff --git a/docs/sources/dashboards/dashboard-folders.md b/docs/sources/dashboards/dashboard-folders.md deleted file mode 100644 index 29445b66930..00000000000 --- a/docs/sources/dashboards/dashboard-folders.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -aliases: - - /docs/grafana/latest/dashboards/dashboard-folders/ - - /docs/grafana/latest/reference/dashboard_folders/ -keywords: - - grafana - - dashboard - - dashboard folders - - folder - - folders - - documentation - - guide -title: Dashboard Folders -weight: 6 ---- - -# Dashboard Folders - -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/roles-and-permissions/#dashboard-permissions" >}}) for more information. - -## How To Create A Folder - -- Create a folder by using the **New folder** link in the side menu (under the **Dashboards** menu) -- Use the **New folder** button on the **Browse dashboards** page. -- When saving a dashboard, you can either choose a folder for the dashboard to be saved in or create a new folder - -On the New folder page, fill in a unique name for the folder and then click Create. - -## Manage Dashboards - -{{< figure src="/static/img/docs/v50/manage_dashboard_menu.png" max-width="300px" class="docs-image--right" >}} - -There is a new Manage Dashboards page where you can carry out a variety of tasks: - -- create a folder -- create a dashboard -- move dashboards into folders -- delete multiple dashboards -- navigate to a folder page (where you can set permissions for a folder and/or its dashboards) - -## Dashboard Folder Page - -You reach the dashboard folder page by clicking on the cog icon that appears when you hover -over a folder in the dashboard list in the search result or on the Manage dashboards page. - -The Dashboard Folder Page is similar to the Manage Dashboards page and is where you can carry out the following tasks: - -- Allows you to move or delete dashboards in a folder. -- Rename a folder (under the Settings tab). -- Set permissions for the folder (inherited by dashboards in the folder). - -## Permissions - -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/roles-and-permissions/#dashboard-permissions" >}}) docs for more detail -about permissions. diff --git a/docs/sources/dashboards/export-import.md b/docs/sources/dashboards/export-import.md deleted file mode 100644 index 220a9bfbd5a..00000000000 --- a/docs/sources/dashboards/export-import.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -aliases: - - /docs/grafana/latest/dashboards/export-import/ - - /docs/grafana/latest/reference/export_import/ -keywords: - - grafana - - dashboard - - documentation - - export - - import -title: Export and import -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/#create-update-dashboard" >}}). - -## Exporting a dashboard - -Dashboards are exported in Grafana JSON format, and contain everything you need (layout, variables, styles, data sources, queries, etc) to import the dashboard at a later time. - -The export feature is accessed in the share window which you open by clicking the share button in the dashboard menu. - -{{< figure src="/static/img/docs/export/export-modal.png" max-width="800px" >}} - -### Making a dashboard portable - -If you want to export a dashboard for others to use then it could be a good idea to -add template variables for things like a metric prefix (use constant variable) and server name. - -A template variable of the type `Constant` will automatically be hidden in -the dashboard, and will also be added as a required input when the dashboard is imported. - -## Import dashboard - -To import a dashboard click **Import** under the **Dashboards** icon in the side menu. - -{{< figure src="/static/img/docs/v70/import_step1.png" max-width="700px" >}} - -From here you can upload a dashboard JSON file, paste a [Grafana.com](https://grafana.com) dashboard -URL or paste dashboard JSON text directly into the text area. - -{{< figure src="/static/img/docs/v70/import_step2_grafana.com.png" max-width="700px" >}} - -In step 2 of the import process Grafana will let you change the name of the dashboard, pick what -data source you want the dashboard to use and specify any metric prefixes (if the dashboard use any). - -## Discover dashboards on Grafana.com - -Find dashboards for common server applications at [Grafana.com/dashboards](https://grafana.com/dashboards). - -{{< figure src="/static/img/docs/v50/gcom_dashboard_list.png" max-width="700px" >}} - -## Import and sharing with Grafana 2.x or 3.0 - -Dashboards on Grafana.com use a new feature in Grafana 3.1 that allows the import process -to update each panel so that they are using a data source of your choice. If you are running a -Grafana version older than 3.1 then you might need to do some manual steps either -before or after import in order for the dashboard to work properly. - -Dashboards exported from Grafana 3.1+ have a new json section `__inputs` -that define what data sources and metric prefixes the dashboard uses. - -Example: - -```json -{ - "__inputs": [ - { - "name": "DS_GRAPHITE", - "label": "graphite", - "description": "", - "type": "datasource", - "pluginId": "graphite", - "pluginName": "Graphite" - }, - { - "name": "VAR_PREFIX", - "type": "constant", - "label": "prefix", - "value": "collectd", - "description": "" - } - ] -} -``` - -These are then referenced in the dashboard panels like this: - -```json -{ - "rows": [ - { - "panels": [ - { - "type": "graph", - "datasource": "${DS_GRAPHITE}" - } - ] - } - ] -} -``` - -These inputs and their usage in data source properties are automatically added during export in Grafana 3.1. -If you run an older version of Grafana and want to share a dashboard on Grafana.com you need to manually -add the inputs and templatize the data source properties like above. - -If you want to import a dashboard from Grafana.com into an older version of Grafana then you can either import -it as usual and then update the data source option in the metrics tab so that the panel is using the correct -data source. Another alternative is to open the json file in a text editor and update the data source properties -to value that matches a name of your data source. - -## Note - -In Grafana v5.3.4+ the export modal has new checkbox for sharing for external use (other instances). If the checkbox is not checked then the `__inputs` section will not be included in the exported JSON file. diff --git a/docs/sources/dashboards/manage-dashboards/index.md b/docs/sources/dashboards/manage-dashboards/index.md new file mode 100644 index 00000000000..04c20bd1aa6 --- /dev/null +++ b/docs/sources/dashboards/manage-dashboards/index.md @@ -0,0 +1,319 @@ +--- +aliases: + - /docs/grafana/latest/dashboards/dashboard-manage/ + - /docs/grafana/latest/features/dashboard/dashboards/ + - /docs/grafana/latest/dashboards/dashboard-folders/ + - /docs/grafana/latest/reference/dashboard_folders/ + - /docs/grafana/latest/dashboards/export-import/ + - /docs/grafana/latest/reference/export_import/ + - /docs/grafana/latest/troubleshooting/troubleshoot-dashboards/ + - /docs/grafana/latest/dashboards/time-range-controls/ + - /docs/grafana/latest/reference/timerange/ + - /docs/grafana/latest/panels/working-with-panels/organize-dashboard/ + - /docs/grafana/latest/dashboards/manage-dashboards/ +title: Manage dashboards +menuTitle: Manage dashboards +weight: 8 +eywords: + - grafana + - dashboard + - dashboard folders + - folder + - folders + - import + - export + - troubleshoot + - time range + - scripting +--- + +# Manage dashboards + +A dashboard is a set of one or more [panels]({{< relref "../../panels/" >}}) that visually presents your data in one or more rows. + +For more information about creating dashboards, refer to [Add and organize panels](../add-organize-panels). + +This topic includes techniques you can use to manage your Grafana dashboards, including: + +- [Creating and managing dashboard folders](#create-and-manage-dashboard-folders) +- [Exporting and importing dashboards](#export-and-import-dashboards) +- [Configuring dashboard time range controls](#configure-dashboard-time-range-controls) +- [Organizing dashboards](#organize-a-dashboard) +- [Troubleshooting dashboards](#troubleshoot-dashboards) + +## Create a dashboard folder + +Folders help you organize and group dashboards, which is useful when you have many dashboards or multiple teams using the same Grafana instance. + +**Before you begin:** + +- Ensure that you have Grafana Admin or Super Admin permissions. For more information about dashboard permissions, refer to [Dashboard permissions]({{< relref "../../administration/roles-and-permissions/#dashboard-permissions" >}}). + +**To create a dashboard folder:** + +1. Sign in to Grafana and on the side menu, click **Dashboards > New folder**. +1. Enter a unique name and click **Create**. + +When you save a dashboard, you can either select a folder for the dashboard to be saved in or create a new folder. + +## Manage dashboards + +{{< figure src="/static/img/docs/v50/manage_dashboard_menu.png" max-width="300px" class="docs-image--right" >}} + +On the **Manage dashboards and folders** page, you can: + +- create a folder +- create a dashboard +- move dashboards into folders +- delete multiple dashboards +- navigate to a folder page where you can assign folder and dashboard permissions + +### Dashboard folder page + +You can complete the following tasks on the **Dashboard Folder** page: + +- Move or delete dashboards in a folder +- Rename a folder (available under the **Settings** tab) +- Assign permissions to folders (which are inherited by the dashboards in the folder) + +To navigate to the dashboard folder page, click the cog appears when you hover over a folder in the dashboard search result list or the **Manage dashboards and folders** page. + +### Dashboard permissions + +You can assign permissions to a folder. Any permissions you assign are inherited by the dashboards in the folder. An Access Control List (ACL) is used where **Organization Role**, **Team** and a **User** can be assigned permissions. + +For more information about dashboard permissions, refer to [Dashboard permissions]({{< relref "../../administration/roles-and-permissions/#dashboard-permissions" >}}). + +## Export and import dashboards + +You can use the Grafana UI or the [HTTP API]({{< relref "../../developers/http_api/dashboard/#create-update-dashboard" >}}) to export and import dashboards. + +### Export a dashboard + +The dashboard export action creates a Grafana JSON file that contains everything you need, including layout, variables, styles, data sources, queries, and so on, so that you can later import the dashboard. + +1. Open the dashboard you want to export. +2. Click the **Share** icon. +3. Click **Export**. +4. Click **Save to file**. + +Grafana downloads a JSON file to your local machine. + +{{< figure src="/static/img/docs/export/export-modal.png" max-width="800px" >}} + +#### Make a dashboard portable + +If you want to export a dashboard for others to use, you can add template variables for things like a metric prefix (use a constant variable) and server name. + +A template variable of the type `Constant` will automatically be hidden in the dashboard, and will also be added as a required input when the dashboard is imported. + +### Import a dashboard + +1. Click **Dashboards > Import** in the side menu. + + {{< figure src="/static/img/docs/v70/import_step1.png" max-width="700px" >}} + +1. Perform one of the following steps: + + - Upload a dashboard JSON file + - Paste a [Grafana.com](https://grafana.com) dashboard URL + - Paste dashboard JSON text directly into the text area + +{{< figure src="/static/img/docs/v70/import_step2_grafana.com.png" max-width="700px" >}} + +The import process enables you to change the name of the dashboard, pick the data source you want the dashboard to use, and specify any metric prefixes (if the dashboard uses any). + +### Discover dashboards on Grafana.com + +Find dashboards for common server applications at [Grafana.com/dashboards](https://grafana.com/dashboards). + +{{< figure src="/static/img/docs/v50/gcom_dashboard_list.png" max-width="700px" >}} + +## Configure dashboard time range controls + +Grafana provides several ways to manage the time ranges of the data being visualized, for dashboard, panels and also for alerting. + +This section describes supported time units and relative ranges, the common time controls, dashboard-wide time settings, and panel-specific time settings. + +### Time units and relative ranges + +Grafana supports the following time units: `s (seconds)`, `m (minutes)`, `h (hours)`, `d (days)`, `w (weeks)`, `M (months)`, `Q (quarters)` and `y (years)`. + +The minus operator enables you to step back in time, relative to now. If you want to display the full period of the unit (day, week, month, etc...), append `/