From d93bcd547eb06d0c4e39f62280214031bffd79e5 Mon Sep 17 00:00:00 2001 From: Garrett Guillotte <100453168+gguillotte-grafana@users.noreply.github.com> Date: Thu, 21 Apr 2022 06:16:22 -0700 Subject: [PATCH] Docs: Clarify transformation functions reference docs (#46903) * Docs: Remove 'Reference' prefix from all reference topic filenames: Per issue #46818, prefixing reference topics with "Reference" can damage usability. Remove the prefix from filenames. * Docs: Remove "Reference:" prefix from titles and ToC headings: Per issue #46818, prefixing reference topics with "Reference" can damage usability. Remove the prefix from titles and ToC headings. H1s retain the prefix to emphasize the nature of the doc without affecting the docs' discoverability. * Docs: Move Transformation functions reference alongside Transformation docs * Docs: Update links to reference docs in Transformation docs * Docs: Update links to reference docs in Panels docs * Docs: Update links to query options reference across docs * Docs: Update links to standard field definitions reference across docs * Docs: Update links to calculation types reference across docs * Docs: Update links to transformation functions reference across docs * Docs: Rename apply transformation doc filename to add transformation * Docs: Rename apply transformation doc to add transformation * Docs: Update links to add transformation doc across docs * Docs: Update relrefs in Transformation functions reference --- .../sources/dashboards/time-range-controls.md | 2 +- docs/sources/datasources/mssql.md | 4 +-- docs/sources/datasources/mysql.md | 4 +-- docs/sources/datasources/postgres.md | 4 +-- .../sources/developers/plugins/data-frames.md | 2 +- docs/sources/enterprise/query-caching.md | 4 +-- docs/sources/installation/upgrading.md | 2 +- ...culation-types.md => calculation-types.md} | 6 ++-- .../panels/query-a-data-source/add-a-query.md | 3 +- ...ence-query-options.md => query-options.md} | 4 +-- ...tions.md => standard-field-definitions.md} | 4 +-- .../transform-data/about-transformation.md | 3 +- .../add-transformation-to-data.md | 30 +++++++++++++++++++ .../apply-transformation-to-data.md | 30 ------------------- .../transformation-functions.md} | 12 ++++---- .../working-with-panels/configure-legend.md | 2 +- .../format-standard-fields.md | 4 +-- docs/sources/visualizations/bar-chart.md | 4 +-- .../sources/visualizations/bar-gauge-panel.md | 2 +- docs/sources/visualizations/gauge-panel.md | 2 +- docs/sources/visualizations/graph-panel.md | 2 +- docs/sources/visualizations/histogram.md | 2 +- .../sources/visualizations/pie-chart-panel.md | 2 +- docs/sources/visualizations/stat-panel.md | 2 +- .../visualizations/time-series/_index.md | 2 +- .../time-series/change-axis-display.md | 2 +- docs/sources/whatsnew/whats-new-in-v7-0.md | 4 +-- docs/sources/whatsnew/whats-new-in-v7-2.md | 4 +-- docs/sources/whatsnew/whats-new-in-v7-4.md | 4 +-- docs/sources/whatsnew/whats-new-in-v8-1.md | 4 +-- 30 files changed, 77 insertions(+), 79 deletions(-) rename docs/sources/panels/{reference-calculation-types.md => calculation-types.md} (91%) rename docs/sources/panels/{reference-query-options.md => query-options.md} (96%) rename docs/sources/panels/{reference-standard-field-definitions.md => standard-field-definitions.md} (98%) create mode 100644 docs/sources/panels/transform-data/add-transformation-to-data.md delete mode 100644 docs/sources/panels/transform-data/apply-transformation-to-data.md rename docs/sources/panels/{reference-transformation-functions.md => transform-data/transformation-functions.md} (98%) diff --git a/docs/sources/dashboards/time-range-controls.md b/docs/sources/dashboards/time-range-controls.md index 34a72186be5..7b170f2de2a 100644 --- a/docs/sources/dashboards/time-range-controls.md +++ b/docs/sources/dashboards/time-range-controls.md @@ -117,7 +117,7 @@ For more advanced time settings, click the **Dashboard settings** (gear) icon at ## Panel time overrides and timeshift -In [Query options]({{< relref "../panels/reference-query-options.md" >}}), you can override the relative time range for individual panels, causing them to be different than what is selected in the dashboard time picker in the upper right. This allows you to show metrics from different time periods or days at the same time. +In [Query options]({{< relref "../panels/query-options.md" >}}), you can override the relative time range for individual panels, causing them to be different than what is selected in the dashboard time picker in the upper right. This allows you to show metrics from different time periods or days at the same time. > **Note:** Panel time overrides have no effect when the time range for the dashboard is absolute. diff --git a/docs/sources/datasources/mssql.md b/docs/sources/datasources/mssql.md index f56a01070f1..31c1e19229d 100644 --- a/docs/sources/datasources/mssql.md +++ b/docs/sources/datasources/mssql.md @@ -174,7 +174,7 @@ A time series query result is returned in a [wide data frame format]({{< relref > For backward compatibility, there's an exception to the above rule for queries that return three columns including a string column named metric. Instead of transforming the metric column into field labels, it becomes the field name, and then the series name is formatted as the value of the metric column. See the example with the metric column below. -You can optionally customize the default series name formatting using instructions in [Reference: Standard field definitions]({{< relref "../panels/reference-standard-field-definitions.md#display-name" >}}). +To optionally customize the default series name formatting, refer to [Standard field definitions]({{< relref "../panels/standard-field-definitions.md#display-name" >}}). **Example with `metric` column:** @@ -218,7 +218,7 @@ GROUP BY ORDER BY 1 ``` -Given the data frame result in the following example and using the graph panel, you will get two series named _value 10.0.1.1_ and _value 10.0.1.2_. To render the series with a name of _10.0.1.1_ and _10.0.1.2_ , use a [Reference: Standard field definitions]({{< relref "../panels/reference-standard-field-definitions.md#display-name" >}}) display name value of `${__field.labels.hostname}`. +Given the data frame result in the following example and using the graph panel, you will get two series named _value 10.0.1.1_ and _value 10.0.1.2_. To render the series with a name of _10.0.1.1_ and _10.0.1.2_ , use a [Standard field definition]({{< relref "../panels/standard-field-definitions.md#display-name" >}}) display name value of `${__field.labels.hostname}`. Data frame result: diff --git a/docs/sources/datasources/mysql.md b/docs/sources/datasources/mysql.md index 957cf7e3770..5bbb1264ca3 100644 --- a/docs/sources/datasources/mysql.md +++ b/docs/sources/datasources/mysql.md @@ -186,7 +186,7 @@ A time series query result is returned in a [wide data frame format]({{< relref > For backward compatibility, there's an exception to the above rule for queries that return three columns including a string column named metric. Instead of transforming the metric column into field labels, it becomes the field name, and then the series name is formatted as the value of the metric column. See the example with the metric column below. -You can optionally customize the default series name formatting using instructions in [Reference: Standard field definitions]({{< relref "../panels/reference-standard-field-definitions.md#display-name" >}}). +To optionally customize the default series name formatting, refer to [Standard field definitions]({{< relref "../panels/standard-field-definitions.md#display-name" >}}). **Example with `metric` column:** @@ -228,7 +228,7 @@ GROUP BY time, hostname ORDER BY time ``` -Given the data frame result in the following example and using the graph panel, you will get two series named _value 10.0.1.1_ and _value 10.0.1.2_. To render the series with a name of _10.0.1.1_ and _10.0.1.2_ , use a [Reference: Standard field definitions]({{< relref "../panels/reference-standard-field-definitions.md#display-name" >}}) display value of `${__field.labels.hostname}`. +Given the data frame result in the following example and using the graph panel, you will get two series named _value 10.0.1.1_ and _value 10.0.1.2_. To render the series with a name of _10.0.1.1_ and _10.0.1.2_ , use a [Standard field definition]({{< relref "../panels/standard-field-definitions.md#display-name" >}}) display value of `${__field.labels.hostname}`. Data frame result: diff --git a/docs/sources/datasources/postgres.md b/docs/sources/datasources/postgres.md index 24f9fd3456a..f5f335689f0 100644 --- a/docs/sources/datasources/postgres.md +++ b/docs/sources/datasources/postgres.md @@ -191,7 +191,7 @@ A time series query result is returned in a [wide data frame format]({{< relref > For backward compatibility, there's an exception to the above rule for queries that return three columns including a string column named metric. Instead of transforming the metric column into field labels, it becomes the field name, and then the series name is formatted as the value of the metric column. See the example with the metric column below. -You can optionally customize the default series name formatting using instructions in [Reference: Standard field definitions]({{< relref "../panels/reference-standard-field-definitions.md#display-name" >}}). +To optionally customize the default series name formatting, refer to [Standard field definitions]({{< relref "../panels/standard-field-definitions.md#display-name" >}}). **Example with `metric` column:** @@ -233,7 +233,7 @@ GROUP BY time, hostname ORDER BY time ``` -Given the data frame result in the following example and using the graph panel, you will get two series named _value 10.0.1.1_ and _value 10.0.1.2_. To render the series with a name of _10.0.1.1_ and _10.0.1.2_ , use a [Reference: Standard field definitions]({{< relref "../panels/reference-standard-field-definitions.md#display-name" >}}) display value of `${__field.labels.hostname}`. +Given the data frame result in the following example and using the graph panel, you will get two series named _value 10.0.1.1_ and _value 10.0.1.2_. To render the series with a name of _10.0.1.1_ and _10.0.1.2_ , use a [Standard field definition]({{< relref "../panels/standard-field-definitions.md#display-name" >}}) display value of `${__field.labels.hostname}`. Data frame result: diff --git a/docs/sources/developers/plugins/data-frames.md b/docs/sources/developers/plugins/data-frames.md index 1c85e563c85..fb4554f0d34 100644 --- a/docs/sources/developers/plugins/data-frames.md +++ b/docs/sources/developers/plugins/data-frames.md @@ -163,7 +163,7 @@ Dimensions: 5 fields by 2 rows +---------------------+------------------+------------------+------------------+------------------+ ``` -> **Note:** Not all panels support the wide time series data frame format. To keep full backward compatibility we have introduced a transformation that can be used to convert from the wide to the long format. Read more about how to use it here: [Prepare time series-transformation]({{< relref "../../panels/reference-transformation-functions.md#prepare-time-series" >}}). +> **Note:** Not all panels support the wide time series data frame format. To keep full backward compatibility we have introduced a transformation that can be used to convert from the wide to the long format. For usage information, refer to the [Prepare time series-transformation]({{< relref "../../panels/transform-data/transformation-functions.md#prepare-time-series" >}}). ## Technical references diff --git a/docs/sources/enterprise/query-caching.md b/docs/sources/enterprise/query-caching.md index b58e5c351a8..e4a33d54cb4 100644 --- a/docs/sources/enterprise/query-caching.md +++ b/docs/sources/enterprise/query-caching.md @@ -17,9 +17,9 @@ The following cache backends are available: in-memory, Redis, and Memcached. When a panel queries a cached data source, the time until this query fetches fresh data is determined by the panel's **interval.** This means that wider panels and dashboards with shorter time ranges fetch new data more frequently than narrower panels and dashboards with longer time ranges. -Interval is visible in a panel's [query options]({{< relref "../panels/reference-query-options.md" >}}). It is calculated like this: `(max data points) / time range`. Max data points are calculated based on the width of the panel. For example, a full-width panel on a dashboard with a time range of `last 7 days` will retrieve fresh data every 10 minutes. In this example, cached data for this panel will be served for up to 10 minutes before Grafana queries the data source again and returns new data. +Interval is visible in a panel's [query options]({{< relref "../panels/query-options.md" >}}). It is calculated like this: `(max data points) / time range`. Max data points are calculated based on the width of the panel. For example, a full-width panel on a dashboard with a time range of `last 7 days` will retrieve fresh data every 10 minutes. In this example, cached data for this panel will be served for up to 10 minutes before Grafana queries the data source again and returns new data. -You can make a panel retrieve fresh data more frequently by increasing the **Max data points** setting in the panel's [query options]({{< relref "../panels/reference-query-options.md" >}}). +You can make a panel retrieve fresh data more frequently by increasing the **Max data points** setting in the panel's [query options]({{< relref "../panels/query-options.md" >}}). ## Query caching benefits diff --git a/docs/sources/installation/upgrading.md b/docs/sources/installation/upgrading.md index 7dd79d49e13..dba0384440b 100755 --- a/docs/sources/installation/upgrading.md +++ b/docs/sources/installation/upgrading.md @@ -365,7 +365,7 @@ ORDER BY time There are two possible workarounds to resolve this problem: 1. In Grafana v8.0.3, use an alias of the string column selected as `metric`. for example, `hostname as metric`. -2. Use the [Standard field options/Display name]({{< relref "../panels/reference-standard-field-definitions.md#display-name" >}}) to format the alias. For the preceding example query, you would use `${__field.labels.hostname}` option. +2. Use the [Standard field definitions' display name]({{< relref "../panels/standard-field-definitions.md#display-name" >}}) to format the alias. For the preceding example query, you would use `${__field.labels.hostname}` option. For more information, refer to the our relational databases documentation of [Postgres]({{< relref "../datasources/postgres.md#time-series-queries" >}}), [MySQL]({{< relref "../datasources/mysql.md#time-series-queries" >}}), [Microsoft SQL Server]({{< relref "../datasources/mssql.md#time-series-queries" >}}). diff --git a/docs/sources/panels/reference-calculation-types.md b/docs/sources/panels/calculation-types.md similarity index 91% rename from docs/sources/panels/reference-calculation-types.md rename to docs/sources/panels/calculation-types.md index f341a739c25..4e586af014e 100644 --- a/docs/sources/panels/reference-calculation-types.md +++ b/docs/sources/panels/calculation-types.md @@ -1,10 +1,10 @@ +++ -title = "Reference: Calculation types" -aliases = ["/docs/grafana/latest/panels/calculations-list/", "/docs/sources/panels/reference-calculation-types/"] +title = "Calculation types" +aliases = ["/docs/grafana/latest/panels/calculations-list/", "/docs/sources/panels/reference-calculation-types/", "/docs/grafana/latest/panels/reference-calculation-types"] weight = 1100 +++ -# Reference: Calculations +# Reference: Calculation types Refer to the following list of calculations you can perform in Grafana. You can find these calculations in the **Transform** tab and in the bar gauge, gauge, and stat visualizations. diff --git a/docs/sources/panels/query-a-data-source/add-a-query.md b/docs/sources/panels/query-a-data-source/add-a-query.md index bf67f641fa5..32933cc183e 100644 --- a/docs/sources/panels/query-a-data-source/add-a-query.md +++ b/docs/sources/panels/query-a-data-source/add-a-query.md @@ -21,10 +21,9 @@ A query returns data that Grafana visualizes in dashboards. When you create a pa 1. Click the **Data source** drop-down menu and select a data source. 1. Click **Query options** to configure the maximum number of data points returned by the query and how frequently you want the query to request data from the data source. - For more information about query options, refer to [Reference: Query options]({{< relref "../reference-query-options.md" >}}). + For more information about query options, refer to [Query options]({{< relref "../query-options.md" >}}). 1. Write the query. - 1. Click **Apply**. The system queries the data source and presents the data in the visualization. diff --git a/docs/sources/panels/reference-query-options.md b/docs/sources/panels/query-options.md similarity index 96% rename from docs/sources/panels/reference-query-options.md rename to docs/sources/panels/query-options.md index e7dcc60c98a..a20eb53ced5 100644 --- a/docs/sources/panels/reference-query-options.md +++ b/docs/sources/panels/query-options.md @@ -1,6 +1,6 @@ +++ -title = "Reference: Query options" -aliases = ["/docs/sources/panels/reference-query-options/"] +title = "Query options" +aliases = ["/docs/sources/panels/reference-query-options/", "/docs/grafana/latest/panels/reference-query-options"] weight = 900 +++ diff --git a/docs/sources/panels/reference-standard-field-definitions.md b/docs/sources/panels/standard-field-definitions.md similarity index 98% rename from docs/sources/panels/reference-standard-field-definitions.md rename to docs/sources/panels/standard-field-definitions.md index d8815dd2749..70cb2a5dcb3 100644 --- a/docs/sources/panels/reference-standard-field-definitions.md +++ b/docs/sources/panels/standard-field-definitions.md @@ -1,6 +1,6 @@ +++ -title = "Reference: Standard field definitions" -aliases = ["/docs/sources/panels/reference-standard-field-definitions/"] +title = "Standard field definitions" +aliases = ["/docs/sources/panels/reference-standard-field-definitions/", "/docs/grafana/latest/panels/reference-standard-field-definitions"] weight = 1200 +++ diff --git a/docs/sources/panels/transform-data/about-transformation.md b/docs/sources/panels/transform-data/about-transformation.md index d357e48a19d..348aee91f59 100644 --- a/docs/sources/panels/transform-data/about-transformation.md +++ b/docs/sources/panels/transform-data/about-transformation.md @@ -21,8 +21,7 @@ You can also use the output of one transformation as the input to another transf ## Transformation types -Grafana provides a number of ways that you can transform data. For a complete list of transformations, refer to -[Reference: Transformation functions]({{< relref "../reference-transformation-functions.md" >}}). +Grafana provides a number of ways that you can transform data. For a complete list of transformations, refer to [Transformation functions]({{< relref "transformation-functions.md" >}}). ## Order of transformations diff --git a/docs/sources/panels/transform-data/add-transformation-to-data.md b/docs/sources/panels/transform-data/add-transformation-to-data.md new file mode 100644 index 00000000000..c4a3cd21dc0 --- /dev/null +++ b/docs/sources/panels/transform-data/add-transformation-to-data.md @@ -0,0 +1,30 @@ ++++ +title = "Add a transformation to data" +weight = 20 +aliases = ["/docs/sources/panels/transform-data/add-transformation-to-data/", "/docs/sources/panels/transform-data/apply-transformation-to-data", "/docs/grafana/latest/panels/transform-data/apply-transformation-to-data"] ++++ + +# Add a transformation function to data + +The following steps guide you in adding a transformation to data. This documentation does not include steps for each type of transformation. For a complete list of transformations, refer to [Transformation functions]({{< relref "transformation-functions.md" >}}). + +## Before you begin + +- [Add a query]({{< relref "../query-a-data-source/add-a-query.md" >}}). + +**To apply a transformation function to data**: + +1. Navigate to the panel where you want to add one or more transformations. +1. Click the panel title and then click **Edit**. +1. Click the **Transform** tab. +1. Click a transformation. + + A transformation row appears where you configure the transformation options. For more information about how to configure a transformation, refer to [Transformation functions]({{< relref "transformation-functions.md" >}}). + + For information about available calculations, refer to [Calculation types]({{< relref "../calculation-types.md" >}}). + +1. To apply another transformation, click **Add transformation**. + + This transformation acts on the result set returned by the previous transformation. + + {{< figure src="/static/img/docs/transformations/transformations-7-0.png" class="docs-image--no-shadow" max-width= "1100px" >}} diff --git a/docs/sources/panels/transform-data/apply-transformation-to-data.md b/docs/sources/panels/transform-data/apply-transformation-to-data.md deleted file mode 100644 index 4161d0ff403..00000000000 --- a/docs/sources/panels/transform-data/apply-transformation-to-data.md +++ /dev/null @@ -1,30 +0,0 @@ -+++ -title = "Apply a transformation to data" -weight = 20 -aliases = ["/docs/sources/panels/transform-data/apply-transformation-to-data/"] -+++ - -# Apply a transformation function to data - -The following steps guide you in applying a transformation to data. This documentation does not include steps for each type of transformation. For a complete list of transformations, refer to [Reference: Transformation functions]({{< relref "../reference-transformation-functions.md" >}}). - -## Before you begin - -- [Add a query]({{< relref "../query-a-data-source/add-a-query.md" >}}). - -**To apply a transformation function to data**: - -1. Navigate to the panel where you want to add one or more transformations. -1. Click the panel title and then click **Edit**. -1. Click the **Transform** tab. -1. Click a transformation. - - A transformation row appear where you configure the transformation options. For more information about how to configure a transformation, refer to [Reference: Transformation functions]({{< relref "../reference-transformation-functions.md" >}}). - - For information about available calculations, refer to [Reference: Calculations]({{< relref "../reference-calculation-types.md" >}}). - -1. To apply another transformation, click **Add transformation**. - - This transformation acts on the result set returned by the previous transformation. - - {{< figure src="/static/img/docs/transformations/transformations-7-0.png" class="docs-image--no-shadow" max-width= "1100px" >}} diff --git a/docs/sources/panels/reference-transformation-functions.md b/docs/sources/panels/transform-data/transformation-functions.md similarity index 98% rename from docs/sources/panels/reference-transformation-functions.md rename to docs/sources/panels/transform-data/transformation-functions.md index 3e66493f107..180d73a004b 100644 --- a/docs/sources/panels/reference-transformation-functions.md +++ b/docs/sources/panels/transform-data/transformation-functions.md @@ -1,6 +1,6 @@ +++ -title = "Reference: Transformation functions" -aliases = ["/docs/grafana/latest/panels/transformations/types-options/", "docs/sources/panels/reference-transformation-functions/"] +title = "Transformation functions" +aliases = ["/docs/grafana/latest/panels/transformations/types-options/", "/docs/sources/panels/reference-transformation-functions/", "/docs/grafana/latest/panels/reference-transformation-functions"] weight = 1000 +++ @@ -16,7 +16,7 @@ Use this transformation to add a new field calculated from two other fields. Eac - **Reduce row -** Apply selected calculation on each row of selected fields independently. - **Binary option -** Apply basic math operation(sum, multiply, etc) on values in a single row from two selected fields. - **Field name -** Select the names of fields you want to use in the calculation for the new field. -- **Calculation -** If you select **Reduce row** mode, then the **Calculation** field appears. Click in the field to see a list of calculation choices you can use to create the new field. For information about available calculations, refer to [Reference: Calculations]({{< relref "./reference-calculation-types.md" >}}). +- **Calculation -** If you select **Reduce row** mode, then the **Calculation** field appears. Click in the field to see a list of calculation choices you can use to create the new field. For information about available calculations, refer to [Calculation types]({{< relref "../calculation-types.md" >}}). - **Operation -** If you select **Binary option** mode, then the **Operation** fields appear. These fields allow you to do basic math operations on values in a single row from two selected fields. You can also use numerical values for binary operations. - **Alias -** (Optional) Enter the name of your new field. If you leave this blank, then the field will be named to match the calculation. - **Replace all fields -** (Optional) Select this option if you want to hide all other fields and display only your calculated field in the visualization. @@ -189,7 +189,7 @@ Conditions that are invalid or incompletely configured are ignored. ## Group by -This transformation groups the data by a specified field (column) value and processes calculations on each group. Click to see a list of calculation choices. For information about available calculations, refer to the [List of calculations]({{< relref "./reference-calculation-types.md" >}}). +This transformation groups the data by a specified field (column) value and processes calculations on each group. Click to see a list of calculation choices. For information about available calculations, refer to [Calculation types]({{< relref "../calculation-types.md" >}}). Here's an example of original data. @@ -323,7 +323,7 @@ After merge: ## Merge -Use this transformation to combine the result from multiple queries into one single result. This is helpful when using the table panel visualization. Values that can be merged are combined into the same row. Values are mergeable if the shared fields contain the same data. For information, refer to [Table panel]({{< relref "../visualizations/table/_index.md" >}}). +Use this transformation to combine the result from multiple queries into one single result. This is helpful when using the table panel visualization. Values that can be merged are combined into the same row. Values are mergeable if the shared fields contain the same data. For information, refer to [Table panel]({{< relref "../../visualizations/table/_index.md" >}}). In the example below, we have two queries returning table data. It is visualized as two separate tables before applying the transformation. @@ -493,7 +493,7 @@ As you can see each row in the source data becomes a separate field. Each field > **Note:** This transformation is available in Grafana 7.5.10+ and Grafana 8.0.6+. -Prepare time series transformation is useful when a data source returns time series data in a format that isn't supported by the panel you want to use. For more information about data frame formats, refer to [Data frames]({{< relref "../developers/plugins/data-frames.md" >}}). +Prepare time series transformation is useful when a data source returns time series data in a format that isn't supported by the panel you want to use. For more information about data frame formats, refer to [Data frames]({{< relref "../../developers/plugins/data-frames.md" >}}). This transformation helps you resolve this issue by converting the time series data from either the wide format to the long format or the other way around. diff --git a/docs/sources/panels/working-with-panels/configure-legend.md b/docs/sources/panels/working-with-panels/configure-legend.md index 6c97260c7ee..07b32912f43 100644 --- a/docs/sources/panels/working-with-panels/configure-legend.md +++ b/docs/sources/panels/working-with-panels/configure-legend.md @@ -83,7 +83,7 @@ By default, Grafana specifies the color of your series data, which you can chang ## Sort series -Change legend mode to **Table** and choose [calculations]({{< relref "../reference-calculation-types.md" >}}) to be displayed in the legend. Click the calculation name header in the legend table to sort the values in the table in ascending or descending order. +Change legend mode to **Table** and choose [calculations]({{< relref "../calculation-types.md" >}}) to be displayed in the legend. Click the calculation name header in the legend table to sort the values in the table in ascending or descending order. The sort order affects the positions of the bars in the Bar chart panel as well as the order of stacked series in the Time series and Bar chart panels. diff --git a/docs/sources/panels/working-with-panels/format-standard-fields.md b/docs/sources/panels/working-with-panels/format-standard-fields.md index 1a70f7115fc..47334a01b89 100644 --- a/docs/sources/panels/working-with-panels/format-standard-fields.md +++ b/docs/sources/panels/working-with-panels/format-standard-fields.md @@ -10,7 +10,7 @@ The data model used in Grafana, namely the [data frame]({{< relref "../../develo Field options allow you to change how the data is displayed in your visualizations. Options and overrides that you apply do not change the data, they change how Grafana displays the data. When you change an option, it is applied to all fields, meaning all series or columns. For example, if you change the unit to percentage, then all fields with numeric values are displayed in percentages. -For a complete list of field formatting options, refer to [Reference: Standard field definitions]({{< relref "../reference-standard-field-definitions.md" >}}). +For a complete list of field formatting options, refer to [Standard field definitions]({{< relref "../standard-field-definitions.md" >}}). > You can apply standard options to most built-in Grafana panels. Some older panels and community panels that have not updated to the new panel and data model will be missing either all or some of these field options. @@ -26,6 +26,6 @@ For a complete list of field formatting options, refer to [Reference: Standard f 1. Select the standard options you want to apply. - For more information about standard options, refer to [Reference: Standard field definitions]({{< relref "../reference-standard-field-definitions/index.md" >}}). + For more information about standard options, refer to [Standard field definitions]({{< relref "../standard-field-definitions/index.md" >}}). 1. To preview your change, click outside of the field option box you are editing or press **Enter**. diff --git a/docs/sources/visualizations/bar-chart.md b/docs/sources/visualizations/bar-chart.md index 04f60103314..2285ce05879 100644 --- a/docs/sources/visualizations/bar-chart.md +++ b/docs/sources/visualizations/bar-chart.md @@ -98,7 +98,7 @@ Gradient color is generated based on the hue of the line color. ### Legend calculations -Choose which of the [standard calculations]({{< relref "../panels/reference-calculation-types.md">}}) to show in the legend. You can have more than one. +Choose which of the [standard calculations]({{< relref "../panels/calculation-types.md">}}) to show in the legend. You can have more than one. ## Text size @@ -148,4 +148,4 @@ Set a **Soft min** or **soft max** option for better control of Y-axis limits. B **Soft min** and **soft max** settings can prevent blips from turning into mountains when the data is mostly flat, and hard min or max derived from standard min and max field options can prevent intermittent spikes from flattening useful detail by clipping the spikes past a defined point. -You can set standard min/max options to define hard limits of the Y-axis. For more information, refer to [Standard field options]({{< relref "../panels/reference-standard-field-definitions.md#max" >}}). +You can set standard min/max options to define hard limits of the Y-axis. For more information, refer to [Standard field definitions]({{< relref "../panels/standard-field-definitions.md#max" >}}). diff --git a/docs/sources/visualizations/bar-gauge-panel.md b/docs/sources/visualizations/bar-gauge-panel.md index 3671ffd721e..28e0aecb1c9 100644 --- a/docs/sources/visualizations/bar-gauge-panel.md +++ b/docs/sources/visualizations/bar-gauge-panel.md @@ -26,7 +26,7 @@ Choose how Grafana displays your data. Show a calculated value based on all rows. -- **Calculation -** Select a reducer function that Grafana will use to reduce many fields to a single value. For a list of available calculations, refer to [List of calculations]({{< relref "../panels/reference-calculation-types.md" >}}). +- **Calculation -** Select a reducer function that Grafana will use to reduce many fields to a single value. For a list of available calculations, refer to [Calculation types]({{< relref "../panels/calculation-types.md" >}}). - **Fields -** Select the fields display in the panel. #### All values diff --git a/docs/sources/visualizations/gauge-panel.md b/docs/sources/visualizations/gauge-panel.md index 045d1d6ee8e..ca064af8f11 100644 --- a/docs/sources/visualizations/gauge-panel.md +++ b/docs/sources/visualizations/gauge-panel.md @@ -24,7 +24,7 @@ Choose how Grafana displays your data. Show a calculated value based on all rows. -- **Calculation -** Select a reducer function that Grafana will use to reduce many fields to a single value. For a list of available calculations, refer to [List of calculations]({{< relref "../panels/reference-calculation-types.md" >}}). +- **Calculation -** Select a reducer function that Grafana will use to reduce many fields to a single value. For a list of available calculations, refer to [Calculation types]({{< relref "../panels/calculation-types.md" >}}). - **Fields -** Select the fields display in the panel. #### All values diff --git a/docs/sources/visualizations/graph-panel.md b/docs/sources/visualizations/graph-panel.md index d2006ea5916..61e869246cb 100644 --- a/docs/sources/visualizations/graph-panel.md +++ b/docs/sources/visualizations/graph-panel.md @@ -16,7 +16,7 @@ The graph panel can render metrics as a line, a path of dots, or a series of bar Graph visualizations allow you to apply: - [Alerts]({{< relref "../alerting/_index.md" >}}) - This is the only type of visualization that allows you to set alerts. -- [Transform data]({{< relref "../panels/transform-data/apply-transformation-to-data.md" >}}) +- [Transform data]({{< relref "../panels/transform-data/add-transformation-to-data.md" >}}) - [Add a field override]({{< relref "../panels/override-field-values/add-a-field-override.md" >}}) - [Add a threshold]({{< relref "../panels/specify-thresholds/add-a-threshold.md" >}}) diff --git a/docs/sources/visualizations/histogram.md b/docs/sources/visualizations/histogram.md index 548b272c7e1..990bd65c12e 100644 --- a/docs/sources/visualizations/histogram.md +++ b/docs/sources/visualizations/histogram.md @@ -64,4 +64,4 @@ Gradient color is generated based on the hue of the line color. ### Legend calculations -Choose a [standard calculations]({{< relref "../panels/reference-calculation-types.md">}}) to show in the legend. You can select more than one. +Choose a [standard calculations]({{< relref "../panels/calculation-types.md">}}) to show in the legend. You can select more than one. diff --git a/docs/sources/visualizations/pie-chart-panel.md b/docs/sources/visualizations/pie-chart-panel.md index 2720bfb0321..f0cf68b0258 100644 --- a/docs/sources/visualizations/pie-chart-panel.md +++ b/docs/sources/visualizations/pie-chart-panel.md @@ -24,7 +24,7 @@ Choose how much information to show. ### Calculation -Select a calculation to reduce each series when Calculate has been selected. For information about available calculations, refer to the [Calculation list]({{< relref "../panels/reference-calculation-types.md" >}}). +Select a calculation to reduce each series when Calculate has been selected. For information about available calculations, refer to [Calculation types]({{< relref "../panels/calculation-types.md" >}}). ### Limit diff --git a/docs/sources/visualizations/stat-panel.md b/docs/sources/visualizations/stat-panel.md index a1608afaab0..33de02761f0 100644 --- a/docs/sources/visualizations/stat-panel.md +++ b/docs/sources/visualizations/stat-panel.md @@ -41,7 +41,7 @@ Choose how Grafana displays your data. Show a calculated value based on all rows. -- **Calculation -** Select a reducer function that Grafana will use to reduce many fields to a single value. For a list of available calculations, refer to [List of calculations]({{< relref "../panels/reference-calculation-types.md" >}}). +- **Calculation -** Select a reducer function that Grafana will use to reduce many fields to a single value. For a list of available calculations, refer to [Calculation types]({{< relref "../panels/calculation-types.md" >}}). - **Fields -** Select the fields display in the panel. #### All values diff --git a/docs/sources/visualizations/time-series/_index.md b/docs/sources/visualizations/time-series/_index.md index e0cec74145f..e9085d0ede8 100644 --- a/docs/sources/visualizations/time-series/_index.md +++ b/docs/sources/visualizations/time-series/_index.md @@ -23,7 +23,7 @@ These options are available whether you are graphing your time series as lines, ### Legend calculations -Choose which of the [standard calculations]({{< relref "../../panels/reference-calculation-types.md">}}) to show in the legend. You can have more than one. +Choose which of the [standard calculations]({{< relref "../../panels/calculation-types.md">}}) to show in the legend. You can have more than one. ## Graph styles diff --git a/docs/sources/visualizations/time-series/change-axis-display.md b/docs/sources/visualizations/time-series/change-axis-display.md index bd6244531c3..4987bf2996e 100644 --- a/docs/sources/visualizations/time-series/change-axis-display.md +++ b/docs/sources/visualizations/time-series/change-axis-display.md @@ -61,7 +61,7 @@ Set a **Soft min** or **soft max** option for better control of Y-axis limits. B **Soft min** and **soft max** settings can prevent blips from turning into mountains when the data is mostly flat, and hard min or max derived from standard min and max field options can prevent intermittent spikes from flattening useful detail by clipping the spikes past a defined point. -You can set standard min/max options to define hard limits of the Y-axis. For more information, refer to [Reference: Standard field definitions]({{< relref "../../panels/reference-standard-field-definitions.md#max" >}}). +You can set standard min/max options to define hard limits of the Y-axis. For more information, refer to [Standard field definitions]({{< relref "../../panels/standard-field-definitions.md#max" >}}). ![Label example](/static/img/docs/time-series-panel/axis-soft-min-max-7-4.png) diff --git a/docs/sources/whatsnew/whats-new-in-v7-0.md b/docs/sources/whatsnew/whats-new-in-v7-0.md index ba2bc196f5c..0aeb5342e61 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-0.md +++ b/docs/sources/whatsnew/whats-new-in-v7-0.md @@ -58,7 +58,7 @@ 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/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. +By chaining a simple set of point and click [transformations]({{< relref "../panels/transform-data/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/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. @@ -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/reference-transformation-functions.md" >}}). +Learn more about this feature in [Transformations]({{< relref "../panels/transform-data/transformation-functions.md" >}}). ## Field options and overrides diff --git a/docs/sources/whatsnew/whats-new-in-v7-2.md b/docs/sources/whatsnew/whats-new-in-v7-2.md index 2417cbfb298..5d532f913b0 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-2.md +++ b/docs/sources/whatsnew/whats-new-in-v7-2.md @@ -77,8 +77,8 @@ You can now add override rules that use a regex matcher to choose which fields t Grafana 7.2 includes the following transformation enhancements: -- 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. +- A new [Group By]({{< relref "../panels/transform-data/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/transform-data/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" >}} diff --git a/docs/sources/whatsnew/whats-new-in-v7-4.md b/docs/sources/whatsnew/whats-new-in-v7-4.md index a7fcad77c44..aa2908ec258 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-4.md +++ b/docs/sources/whatsnew/whats-new-in-v7-4.md @@ -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/reference-transformation-functions.md#sort-by" >}}). +For more information, refer to [Sort by]({{< relref "../panels/transform-data/transformation-functions.md#sort-by" >}}). #### Filter data by value transform @@ -62,7 +62,7 @@ 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/reference-transformation-functions.md#filter-data-by-value" >}}). +For more information, refer to [Filter data by value]({{< relref "../panels/transform-data/transformation-functions.md#filter-data-by-value" >}}). ### New override option diff --git a/docs/sources/whatsnew/whats-new-in-v8-1.md b/docs/sources/whatsnew/whats-new-in-v8-1.md index 085f6caeabb..9bfcd828c2a 100644 --- a/docs/sources/whatsnew/whats-new-in-v8-1.md +++ b/docs/sources/whatsnew/whats-new-in-v8-1.md @@ -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]({{< relref "../panels/reference-transformation-functions.md#config-from-query-results" >}}). +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/transform-data/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/reference-transformation-functions.md#rows-to-fields" >}}). +For more on how to use this transformation, refer to [Rows to fields transform]({{< relref "../panels/transform-data/transformation-functions.md#rows-to-fields" >}}). #### Contextual & Inline Help