Skip to content

Commit

Permalink
[DOCS] TSVB updates for 7.12 (elastic#93317)
Browse files Browse the repository at this point in the history
* [DOCS] TSVB updates for 7.12

* Fixes formatting

* Clean up

* Review comments

* Update docs/user/dashboard/tsvb.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/user/dashboard/tsvb.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Update docs/user/dashboard/tsvb.asciidoc

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>

* Review comments

Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
  • Loading branch information
KOTungseth and wylieconlon committed Mar 15, 2021
1 parent 217642b commit 13c17a0
Show file tree
Hide file tree
Showing 3 changed files with 124 additions and 84 deletions.
Binary file added docs/user/dashboard/images/tsvb_clone_series.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion docs/user/dashboard/timelion.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
[[create-panels-with-timelion]]
=== Timelion

Instead of using a visual editor to create charts, you define a graph by chaining functions together, using a timelion specific syntax. This syntax enables some features that classical point series charts don't offer - like drawing data from different indices or data sources into one graph.
Instead of using a visual editor to create charts, you define a graph by chaining functions together, using the *Timelion*-specific syntax.
The syntax enables some features that classical point series charts don't offer, such as pulling data from different indices or data sources into one graph.

[NOTE]
====
Expand Down
205 changes: 122 additions & 83 deletions docs/user/dashboard/tsvb.asciidoc
Original file line number Diff line number Diff line change
@@ -1,123 +1,162 @@
[[TSVB]]
=== TSVB

*TSVB* requires a date field and supports <<aggregation-reference, most {es} metric aggregations>>, multiple visualization types, custom functions,
and some math.

TIP: With *TSVB*, you can visualize the data from multiple series, but only *Timelion* can perform math across layers.
*TSVB* enables you to visualize the data from multiple data series, supports <<aggregation-reference,
most {es} metric aggregations>>, multiple visualization types, custom functions, and some math. To use *TSVB*, your data must have a date field.

[float]
[[tsvb-required-choices]]
==== Requirements
==== Open and set up TSVB

Open *TSVB*, then make sure the required settings are configured.

. On the dashboard, click *Create panel*.

. On the *New visualization* window, click *TSVB*.

. In *TSVB*, click *Panel options*, then make sure the following settings are configured:

When you open *TSVB*, click *Panel options*, then verify the following:
* *Index pattern*
* *Time field*
* *Interval*

* The index pattern, time field, and interval are configured
* Specify if you want to show the last bucket, which usually contains partial data
* For non-time series visualizations, specify if you want the *Data timerange mode*.
* Specify any <<kuery-query, KQL filters>> to select specific documents
. Select a *Drop last bucket* option. It is dropped by default because the time filter intersects the time range of the last bucket, but can be enabled to see the partial data.

. In the *Panel filter* field, specify any <<kuery-query, KQL filters>> to select specific documents.

[float]
==== Visualization options
[[configure-the-data-series]]
==== Configure the series

Each *TSVB* visualization shares the same options to create a *Series*. Each series can be thought of as a separate {es} aggregation.
For each series, the *Options* control the styling and {es} options, and are inherited from *Panel options*.
When you have separate options for each series, you can compare different {es} indices, and view two time ranges from the same index.

To configure the value of each series, select the function, then configure the function inputs. Only the last function is displayed.

. From the *Aggregation* dropdown, select the function for the series.

. To display each group separately, select one of the following options from the *Group by* dropdown:

Time series::
By default, the Y axis shows the full range of data, including zero. To scale the axis from
the minimum to maximum values of the data automatically, go to *Series > Options > Fill* and set *Fill to 0*.
You can add annotations to the x-axis based on timestamped documents in a separate {es} index.
* *Filters* &mdash; Groups the data into the specified filters. To differentiate the groups, assign a color to each filter.

All other chart types::
*Panel options > Data timerange mode* controls the timespan used for matching documents.
*Last value* is unable to match all documents, only the specific interval.
*Entire timerange* matches all the documents specified in the time filter.
* *Terms* &mdash; Displays the top values of the field. The color is only configurable in the *Time Series* chart. To configure, click *Options*, then select an option from the *Split color theme* dropdown.

. Click *Options*, then configure the inputs for the function.

[float]
[[configure-the-visualizations]]
==== TSVB visualization options

The configuration options differ for each *TSVB* visualization.

[float]
[[tsvb-time-series]]
===== Time Series

By default, the y-axis displays the full range of data, including zero. To automatically scale the y-axis from
the minimum to maximum values of the data, click *Data > Options > Fill*, then enter `0` in the *Fill* field.
You can add annotations to the x-axis based on timestamped documents in a separate {es} index.

[float]
[[all-chart-types-except-time-series]]
===== All chart types except Time Series

Metric, Top N, and Gauge::
*Panel options > Color rules* contains conditional coloring based on the values.
The *Data timerange mode* dropdown in *Panel options* controls the timespan that *TSVB* uses to match documents.
*Last value* is unable to match all documents, only the specific interval. *Entire timerange* matches all documents specified in the time filter.

Top N and Table::
When you click a series, *TSVB* applies a filter based
on the series name. To change this behavior, configure *Panel options > Item URL*,
which opens a URL instead of applying a filter on click.
[float]
[[metric-topn-gauge]]
===== Metric, Top N, and Gauge

Markdown::
Supports Markdown with Handlebars syntax to insert dynamic data. Also supports
custom CSS using LESS syntax.
*Color rules* in *Panel options* contains conditional coloring based on the values.

[float]
[[tsvb-series-options]]
==== Understanding the TSVB series panel
[[topn-table]]
===== Top N and Table

Every visualization shares the same interface for creating a *Series*.
Each series can be thought of as a separate {es} aggregation, which prevents
them from being compared with math. Each series has an *Options* tab
that controls the styling and {es} options, which are inherited from the *Panel options*.
Having separate options for each series allows you to compare different
{es} indices, or to view two time periods from the same index.
When you click a series, *TSVB* applies a filter based on the series name.
To change this behavior, click *Panel options*, then specify a URL in the *Item URL* field, which opens a URL instead of applying a filter on click.

To configure the value of each series, select the function first and then the inputs to
the function. Only the last function is displayed.
[float]
[[tsvb-markdown]]
===== Markdown

Series can optionally have a *Group by*, which will show each group separately in the chart.
The *Filters* grouping lets you assign a color to each filter. The *Terms* grouping has special
behavior in the *Time series* chart, which is controlled by *Options > Split color theme*.
The *Markdown* visualization supports Markdown with Handlebar (mustache) syntax to insert dynamic data, and supports custom CSS using the LESS syntax.

[float]
[[tsvb-reference]]
==== TSVB reference
[[tsvb-function-reference]]
==== TSVB function reference

TSVB has implemented shortcuts for some frequently-used functions.
*TSVB* provides you with shortcuts for some frequently-used functions.

Filter ratio::
Returns a percent value by calculating a metric on two sets of documents. For example, calculate the error rate as a percentage of the overall events over time.
*Filter Ratio*::
Returns a percent value by calculating a metric on two sets of documents.
For example, calculate the error rate as a percentage of the overall events over time.

Counter rate::
Used for when dealing with monotonically increasing counters. Shortcut for max, derivative and positive only.
*Counter Rate*::
Used when dealing with monotonically increasing counters. Shortcut for *Max*, *Derivative*, and *Positive Only*.

Positive only::
*Positive Only*::
Removes any negative values from the results, which can be used as a post-processing step
after a derivative.

Series agg::
*Series Agg*::
Applies a function to all of the *Group by* series to reduce the values to a single number.
This function must always be the last metric in the series.
+
For example, if the Time series chart is showing 10 series, applying a "sum" series agg will calculate
For example, if the *Time Series* visualization shows 10 series, the sum *Series Agg* calculates
the sum of all 10 bars and output a single Y value per X value. This is often confused
with the overall sum function, which outputs a single Y value per unique series.

Math::
The math context is able to do both simple and advanced calculations per series.
*Math*::
The math context is able to do simple and advanced calculations per series.
This function must always be the last metric in the series.

[float]
[[tsvb-faq]]
==== Frequently asked questions

Why is my TSVB visualization missing data?::
It depends, but most often it's two causes:

1. If looking at a *Time series* chart with a derivative function, the time interval might be too small.
Derivatives require sequential values,
2. If looking at anything but *Time series* in TSVB, the cause is probably the *Data timerange mode*.
This is controlled by *Panel options > Data timerange mode > Entire time range*. This is because
TSVB defaults to showing the *last whole bucket*. If the time range is "last 24 hours", and the
current time is 9:41, then TSVB metrics will be only show 10 minutes: from 9:30 to 9:40.

How do I calculate the difference between two series?::
TSVB doesn't support math across series, but <<create-panels-with-timelion, Timelion>> does. <<vega, Vega>> can also do this.

How do I view the current vs previous month?::
While it's not possible to do math on these two, TSVB supports series with time offsets.
Click *Clone Series*, and then choose a new color for the new series. Go toc
*Options > Offset series time by* and choose an offset value.

How do I calculate a month over month change?::
This is not fully supported in TSVB, but there is a special case that is supported *if* the TSVB
time range is set to 3 months or more *and* the time interval is one month. Use the `derivative`
to get the absolute monthly change. To convert to a percent, add a `math` function with the formula
`params.current / (params.current - params.derivative)`, and then set the formatter to Percent.
+
For other types of month over month calculations, use <<create-panels-with-timelion, Timelion>> or <<vega, Vega>>.

How do I calculate the duration between start and end of an event?::
TSVB can't do this because it requires correlation between different time periods. TSVB requires
that the duration is pre-calculated.
For answers to frequently asked *TSVB* question, review the following.

[float]
===== Why is my TSVB visualization missing data?

It depends, but most often there are two causes:

* For *Time series* visualizations with a derivative function, the time interval can be too small. Derivatives require sequential values.

* For all other *TSVB* visualizations, the cause is probably the *Data timerange mode*, which is controlled by *Panel options > Data timerange mode > Entire time range*.
By default, *TSVB* displays the last whole bucket. For example, if the time filter is set to *Last 24 hours*, and the
current time is 9:41, *TSVB* displays only the last 10 minutes &mdash; from 9:30 to 9:40.

[float]
===== How do I calculate the difference between two data series?

Performing math across data series is unsupported in *TSVB*. To calculate the difference between two data series, use <<create-panels-with-timelion, Timelion>> or <<vega, Vega>>.

[float]
===== How do I compare the current versus previous month?

*TSVB* can display two series with time offsets, but it can't perform math across series. To add a time offset:

. Click *Clone Series*, then choose a color for the new series.
+
[role="screenshot"]
image::images/tsvb_clone_series.png[Clone Series action]

. Click *Options*, then enter the offset value in the *Offset series time by* field.

[float]
===== How do I calculate a month over month change?

The ability to calculate a month over month change is not fully supported in *TSVB*, but there is a special case that is supported _if_ the
time filter is set to 3 months or more _and_ the *Interval* is `1m`. Use the *Derivative* to get the absolute monthly change. To convert to a percent,
add the *Math* function with the `params.current / (params.current - params.derivative)` formula, then select *Percent* from the *Data Formatter* dropdown.

For other types of month over month calculations, use <<create-panels-with-timelion, Timelion>> or <<vega, Vega>>.

[float]
===== How do I calculate the duration between the start and end of an event?

Calculating the duration between the start and end of an event is unsupported in *TSVB* because *TSVB* requires correlation between different time periods.
*TSVB* requires that the duration is pre-calculated.

0 comments on commit 13c17a0

Please sign in to comment.