Commit ee328667 by Torkel Ödegaard

docs(table): updated table docs

parent 3dee7560
...@@ -52,13 +52,14 @@ pages: ...@@ -52,13 +52,14 @@ pages:
- ['reference/graph.md', 'Reference', 'Graph Panel'] - ['reference/graph.md', 'Reference', 'Graph Panel']
- ['reference/singlestat.md', 'Reference', 'Singlestat Panel'] - ['reference/singlestat.md', 'Reference', 'Singlestat Panel']
- ['reference/table_panel.md', 'Reference', 'Table Panel']
- ['reference/dashlist.md', 'Reference', 'Dashboard List Panel'] - ['reference/dashlist.md', 'Reference', 'Dashboard List Panel']
- ['reference/sharing.md', 'Reference', 'Sharing'] - ['reference/sharing.md', 'Reference', 'Sharing']
- ['reference/annotations.md', 'Reference', 'Annotations'] - ['reference/annotations.md', 'Reference', 'Annotations']
- ['reference/timerange.md', 'Reference', 'Time Range Controls'] - ['reference/timerange.md', 'Reference', 'Time Range']
- ['reference/search.md', 'Reference', 'Dashboard Search'] - ['reference/search.md', 'Reference', 'Search']
- ['reference/templating.md', 'Reference', 'Templated Dashboards'] - ['reference/templating.md', 'Reference', 'Templating']
- ['reference/scripting.md', 'Reference', 'Scripted Dashboards'] - ['reference/scripting.md', 'Reference', 'Scripting']
- ['reference/playlist.md', 'Reference', 'Playlist'] - ['reference/playlist.md', 'Reference', 'Playlist']
- ['reference/export_import.md', 'Reference', 'Import & Export'] - ['reference/export_import.md', 'Reference', 'Import & Export']
- ['reference/admin.md', 'Reference', 'Administration'] - ['reference/admin.md', 'Reference', 'Administration']
......
...@@ -6,86 +6,81 @@ page_keywords: grafana, table, panel, documentation ...@@ -6,86 +6,81 @@ page_keywords: grafana, table, panel, documentation
# Table Panel # Table Panel
![](/img/v2/table-panel.png) <img src="/img/v2/table-panel.png">
The new table panel is very flexible, supporting both multiple modes for time series as well as for The new table panel is very flexible, supporting both multiple modes for time series as well as for
table, annotation and raw JSON data. It also provides date formating and value formating and coloring options. table, annotation and raw JSON data. It also provides date formating and value formating and coloring options.
To view table panels in action and test different configurations with sample data, check out the [Table Panel Showcase in the Grafana Playground](http://play.grafana.org/dashboard/db/table-panel-showcase). To view table panels in action and test different configurations with sample data, check out the [Table Panel Showcase in the Grafana Playground](http://play.grafana.org/dashboard/db/table-panel-showcase).
## Configuration ## Options overview
The table pabel has many ways to manipulate your data for optimal presentation. The table panel has many ways to manipulate your data for optimal presentation.
![](/img/v2/table-config.png) <img class="no-shadow" src="/img/v2/table-config.png">
1. `Data`: The To Table Transform field . View Data Options for additional information. 1. `Data`: Control how your query is transformed into a table.
2. `Table Display`: 2. `Table Display`: Table display options.
3. `Column Styles`: The Column Styles rules provides the ability to control and override values based on defined rules. The column styles supports regex for value matching, and many 3. `Column Styles`: Column value formating and display options.
## Data to Table
<img class="no-shadow" src="/img/v2/table-data-options.png">
The data section contains the **To Table Transform (1)**. This is the primary option for how your data/metric
query should be transformed into a table format. The **Columns (2)** option allows you to select what columns
you want in the table. Only applicable for some transforms.
### Data Display ### Time series to rows
The Data Display is the primary control for the table panel, allowing you to select the structure of the data within your table <img src="/img/v2/table_ts_to_rows.png">
![](/img/v2/table-data-options.png)
1. `To Table Transform`: The options to transform the table
2. `Columns`: The columns field **needs help from Torkel**
#### To Table Transform
##### Time series to rows
![](/img/v2/table_ts_to_rows.png)
In the most simple mode you can turn time series to rows. This means you get a `Time`, `Metric` and a `Value` column. Where `Metric` is the name of the time series. In the most simple mode you can turn time series to rows. This means you get a `Time`, `Metric` and a `Value` column. Where `Metric` is the name of the time series.
### Time series to columns
#### Time series to columns
![](/img/v2/table_ts_to_columns.png) ![](/img/v2/table_ts_to_columns.png)
This transform allows you to take multiple time series and group them by time. Which will result in the primary column being `Time` and a column for each time series. This transform allows you to take multiple time series and group them by time. Which will result in the primary column being `Time` and a column for each time series.
#### Time series aggregations ### Time series aggregations
![](/img/v2/table_ts_to_aggregations.png) ![](/img/v2/table_ts_to_aggregations.png)
This table transformation will lay out your table into rows by metric, allowing columns of `Avg`, `Min`, `Max`, `Total`, `Current` and `Count`. More than one column can be added. This table transformation will lay out your table into rows by metric, allowing columns of `Avg`, `Min`, `Max`, `Total`, `Current` and `Count`. More than one column can be added.
#### Annotations ### Annotations
![](/img/v2/table_annotations.png) ![](/img/v2/table_annotations.png)
** I need some help explaining this. ** If you have annotations enabled in the dashboard you can have the table show them. If you configure this
mode then any queries you have in the metrics tab will be ignored.
### JSON Data
#### JSON Data
![](/img/v2/table_json_data.png) ![](/img/v2/table_json_data.png)
** I need some help explaining this. ** If you have an Elasticsearch **Raw Document** query or an Elasticsearch query without a `date histogram` use this
transform mode and pick the columns using the **Columns** section.
![](/img/v2/elastic_raw_doc.png)
### Table Display ## Table Display
![](/img/v2/table-display.png) <img class="no-shadow" src="/img/v2/table-display.png">
1. `Pagination (Page Size)`: The table display fields allow you to control The `Pagination` (page size) is the threshold at which the table rows will be broken into pages. For example, if your table had 95 records with a pagination value of 10, your table would be split across 9 pages. 1. `Pagination (Page Size)`: The table display fields allow you to control The `Pagination` (page size) is the threshold at which the table rows will be broken into pages. For example, if your table had 95 records with a pagination value of 10, your table would be split across 9 pages.
2. `Scroll`: The `scroll bar` checkbox toggles the ability to scroll within the panel, when unchecked, the panel height will grow to display all rows. 2. `Scroll`: The `scroll bar` checkbox toggles the ability to scroll within the panel, when unchecked, the panel height will grow to display all rows.
3. `Font Size`: The `font size` field allows you to increase or decrease the size for the panel, relative to the default font size. 3. `Font Size`: The `font size` field allows you to increase or decrease the size for the panel, relative to the default font size.
### Column Styles ## Column Styles
The column styles allow you control how dates and numbers are formatted. The column styles allow you control how dates and numbers are formatted.
![](/img/v2/Column-Options.png) <img class="no-shadow" src="/img/v2/Column-Options.png">
1. `Name or regex`: The Name or Regex field allows for simple or complex matching of metrics formatted within the table. Standard regex formatting is accepted. 1. `Name or regex`: The Name or Regex field controls what columns the rule should be applied to. The regex or name filter will be matched against the column name not against column values.
2. `Type`: The three supported types of types are `Number`, `String` and `Date`. 2. `Type`: The three supported types of types are `Number`, `String` and `Date`.
3. `Supplemental Type Information`: The `Number` and `Date` fields allow for additional configuration of styles. 3. `Format`: Specify date format. Only available when `Type` is set to `Date`.
- The `Number` field lets you select how the entire Cell, Value or Row is colored when matching the specified criteria, defined in the Tresholds fields next to it. Additionally, the units and decimals of these matched values can be specified. 4. `Coloring` and `Thresholds`: Specify color mode and thresholds limits.
- The `Date` field, the format of the date may be selected from a preset list of date formats, however free entry is also supported. Standard date formatting of `Y`ear, `M`onth, `D`ay, `H`our, `m`inute and `s`econds are supported. 5. `Unit` and `Decimals`: Specify unit and decimal precision for numbers.
4. `Coloring` and `Thresholds`: The color and thresholds for all columns matched in the Name or Regex field can be specified. 6. `Add column style rule`: Add new column rule.
5. `Unit` and `Decimals`: The Unit and Decimal values apply to all numbers appearing within the columns matched in the Name or Regex field.
6. `Add column style rule`: Multiple column rules are supported on tables.
<li><a class='version' href='/v2.6'>Version v2.6</a></li>
<li><a class='version' href='/v2.5'>Version v2.5</a></li> <li><a class='version' href='/v2.5'>Version v2.5</a></li>
<li><a class='version' href='/v2.1'>Version v2.1</a></li> <li><a class='version' href='/v2.1'>Version v2.1</a></li>
<li><a class='version' href='/v2.0'>Version v2.0</a></li> <li><a class='version' href='/v2.0'>Version v2.0</a></li>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment