[v9.5.x] [feat] docs; update admonition syntax (#68856)
[feat] docs; update admonition syntax (#68842)
* [feat] docs; update admonition syntax
- Standardizes according to style conventions: https://grafana.com/docs/writers-toolkit/style-guide/style-conventions/#admonitions
- Prepares docs for better, uniform admonition style.
* Remove false positives and irregularities
* false positive removal
* Update docs/sources/datasources/mysql/_index.md
* Update docs/sources/developers/angular_deprecation/angular-plugins.md
* fix link errors
* Prettify some nested blockquotes
* remoe unnecessary admonition
(cherry picked from commit 1c4bb9ca00)
Co-authored-by: Matt Dodson <47385188+MattDodsonEnglish@users.noreply.github.com>
This commit is contained in:
Grot (@grafanabot)
co-authored by
Matt Dodson
Matt Dodson
parent
f74b514e1a
commit
08ea5c94c6
@@ -21,11 +21,15 @@ Server-side expressions allow you to manipulate data returned from queries with
|
||||
|
||||
Expressions are most commonly used for [Grafana Alerting]({{< relref "../../../alerting/" >}}). The processing is done server-side, so expressions can operate without a browser session. However, expressions can also be used with backend data sources and visualization.
|
||||
|
||||
> **Note:** Expressions do not work with legacy dashboard alerts.
|
||||
{{% admonition type="note" %}}
|
||||
Expressions do not work with legacy dashboard alerts.
|
||||
{{% /admonition %}}
|
||||
|
||||
Expressions are meant to augment data sources by enabling queries from different data sources to be combined or by providing operations unavailable in a data source.
|
||||
|
||||
> **Note:** When possible, you should do data processing inside the data source. Copying data from storage to the Grafana server for processing is inefficient, so expressions are targeted at lightweight data processing.
|
||||
{{% admonition type="note" %}}
|
||||
When possible, you should do data processing inside the data source. Copying data from storage to the Grafana server for processing is inefficient, so expressions are targeted at lightweight data processing.
|
||||
{{% /admonition %}}
|
||||
|
||||
Expressions work with data source queries that return time series or number data. They also operate on [multiple-dimensional data]({{< relref "../../../fundamentals/timeseries-dimensions/" >}}). For example, a query that returns multiple series, where each series is identified by labels or tags.
|
||||
|
||||
@@ -111,7 +115,9 @@ abs returns the absolute value of its argument which can be a number or a series
|
||||
|
||||
is_inf takes a number or a series and returns `1` for `Inf` values (negative or positive) and `0` for other values. For example `is_inf($A)`.
|
||||
|
||||
> **Note:** If you need to specifically check for negative infinity for example, you can do a comparison like `$A == infn()`.
|
||||
{{% admonition type="note" %}}
|
||||
If you need to specifically check for negative infinity for example, you can do a comparison like `$A == infn()`.
|
||||
{{% /admonition %}}
|
||||
|
||||
###### is_nan
|
||||
|
||||
|
||||
@@ -200,7 +200,9 @@ In the example below, the panel has three queries (A, B, C). I removed the B que
|
||||
|
||||
{{< figure src="/static/img/docs/transformations/filter-by-query-stat-example-7-0.png" class="docs-image--no-shadow" max-width= "1100px" >}}
|
||||
|
||||
> **Note:** This transformation is not available for Graphite because this data source does not support correlating returned data with queries.
|
||||
{{% admonition type="note" %}}
|
||||
This transformation is not available for Graphite because this data source does not support correlating returned data with queries.
|
||||
{{% /admonition %}}
|
||||
|
||||
### Filter data by value
|
||||
|
||||
@@ -490,7 +492,9 @@ Here is the result after applying the Merge transformation.
|
||||
|
||||
Use this transformation to rename, reorder, or hide fields returned by the query.
|
||||
|
||||
> **Note:** This transformation only works in panels with a single query. If your panel has multiple queries, then you must either apply an Outer join transformation or remove the extra queries.
|
||||
{{% admonition type="note" %}}
|
||||
This transformation only works in panels with a single query. If your panel has multiple queries, then you must either apply an Outer join transformation or remove the extra queries.
|
||||
{{% /admonition %}}
|
||||
|
||||
Grafana displays a list of fields returned by the query. You can:
|
||||
|
||||
@@ -661,7 +665,9 @@ As you can see each row in the source data becomes a separate field. Each field
|
||||
|
||||
### Prepare time series
|
||||
|
||||
> **Note:** This transformation is available in Grafana 7.5.10+ and Grafana 8.0.6+.
|
||||
{{% admonition type="note" %}}
|
||||
This transformation is available in Grafana 7.5.10+ and Grafana 8.0.6+.
|
||||
{{% /admonition %}}
|
||||
|
||||
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/" >}}).
|
||||
|
||||
@@ -673,7 +679,9 @@ Select the `Wide time series` option to transform the time series data frame fro
|
||||
|
||||
### Series to rows
|
||||
|
||||
> **Note:** This transformation is available in Grafana 7.1+.
|
||||
{{% admonition type="note" %}}
|
||||
This transformation is available in Grafana 7.1+.
|
||||
{{% /admonition %}}
|
||||
|
||||
Use this transformation to combine the result from multiple time series data queries into one single result. This is helpful when using the table panel visualization.
|
||||
|
||||
@@ -737,6 +745,8 @@ Here is the result after adding a Limit transformation with a value of '3':
|
||||
|
||||
### Time series to table transform
|
||||
|
||||
> **Note:** This transformation is available in Grafana 9.5+ as an opt-in beta feature. Modify Grafana [configuration file]({{< relref "../../../setup-grafana/configure-grafana/#configuration-file-location" >}}) to enable the `timeSeriesTable` [feature toggle]({{< relref "../../../setup-grafana/configure-grafana/#feature_toggles" >}}) to use it.
|
||||
{{% admonition type="note" %}}
|
||||
This transformation is available in Grafana 9.5+ as an opt-in beta feature. Modify Grafana [configuration file]({{< relref "../../../setup-grafana/configure-grafana/#configuration-file-location" >}}) to enable the `timeSeriesTable` [feature toggle]({{< relref "../../../setup-grafana/configure-grafana/#feature_toggles" >}}) to use it.
|
||||
{{% /admonition %}}
|
||||
|
||||
Use this transformation to convert time series result into a table, converting time series data frame into a "Trend" field. "Trend" field can then be rendered using [sparkline cell type]({{< relref "../../visualizations/table/#sparkline" >}}), producing an inline sparkline for each table row. If there are multiple time series queries, each will result in a separate table data frame. These can be joined using join or merge transforms to produce a single table with multiple sparklines per row.
|
||||
|
||||
Reference in New Issue
Block a user