opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-28 01:02:10 +08:00
Code Issues Packages Projects Releases Wiki Activity

Docs: added documentation for the "prepare time series"-transformation. (#36761)

Browse Source 
* added documentation for the prepare time series transformation.

* Update docs/sources/developers/plugins/data-frames.md

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>

* Update docs/sources/panels/transformations/types-options.md

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>

* Update docs/sources/panels/transformations/types-options.md

Co-authored-by: Marcus Olsson <marcus.olsson@hey.com>

* Update docs/sources/panels/transformations/types-options.md

Co-authored-by: Marcus Olsson <marcus.olsson@hey.com>

* changed according to feedbcak.

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>
Co-authored-by: Marcus Olsson <marcus.olsson@hey.com>
This commit is contained in:
Marcus Andersson
2021-07-16 10:41:15 +02:00
committed by GitHub
parent 1c74bb3992
commit 8e386b9da5
2 changed files with 63 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/sources/developers/plugins/data-frames.md
View File

@ -30,17 +30,17 @@ In essence, a data frame is a collection of _fields_, where each field correspon
```ts
interface Field {
name: string;
// Prometheus like Labels / Tags
labels?: Record<string, string>;
name: string;
// Prometheus like Labels / Tags
labels?: Record<string, string>;
// For example string, number, time (or more specific primitives in the backend)
type: FieldType;
// Array of values all of the same type
values: Vector<T>;
// For example string, number, time (or more specific primitives in the backend)
type: FieldType;
// Array of values all of the same type
values: Vector<T>;
// Optional display data for the field (e.g. unit, name over-ride, etc)
config: FieldConfig;
// Optional display data for the field (e.g. unit, name over-ride, etc)
config: FieldConfig;
}
```
@ -163,6 +163,8 @@ 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/transformations/types-options.md#prepare-time-series" >}}).
## Technical references
This section contains links to technical reference and implementations of data frames.