mirror of https://github.com/grafana/grafana
Docs: Add and organize panels (#51763)
* combines topics into add and organize panels topic * updates front matter * fixes relrefs * fixes typo * Update docs/sources/dashboards/add-organize-panels.md Co-authored-by: Torkel Ödegaard <torkel@grafana.com> * Update docs/sources/dashboards/add-organize-panels.md Co-authored-by: Torkel Ödegaard <torkel@grafana.com> * make prettier Co-authored-by: Torkel Ödegaard <torkel@grafana.com>sql-an
parent
4fa606c600
commit
e4bf7ddefe
@ -0,0 +1,108 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/panels/working-with-panels/navigate-panel-editor/ |
||||
- /docs/grafana/latest/panels/working-with-panels/navigate-inspector-panel/ |
||||
- /docs/grafana/latest/dashboards/dashboard-create/ |
||||
- /docs/grafana/latest/features/dashboard/dashboards/ |
||||
- /docs/grafana/latest/panels/working-with-panels/add-panel/ |
||||
- /docs/grafana/latest/dashboards/add-organize-panels/ |
||||
title: Add and organize panels |
||||
menuTitle: Add and organize panels |
||||
weight: 2 |
||||
--- |
||||
|
||||
# Add and organize panels |
||||
|
||||
This section describes the areas of the Grafana panel editor. |
||||
|
||||
1. Panel header: The header section lists the dashboard in which the panel appears and the following controls: |
||||
|
||||
- **Dashboard settings (gear) icon -** Click to access the dashboard settings. |
||||
- **Discard -** Discards changes you have made to the panel since you last saved the dashboard. |
||||
- **Save -** Saves changes you made to the panel. |
||||
- **Apply -** Applies changes you made and closes the panel editor, returning you to the dashboard. You will have to save the dashboard to persist the applied changes. |
||||
|
||||
1. Visualization preview: The visualization preview section contains the following options: |
||||
|
||||
- **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/" >}}). |
||||
|
||||
1. Data section: The data section contains tabs where you enter queries, transform your data, and create alert rules (if applicable). |
||||
|
||||
- **Query tab -** Select your data source and enter queries here. For more information, refer to [Add a query]({{< relref "../panels/query-a-data-source/add-a-query/" >}}). |
||||
- **Transform tab -** Apply data transformations. For more information, refer to [Transform data]({{< relref "../panels/transform-data/" >}}). |
||||
- **Alert tab -** Write alert rules. For more information, refer to [Overview of Grafana 8 alerting]({{< relref "../alerting/" >}}). |
||||
|
||||
1. Panel display options: The display options section contains tabs where you configure almost every aspect of your data visualization, including: |
||||
|
||||
- [Apply color to series and fields]({{< relref "../panels/working-with-panels/apply-color-to-series/" >}}) |
||||
- [Format a standard field]({{< relref "../panels/working-with-panels/format-standard-fields/" >}}) |
||||
- [Add a title and description to a panel]({{< relref "../panels/working-with-panels/add-title-and-description/" >}}) |
||||
|
||||
> Not all options are available for each visualization. |
||||
|
||||
{{< figure src="/static/img/docs/panel-editor/panel-editor-8-0.png" class="docs-image--no-shadow" max-width="1500px" >}} |
||||
|
||||
## Open the panel inspect drawer |
||||
|
||||
The inspect drawer helps you understand and troubleshoot your panels. You can view the raw data for any panel, export that data to a comma-separated values (CSV) file, view query requests, and export panel and data JSON. |
||||
|
||||
> **Note:** Not all panel types include all tabs. For example, dashboard list panels do not have raw data to inspect, so they do not display the Stats, Data, or Query tabs. |
||||
|
||||
The panel inspector consists of the following options: |
||||
|
||||
1. The panel inspect drawer displays opens a drawer on the right side. Click the arrow in the upper right corner to expand or reduce the drawer pane. |
||||
|
||||
1. **Data tab -** Shows the raw data returned by the query with transformations applied. Field options such as overrides and value mappings are not applied by default. |
||||
|
||||
1. **Stats tab -** Shows how long your query takes and how much it returns. |
||||
|
||||
1. **JSON tab -** Allows you to view and copy the panel JSON, panel data JSON, and data frame structure JSON. This is useful if you are provisioning or administering Grafana. |
||||
|
||||
1. **Query tab -** Shows you the requests to the server sent when Grafana queries the data source. |
||||
|
||||
1. **Error tab -** Shows the error. Only visible when query returns error. |
||||
|
||||
## Create a dashboard and add a panel |
||||
|
||||
Dashboards and panels allow you to show your data in visual form. Each panel needs at least one query to display a visualization. |
||||
|
||||
**Before you begin:** |
||||
|
||||
- Ensure that you have the proper permissions. For more information about permissions, refer to [About users and permissions]({{< relref "../administration/roles-and-permissions/" >}}). |
||||
- Identify the dashboard to which you want to add the panel. |
||||
- Understand the query language of the target data source. |
||||
- Ensure that data source for which you are writing a query has been added. For more information about adding a data source, refer to [Add a data source]({{< relref "../datasources/add-a-data-source/" >}}) if you need instructions. |
||||
|
||||
**To create a dashboard and add a panel**: |
||||
|
||||
1. Sign in to Grafana, hover your cursor over **Dashboard**, and click **+ New Dashboard**. |
||||
1. Click **Add a new panel**. |
||||
1. In the first line of the **Query** tab, click the drop-down list and select a data source. |
||||
1. Write or construct a query in the query language of your data source. |
||||
|
||||
For more information about data sources, refer to [Data sources]({{< relref "../datasources/" >}}) for specific guidelines. |
||||
|
||||
1. In the Visualization list, select a visualization type. |
||||
|
||||
Grafana displays a preview of your query results with the visualization applied. |
||||
|
||||
 |
||||
|
||||
For more information about individual visualizations, refer to [Visualizations options]({{< relref "../visualizations/" >}}). |
||||
|
||||
1. Refer to the following documentation for ways you can adjust panel settings. |
||||
|
||||
While not required, most visualizations need some adjustment before they properly display the information that you need. |
||||
|
||||
- [Format data using value mapping]({{< relref "../panels/format-data/about-value-mapping/" >}}) |
||||
- [Visualization-specific options]({{< relref "../visualizations/" >}}) |
||||
- [Override field values]({{< relref "../panels/override-field-values/about-field-overrides/" >}}) |
||||
- [Configure thresholds]({{< relref "../panels/configure-thresholds/" >}}) |
||||
- [Apply color to series and fields]({{< relref "../panels/working-with-panels/apply-color-to-series/" >}}) |
||||
|
||||
1. Add a note to describe the visualization (or describe your changes) and then click **Save** in the upper-right corner of the page. |
||||
|
||||
Notes can be helpful if you need to revert the dashboard to a previous version. |
@ -1,57 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/panels/working-with-panels/add-panel/ |
||||
- /docs/sources/panels/working-with-panels/add-panel/ |
||||
title: Add a panel to a dashboard |
||||
weight: 20 |
||||
--- |
||||
|
||||
# Add a panel to a dashboard |
||||
|
||||
Panels allow you to show your data in visual form. Each panel needs at least one query to display a visualization. |
||||
|
||||
## Before you begin |
||||
|
||||
- Ensure that you have the proper permissions. For more information about permissions, refer to [About users and permissions]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions/" >}}). |
||||
- Identify the dashboard to which you want to add the panel. |
||||
- Understand the query language of the target data source. |
||||
- Ensure that data source for which you are writing a query has been added. For more information about adding a data source, refer to [Add a data source]({{< relref "../../datasources/add-a-data-source/" >}}) if you need instructions. |
||||
|
||||
**To add a panel to a dashboard**: |
||||
|
||||
1. Navigate to the dashboard to which you want to add a panel. |
||||
1. Click the **Add panel** icon. |
||||
|
||||
 |
||||
|
||||
1. Click **Add an empty panel**. |
||||
|
||||
Grafana creates an empty time-series panel and selects the default data source. |
||||
|
||||
1. In the first line of the **Query** tab, click the drop-down list and select a data source. |
||||
|
||||
1. Write or construct a query in the query language of your data source. |
||||
|
||||
For more information about data sources, refer to [Data sources]({{< relref "../../datasources/" >}}) for specific guidelines. |
||||
|
||||
1. In the Visualization list, select a visualization type. |
||||
|
||||
Grafana displays a preview of your query results with the visualization applied. |
||||
|
||||
 |
||||
|
||||
For more information about individual visualizations, refer to [Visualizations options]({{< relref "../../visualizations/" >}}). |
||||
|
||||
1. Refer to the following documentation for ways you adjust panel settings. |
||||
|
||||
While not required, most visualizations need some adjustment before they properly display the information that you need. |
||||
|
||||
- [Format data using value mapping]({{< relref "../format-data/about-value-mapping/" >}}) |
||||
- [Visualization-specific options]({{< relref "../../visualizations/" >}}) |
||||
- [Override field values]({{< relref "../override-field-values/about-field-overrides/" >}}) |
||||
- [Configure thresholds]({{< relref "../configure-thresholds/" >}}) |
||||
- [Apply color to series and fields]({{< relref "apply-color-to-series/" >}}) |
||||
|
||||
1. Add a note to describe the visualization (or describe your changes) and then click **Save** in the upper-right corner of the page. |
||||
|
||||
Notes can be helpful if you need to revert the dashboard to a previous version. |
@ -1,42 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/panels/working-with-panels/navigate-panel-editor/ |
||||
- /docs/sources/panels/working-with-panels/navigate-panel-editor/ |
||||
title: Navigate the Grafana panel editor |
||||
weight: 10 |
||||
--- |
||||
|
||||
# Navigate the Grafana panel editor |
||||
|
||||
This page describes the parts of the Grafana panel editor. |
||||
|
||||
1. Panel header: The header section lists the dashboard in which the panel appears and the following controls: |
||||
|
||||
- **Dashboard settings (gear) icon -** Click to access the dashboard settings. |
||||
- **Discard -** Discards changes you have made to the panel since you last saved the dashboard. |
||||
- **Save -** Saves changes you made to the panel. |
||||
- **Apply -** Applies changes you made and closes the panel editor, returning you to the dashboard. You will have to save the dashboard to persist the applied changes. |
||||
|
||||
2. Visualization preview: The visualization preview section contains the following options: |
||||
|
||||
- **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 "../../dashboards/time-range-controls/" >}}). |
||||
|
||||
3. Data section: The data section contains tabs where you enter queries, transform your data, and create alert rules (if applicable). |
||||
|
||||
- **Query tab -** Select your data source and enter queries here. For more information, refer to [Add a query]({{< relref "../query-a-data-source/add-a-query/" >}}). |
||||
|
||||
- **Transform tab -** Apply data transformations. For more information, refer to [Transform data]({{< relref "../transform-data/" >}}). |
||||
- **Alert tab -** Write alert rules. For more information, refer to [Overview of Grafana 8 alerting]({{< relref "../../alerting/" >}}). |
||||
|
||||
4. Panel display options: The display options section contains tabs where you configure almost every aspect of your data visualization, including: |
||||
|
||||
- [Apply color to series and fields]({{< relref "apply-color-to-series/" >}}) |
||||
- [Format a standard field]({{< relref "format-standard-fields/" >}}) |
||||
- [Add a title and description to a panel]({{< relref "add-title-and-description/" >}}) |
||||
|
||||
> Not all options are available for each visualization. |
||||
|
||||
{{< figure src="/static/img/docs/panel-editor/panel-editor-8-0.png" class="docs-image--no-shadow" max-width="1500px" >}} |
Loading…
Reference in new issue