From f29b70b442a63c87e209168118c8da030adb2524 Mon Sep 17 00:00:00 2001 From: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Date: Wed, 13 May 2020 06:52:12 -0700 Subject: [PATCH] Docs: Create add-a-panel.md (#24598) * Create add-a-panel.md * Update add-a-panel.md --- docs/sources/panels/add-a-panel.md | 64 ++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 docs/sources/panels/add-a-panel.md diff --git a/docs/sources/panels/add-a-panel.md b/docs/sources/panels/add-a-panel.md new file mode 100644 index 00000000000..10ab770cb03 --- /dev/null +++ b/docs/sources/panels/add-a-panel.md @@ -0,0 +1,64 @@ ++++ +title = "Add a panel" +type = "docs" +[menu.docs] +identifier = "add-a-panel" +parent = "panels" +weight = 100 +draft = "true" ++++ + +# Add a panel + +Panels allow you to show your data in visual form. This topic walks you through the most basic steps to build a panel. + +## 1. Add a panel to a dashboard + +1. Navigate to the dashboard you want to add a panel to. +1. Click the **Add panel** icon. + + ![](/img/docs/panels/add-panel-icon-7-0.png) + +1. Click **Add new panel**. + +Grafana creates an empty graph panel with your default data source selected. + +## 2. Edit panel settings + +While not required, we recommend that you add a helpful title and description to your panel. You can use [variables you have defined]({{< relref "../variables/templates-and-variables.md" >}}) in either field, but not [global variables]({{< relref "../variables/global-variables.md" >}}). + +![](/img/docs/panels/panel-settings-7-0.png) + +**Panel title -** Text entered in this field is displayed at the top of your panel in the Panel editor and in the dashboard. + +**Description -** Text entered in this field is displayed in a tooltip in the upper left corner of the panel. Write a description of the panel and the data you are displaying. Pretend you are explaining it to a new user six months from now, when it is no longer fresh in your mind. Future editors (possibly yourself) will thank you. + +## 3. Write a query + +Each panel needs at least one query to display a visualization. You write queries in the Query tab of the Panel editor. For more information about the Query tab, refer to [Queries]({{< relref "queries.md" >}}). + +1. Choose a data source. In the first line of the Query tab, click the drop-down list to see all available data sources. This list includes all data sources you added. Refer to [Add a data source]({{< relref "../features/datasources/add-a-data-source.md" >}}) if you need instructions. +1. Write or construct a query in the query language of your data source. Options will vary. Refer to your specific [data source documentation]({{< relref "../features/datasources/_index.md" >}}) for specific guidelines. + +## 4. Choose a visualization type + +In the Visualization section of the Panel tab, click a visualization type. Grafana displays a preview of your query results with that visualization applied. + +For more information about individual visualizations, refer to [Visualizations](ADD LINK) + +## 5. Apply changes and save + +Save the dashboard. Either press Ctrl/Cmd+S or click **Save** in the upper right corner of the screen. + +Your options vary depending on the changes you made and whether or not it is a new dashboard. We recommend you add a note to describe your changes before you click **Save**. Notes are very helpful if you need to revert the dashboard to a previous version. + +## What next? + +Our Grafana Fundamentals tutorial is a great place to start, or you can learn more about Grafana by reading one of the documentation topics linked below: + +- Learn more Panel editor options. +- Add more queries. +- Transform your data. +- Change how your results are displayed in the visualization. +- Set up an alert. +- Create templates and variables. \ No newline at end of file