Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Changed Visual Builder to TSVB #39539

Merged
merged 9 commits into from
Jul 22, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/management/rollups/visualize_rollup_data.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ beta[]

You can visualize your rolled up data in a variety of charts, tables, maps, and
more. Most visualizations support rolled up data, with the exception of
Timelion, Visual Builder, and Vega visualizations.
Timelion, TSVB, and Vega visualizations.

You create an index pattern for rolled up data the same way you do for any data,
in *Management > Kibana > Index patterns*. Clicking *Create index pattern* includes
Expand Down
6 changes: 2 additions & 4 deletions docs/visualize.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ locations.
[horizontal]
<<time-series-intro,Timelion>>:: Compute and combine data from multiple time series
data sets.
<<time-series-visual-builder,Time Series Visual Builder>>:: Visualize time series data using pipeline aggregations.
<<TSVB,TSVB>>:: Visualize time series data using pipeline aggregations.
* *Other*
[horizontal]
<<controls,Controls>>:: Controls provide the ability to add interactive inputs to Kibana Dashboards.
Expand Down Expand Up @@ -158,9 +158,7 @@ include::visualize/tilemap.asciidoc[]

include::visualize/regionmap.asciidoc[]

include::visualize/timelion.asciidoc[]

include::visualize/time-series-visual-builder.asciidoc[]
include::visualize/tsvb.asciidoc[]

include::visualize/tagcloud.asciidoc[]

Expand Down
219 changes: 0 additions & 219 deletions docs/visualize/time-series-visual-builder.asciidoc

This file was deleted.

120 changes: 120 additions & 0 deletions docs/visualize/tsvb.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
[[TSVB]]
== Visualizing your data with TSVB
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This title is ok, but it isn't consistent with the rest of the TOC.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is consistent with the new Timelion title. I'll update the rest when I reorg the Visualize section.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can find a way to use TSVB in the TOC, and "Visualizing your data with TSVB" as the page title. Otherwise, the TOC will be hard to scan if every title starts with "Visualizing..."


TSVB is a time series data visualizer that allows you to use the full power of the
Elasticsearch aggregation framework. With TSVB, you can combine an infinite
number of aggregations to display complex data.

NOTE: In Elasticsearch version 7.3.0 and later, the time series data visualizer is now referred to as TSVB instead of Time Series Visual Builder.

TSVB comes with these types of visualizations:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is a long list, how about adding a head 2, maybe "Visualization types", and using h3 for the types. And maybe this for the intro:

TSVB comes with six types of visualizations

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had it your way before, but I like this way better :)


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:: A metric that 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.

[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.

[role="screenshot"]
image:images/tsvb-gauge.png["Gauge visualization"]

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.

[role="screenshot"]
image:images/tsvb-table.png["Table visualization"]

[float]
[[create-tsvb-visualization]]
=== Create TSVB visualizations

To create a TSVB visualization, choose the data series you want to display, then choose how you want to display the data. The options available are dependent on the visualization.

[float]
[[tsvb-data-series-options]]
=== Configure the data series
KOTungseth marked this conversation as resolved.
Show resolved Hide resolved

To create a single metric, add multiple data series with multiple aggregations.

. Select the visualization type.

. Specify the data series labels and colors.

.. 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.

.. If supported by the visualization, click the swatch and choose a color for the data series.

.. 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 dropdown lists, choose your options.

.. To add another metric, click *+*.
+
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*.

. 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.

[float]
[[tsvb-panel-options]]
=== Configure the panel

Change the data that you want to display and choose the style options for the panel.

. Select *Panel options*.

. Under *Data*, specify how much of the data that you want to display in the visualization.

. Under *Style*, specify how you want the visualization to look.

[float]
[[tsvb-add-annotations]]
=== Add annotations

If you are using the Time Series visualization, add annotation data sources.

. Select *Annotations*.

. Click *Add data source*, then specify the options.

[float]
[[tsvb-enter-markdown]]
=== Enter Markdown text

Edit the source for the Markdown visualization.

. Select *Markdown*.

. 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 http://mustache.github.io/mustache.5.html[mustache syntax] uses the Handlebar.js processor, which is an extended version of the Mustache template language.