Docs/panel refactor (#43569)
* new refactored panel docs * fixed links * removed xtra sharing link, added links to panel display option tasks * fixed typo * add aliases * incorporate PM feedback * intermediate commit to resolve merge conflict * final changes to resolve merge conflicts
This commit is contained in:
Christopher Moyer
@@ -42,7 +42,7 @@ In previous versions of Grafana, each visualization had slightly different ways
|
||||
|
||||
We have yet to migrate all core panels to this new architecture so in 7.0 there will be some inconsistencies in the UI between panels. This will be fixed soon in future releases as we update all the core panels and help the community update the community panel plugins.
|
||||
|
||||
Learn more about this feature in [Panel editor]({{< relref "../panels/panel-editor.md" >}}).
|
||||
Learn more about this feature in [Panel editor]({{< relref "../panels/working-with-panels/_index.md" >}}).
|
||||
|
||||
## New tracing UI
|
||||
|
||||
@@ -58,9 +58,9 @@ In the future we will add more workflows and integrations so that correlating be
|
||||
|
||||
The data you want to visualize can come from many different places and it is usually not in exactly the right form. Users can now transform non-time series data into tables (e.g., JSON files or even simple lookup tables) in seconds without any customization or additional overhead. They can then combine non-time series data with any other data in Grafana; data from an external database or a panel that already exists in one of their current dashboards.
|
||||
|
||||
By chaining a simple set of point and click [transformations]({{< relref "../panels/transformations/_index.md" >}}), users will be able join, pivot, filter, re-name and do calculations to get the results they need. Perfect for operations across queries or data sources missing essential data transformations.
|
||||
By chaining a simple set of point and click [transformations]({{< relref "../panels/reference-transformation-functions.md" >}}), users will be able join, pivot, filter, re-name and do calculations to get the results they need. Perfect for operations across queries or data sources missing essential data transformations.
|
||||
|
||||
[Transformations]({{< relref "../panels/transformations/_index.md" >}}) also adds the ability to do maths across queries. Lots of data sources do not support this natively, so being able to do it in Grafana is a powerful feature.
|
||||
[Transformations]({{< relref "../panels/transform-data/about-transformation.md" >}}) also adds the ability to do math across queries. Lots of data sources do not support this natively, so being able to do it in Grafana is a powerful feature.
|
||||
|
||||
For users with large dashboards or with heavy queries, being able to reuse the query result from one panel in another panel can be a huge performance gain for slow queries (e.g log or sql queries). From the data source menu in the query editor, you can choose the `--dashboard--` option and then choose the query result from another panel on the same dashboard.
|
||||
|
||||
@@ -78,7 +78,7 @@ We are also introducing a new shared data model for both time series and table d
|
||||
- **Outer join:** Joins many time series/tables by a field. This can be used to outer join multiple time series on the _time_ field to show many time series in one table.
|
||||
- **Add field from calculation:** This is a powerful transformation that allows you perform many different types of math operations and add the result as a new field. Can be used to calculate the difference between two series or fields and add the result to a new field. Or multiply one field with another and add the result to a new field.
|
||||
|
||||
Learn more about this feature in [Transformations]({{< relref "../panels/transformations/_index.md" >}}).
|
||||
Learn more about this feature in [Transformations]({{< relref "../panels/reference-transformation-functions.md" >}}).
|
||||
|
||||
## Field options and overrides
|
||||
|
||||
@@ -88,7 +88,7 @@ Up until now the overrides were available only for Graph and Table panel(via Col
|
||||
|
||||
This feature enables even more powerful visualizations and fine grained control over how the data is displayed.
|
||||
|
||||
Learn more about this feature in [Field overrides]({{< relref "../panels/field-overrides.md" >}}).
|
||||
Learn more about this feature in [Field overrides]({{< relref "../panels/override-field-values/about-field-overrides.md" >}}).
|
||||
|
||||
## Inspect panels and export data to CSV
|
||||
|
||||
@@ -96,7 +96,7 @@ Learn more about this feature in [Field overrides]({{< relref "../panels/field-o
|
||||
|
||||
Another new feature of Grafana 7.0 is the panel inspector. Inspect allows you to view the raw data for any Grafana panel as well as export that data to a CSV file. With Panel inspect you will also be able to perform simple raw data transformations like join, view query stats or detailed execution data.
|
||||
|
||||
Learn more about this feature in [Inspect a panel]({{< relref "../panels/inspect-panel.md" >}}).
|
||||
Learn more about this feature in [Inspect a panel]({{< relref "../panels/query-a-data-source/inspect-request-and-response-data.md" >}}).
|
||||
|
||||
<div class="clearfix"></div>
|
||||
|
||||
|
||||
@@ -73,14 +73,12 @@ You can now dynamically apply value filters to any table column. This option can
|
||||
|
||||
You can now add override rules that use a regex matcher to choose which fields to apply rules to.
|
||||
|
||||
[Field overrides]({{< relref "../panels/field-overrides.md" >}}) has been updated as a result of these changes.
|
||||
|
||||
## New transformations and enhancements
|
||||
|
||||
Grafana 7.2 includes the following transformation enhancements:
|
||||
|
||||
- A new [Group By]({{< relref "../panels/transformations/types-options.md#group-by">}}) transformation that allows you to group by multiple fields and add any number of aggregations for other fields.
|
||||
- The [Labels to fields]({{< relref "../panels/transformations/types-options.md#labels-to-fields">}}) transformation now allows you to pick one label and use that as the name of the value field.
|
||||
- A new [Group By]({{< relref "../panels/reference-transformation-functions.md#group-by">}}) transformation that allows you to group by multiple fields and add any number of aggregations for other fields.
|
||||
- The [Labels to fields]({{< relref "../panels/reference-transformation-functions.md#labels-to-fields">}}) transformation now allows you to pick one label and use that as the name of the value field.
|
||||
- You can drag transformations to reorder them. Remember that transformations are processed in the order they are listed in the UI, so think before you move something!
|
||||
|
||||
{{< figure src="/static/img/docs/v72/transformations.gif" max-width="800px" caption="Group by and reordering of transformations" >}}
|
||||
@@ -91,7 +89,7 @@ The up and down arrows, which were previously the only way to change query order
|
||||
|
||||
{{< figure src="/static/img/docs/v72/drag-queries.gif" max-width="800px" caption="Drag to reorder queries" >}}
|
||||
|
||||
The [Queries]({{< relref "../panels/queries.md" >}}) topic has been updated as a result of this change.
|
||||
The [Queries]({{< relref "../panels/query-a-data-source/add-a-query.md" >}}) topic has been updated as a result of this change.
|
||||
|
||||
## Inspect queries in Explore
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@ Another new feature that can be seen in the image above is the new image cell di
|
||||
|
||||
{{< figure src="/static/img/docs/v73/color_scheme_dropdown.png" max-width="450px" caption="Color scheme" class="pull-right" >}}
|
||||
|
||||
A new standard field [color scheme]({{< relref "../panels/standard-options.md#color-scheme" >}}) option has been added. This new option will provide a unified way for all new panels to specify how colors should be assigned.
|
||||
A new standard field color scheme option has been added. This new option will provide a unified way for all new panels to specify how colors should be assigned. For more information, refer to [Apply color to series and fields](../panels/working-with-panels/apply-color-to-series.md)
|
||||
|
||||
- **Single color**: Specifies a single color. Useful in an override rule.
|
||||
- **From thresholds**: Informs Grafana to take color from the matching threshold.
|
||||
@@ -61,7 +61,7 @@ As this new option is a standard field option it works in every panel. Here is a
|
||||
|
||||
In v7.0, we introduced a new table panel and inspect mode with Download CSV enabled. However, CSV export to Excel was removed. Due to a large number of inquiries and requests, this [community contribution from tomdaly](https://github.com/grafana/grafana/pull/27284) brought the feature back.
|
||||
|
||||
For more information, refer to [Download raw query results as CSV]({{< relref "../panels/inspect-panel/#download-raw-query-results-as-csv" >}}) in the Grafana documentation.
|
||||
For more information, refer to [Download raw query results]({{< relref "../panels/query-a-data-source/download-raw-query-results.md" >}}).
|
||||
|
||||
## Google Cloud monitoring out-of-the-box dashboards
|
||||
|
||||
|
||||
@@ -54,7 +54,7 @@ The following transformations were added in Grafana 7.4.
|
||||
|
||||
The _Sort by_ transformation allows you to sort data before sending it to the visualization.
|
||||
|
||||
For more information, refer to [Sort by]({{< relref "../panels/transformations/types-options.md#sort-by" >}}) in [Transformation types and options]({{< relref "../panels/transformations/types-options.md" >}}).
|
||||
For more information, refer to [Sort by]({{< relref "../panels/reference-transformation-functions.md#sort-by" >}}).
|
||||
|
||||
#### Filter data by value transform
|
||||
|
||||
@@ -62,13 +62,13 @@ The new _Filter data by value_ transformation allows you to filter your data dir
|
||||
|
||||
This transformation is very useful if your data source does not natively filter by values. You might also use this to narrow values to display if you are using a shared query.
|
||||
|
||||
For more information, refer to [Filter data by value]({{< relref "../panels/transformations/types-options.md#filter-data-by-value" >}}) in [Transformation types and options]({{< relref "../panels/transformations/types-options.md" >}}).
|
||||
For more information, refer to [Filter data by value]({{< relref "../panels/reference-transformation-functions.md#filter-data-by-value" >}}).
|
||||
|
||||
### New override option
|
||||
|
||||
On the Overrides tab, you can now set properties for fields returned by a specific query.
|
||||
|
||||
For more information, refer to [Field overrides]({{< relref "../panels/field-overrides.md" >}}).
|
||||
For more information, refer to [About field overrides]({{< relref "../panels/override-field-values/about-field-overrides.md" >}}).
|
||||
|
||||
### Exemplar support
|
||||
|
||||
@@ -99,7 +99,7 @@ The main use case is for [multi-dimensional]({{< relref "../basics/timeseries-di
|
||||
|
||||
> **Note:** Queries built with this feature might break with minor version upgrades until Grafana 8 is released. This feature does not work with the current Grafana alerting.
|
||||
|
||||
For more information, refer to [Expressions]({{< relref "../panels/expressions.md" >}}). [Queries]({{< relref "../panels/queries.md" >}}) was also updated as a result of this feature.
|
||||
For more information, refer to [About expressions]({{< relref "../panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions.md" >}}). [About queries]({{< relref "../panels/query-a-data-source/about-queries.md" >}}) was also updated as a result of this feature.
|
||||
|
||||
### Alert notification query label interpolation
|
||||
|
||||
@@ -170,7 +170,7 @@ For more information, refer to the [Google Cloud Monitoring docs]({{< relref "..
|
||||
|
||||
The feature previously referred to as DataSource Start Pages or Cheat Sheets has been renamed to Query Editor Help, and is now supported in panel query editors (depending on the data source), as well as in Explore.
|
||||
|
||||
[Queries]({{< relref "../panels/queries.md" >}}) was updated as a result of this feature.
|
||||
[Queries]({{< relref "../panels/query-a-data-source/manage-queries.md" >}}) was updated as a result of this feature.
|
||||
|
||||
For more information on adding a query editor help component to your plugin, refer to [Add a query editor help component]({{< relref "../developers/plugins/add-query-editor-help.md" >}}).
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ To learn more about the differences between new alerts and the legacy alerts, re
|
||||
|
||||
### Library panels
|
||||
|
||||
Library panels allow users to build panels that can be used in multiple dashboards. Any updates made to that shared panel will then automatically be applied to all the dashboards that have that panel. For instructions on how to create, add, unlink and manage library panels, refer to [Library panels]({{< relref "../panels/panel-library.md" >}}).
|
||||
Library panels allow users to build panels that can be used in multiple dashboards. Any updates made to that shared panel will then automatically be applied to all the dashboards that have that panel. For instructions on how to create, add, unlink and manage library panels, refer to [Library panels]({{< relref "../panels/library-panels/" >}}).
|
||||
|
||||
### Real-time streaming
|
||||
|
||||
@@ -114,7 +114,7 @@ Lots of panel editor improvements, heavily informed by user research and communi
|
||||
|
||||
- All options are now shown in a single pane.
|
||||
- You can now search panel options.
|
||||
- The Value mappings feature has been completely redesigned. For more information, refer to [Value mappings]({{< relref "../panels/value-mappings.md" >}}).
|
||||
- The Value mappings feature has been completely redesigned. For more information, refer to [About value mappings]({{< relref "../panels/format-data/about-value-mapping.md" >}}).
|
||||
- New **Table view** option is always available.
|
||||
|
||||
The [Panels]({{< relref "../panels/_index.md" >}}) section has been updated to reflect these changes.
|
||||
@@ -129,7 +129,7 @@ Under the hood, the new theme architecture enables us to bring more sophisticate
|
||||
|
||||
When you inspect a panel, you can now download log results as a text (.txt) file.
|
||||
|
||||
[Download log results]({{< relref "../panels/inspect-panel.md#download-log-results" >}}) in [Inspect a panel]({{< relref "../panels/inspect-panel.md" >}}) was added as a result of this feature.
|
||||
[Download log results]({{< relref "../panels/working-with-panels/download-log-results.md" >}}) was added as a result of this feature.
|
||||
|
||||
### Inspector in Explore
|
||||
|
||||
|
||||
@@ -53,7 +53,7 @@ Grafana 8.1 includes some significant enhancements to transformations, including
|
||||
|
||||
#### Config from query (Beta)
|
||||
|
||||
This transformation enables panel config (Threshold, Min, Max, etc.) to be derived from query results. For more information, refer to [Config from query results transform]({{< relref "../panels/transformations/config-from-query.md" >}}).
|
||||
This transformation enables panel config (Threshold, Min, Max, etc.) to be derived from query results. For more information, refer to [Config from query results]({{< relref "../panels/reference-transformation-functions.md#config-from-query-results" >}}).
|
||||
|
||||
#### Rows to fields (Beta)
|
||||
|
||||
@@ -75,7 +75,7 @@ Output:
|
||||
|
||||
As you can see each row in the source data becomes a separate field. Each field now also has a max config option set. Options like **Min**, **Max**, **Unit** and **Thresholds** are all part of field configuration and if set like this will be used by the visualization instead of any options manually configured in the panel editor options pane.
|
||||
|
||||
For more on how to use this transformation, refer to [Rows to fields transform]({{< relref "../panels/transformations/rows-to-fields.md" >}}).
|
||||
For more on how to use this transformation, refer to [Rows to fields transform]({{< relref "../panels/reference-transformation-functions.md#rows-to-fields" >}}).
|
||||
|
||||
#### Contextual & Inline Help
|
||||
|
||||
|
||||
Reference in New Issue
Block a user