maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Final clean up

Browse source
This commit is contained in:
KOTungseth 2019-07-16 15:09:30 -05:00
parent 8d17eb2cc5
commit f9e82d5038
1 changed files with 57 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

85
docs/visualize/tsvb.asciidoc
View file

@ -8,79 +8,108 @@ meaningful way.
NOTE: In Elasticsearch version 7.3.0 and later, the time series data visualizer is now referred to simply as TSVB instead of Time Series Visual Builder.
TSVB comes with 6 types of visualizations:
TSVB comes with these types of visualizations:
* *Time Series* — A histogram visualization that supports area, line, bar, and steps along with multiple y-axis.
Time Series:: A histogram visualization that supports area, line, bar, and steps along with multiple y-axis.
[role="screenshot"]
image:images/tsvb-screenshot.png["Time series visualization"]
* *Metric* — Displays the latest number in a data series.
Metric:: Displays the latest number in a data series.
[role="screenshot"]
image:images/tsvb-metric.png["Metric visualization"]
* *Top N* — A horizontal bar chart where the y-axis is based on a series of metrics, and the x-axis is the latest value in the series.
Top N:: A horizontal bar chart where the y-axis is based on a series of metrics, and the x-axis is the latest value in the series.
[role="screenshot"]
image:images/tsvb-top-n.png["Top N visualization"]
* *Gauge* — A single value gauge visualization based on the latest value in a series.
Gauge:: A single value gauge visualization based on the latest value in a series.
[role="screenshot"]
image:images/tsvb-gauge.png["Gauge visualization"]
* *Markdown* — To customize the Markdown with data based on a set of series, enter Markdown text and embed Mustache template syntax.
Markdown:: Edit the data using using Markdown text and Mustache template syntax.
[role="screenshot"]
image:images/tsvb-markdown.png["Markdown visualization"]
* *Table* — Display data from multiple time series by defining the field group to show in the rows, and the columns of data to display.
Table:: Display data from multiple time series by defining the field group to show in the rows, and the columns of data to display.
[role="screenshot"]
image:images/tsvb-table.png["Table visualization"]
[float]
[[tsvb-data-series-options]]
=== Add the data series
=== Configure the data series
Add the data series that you want to display in the TSVB visualizations.
Add multiple data series with multiple aggregations composed together to create a single metric. The options available are dependent on the visualization.
. Select a visualization type.
. Select the visualization type.
. Select *Data*.
+ If you are using the *Table* visualization, select *Columns*.
. Specify the data series labels and colors.
. In the *Label* field, enter a name for the data series.
.. Select *Data*.
+
If you are using the *Table* visualization, select *Columns*.
.. In the *Label* field, enter a name for the data series, which is used on legends and titles.
+
For series that are grouped by a term, you can specify a mustache variable of `{{key}}` to substitute the term.
. To add another data series, make sure that *Time Series*, *Metric*, or *Top N* is selected, then click *+*.
.. If supported by the visualization, click the swatch and choose a color for the data series.
. Select *Metrics*, then specify the options from the drop down lists.
.. To add another data series, click *+*, then repeat the steps to specify the labels and colors.
. Specify the data series metrics.
.. Select *Metrics*.
.. From the drop down lists, choose your options.
.. To add another metric, click *+*.
+
To add another metric, click *+*. The last metric value is displayed, which is indicated by the eye icon.
. To specify how to group or split the data, select an option from the *Group by* drop down list.
When you add more than one metric, the last metric value is displayed, which is indicated by the eye icon.
. To specify the format and display options, select *Options*.
[float]
[[tsvb-data-metrics-options]]
=== Specify the index pattern and panel style options
. To specify how to group or split the data, choose an option from the *Group by* drop down list.
+
By default, the data series are grouped by everything.
Short description.
[float]
[[tsvb-panel-options]]
=== Configure the panel
Change the data that you want to display and choose the style options for the panel. The options available are dependent on the visualization.
. Select *Panel options*.
. Under *Data*, specify the Elasticsearch index pattern data that you want to display.
. Under *Data*, specify how much of the data that you want to display in the visualization.
. Under *Style*, specify the customization options for the visualization.
. Under *Style*, specify how you want the visualization to look.
[float]
[[tsvb-add-annotations]]
=== Add annotations
For the *Time Series* visualization, add annotations from another index.
Add annotation data sources for the Time Series visualization.
. Select *Annotations*.
. Click *Add data source*, then specify the data source options.
. Click *Add data source*, then specify the options.
[float]
[[tsvb-enter-markdown]]
=== Enter Markdown text
To customize the Markdown with data, embed Handlebar (mustache) syntax.
Edit the source for the Markdown visualization.
. Select *Markdown*.
. In the *Markdown* field, enter enter your Markdown text, then press Enter.
. In the editor, enter enter your Markdown text, then press Enter.
. To insert the mustache template variable into the editor, click the variable name.
+
The mustache syntax uses the Handlebar.js processor, which is an extended version of the Mustache template language.