Update chart reference docs (#102430)

* Update chart reference docs

* Update from feedback

* Update from review feedback

* Update more from comments

* Apply left alignment
This commit is contained in:
Wylie Conlon 2021-06-23 09:53:16 -04:00 committed by GitHub
parent 6d8f53d8d0
commit f49ecb3d1a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 312 additions and 178 deletions

View file

@ -12,91 +12,168 @@ This reference can help simplify the comparison if you need a specific feature.
[options="header"]
|===
| Type | Aggregation-based | Lens | TSVB | Timelion | Vega
| Type | Lens | TSVB | Agg-based | Vega | Timelion
| Table
^| X
^| X
^| X
| ✓
| ✓
| ✓
|
|
| Table with summary row
^| X
^| X
|
| Bar, line, and area
| ✓
| ✓
| ✓
| ✓
| ✓
| Split chart/small multiples
|
| ✓
| ✓
| ✓
|
| Bar, line, and area charts
^| X
^| X
^| X
^| X
^| X
| Pie and donut
| ✓
|
| ✓
| ✓
|
| Percentage bar or area chart
| Sunburst
| ✓
|
^| X
^| X
| ✓
| ✓
|
^| X
| Split bar, line, and area charts
^| X
|
|
|
^| X
| Pie and donut charts
^| X
^| X
|
|
^| X
| Sunburst chart
^| X
^| X
| Treemap
| ✓
|
|
| ✓
|
| Heat map
^| X
^| X
| ✓
| ✓
| ✓
| ✓
|
|
^| X
| Gauge and Goal
^| X
|
^| X
|
| ✓
| ✓
| ✓
|
| Markdown
|
| ✓
|
^| X
|
|
| Metric
^| X
^| X
^| X
| ✓
| ✓
| ✓
| ✓
|
^| X
| Tag cloud
^| X
|
|
| ✓
| ✓
|
|===
[float]
[[table-features]]
=== Table features
[options="header"]
|===
| Type | Lens | TSVB | Agg-based
| Summary row
| ✓
|
| ✓
| Pivot table
| ✓
|
|
| Calculated column
| Formula
| ✓
| Percent only
| Color by value
| ✓
| ✓
|
|===
[float]
[[xy-features]]
=== Bar, line, area features
[options="header"]
|===
| Type | Lens | TSVB | Agg-based | Vega | Timelion
| Dense time series
| Customizable
| ✓
| Customizable
| ✓
| ✓
| Percentage mode
| ✓
| ✓
| ✓
| ✓
|
| Break downs
| 1
| 1
| 3
| ∞
| 1
| Custom color with break downs
|
| Only for Filters
| ✓
| ✓
|
| Fit missing values
| ✓
|
| ✓
| ✓
| ✓
| Synchronized tooltips
|
| ✓
|
|
|
^| X
|===
@ -111,67 +188,57 @@ For information about {es} bucket aggregations, refer to {ref}/search-aggregatio
[options="header"]
|===
| Type | Agg-based | Markdown | Lens | TSVB
| Type | Lens | TSVB | Agg-based
| Histogram
^| X
^| X
^| X
| ✓
|
| ✓
| Date histogram
^| X
^| X
^| X
^| X
| ✓
| ✓
| ✓
| Date range
^| X
^| X
|
| Use filters
|
| ✓
| Filter
^| X
^| X
|
^| X
| ✓
|
| Filters
^| X
^| X
^| X
^| X
| ✓
| ✓
| ✓
| GeoHash grid
^| X
^| X
|
|
| ✓
| IP range
^| X
^| X
|
|
| Use filters
| Use filters
| ✓
| Range
^| X
^| X
^| X
|
| ✓
| Use filters
| ✓
| Terms
^| X
^| X
^| X
^| X
| ✓
| ✓
| ✓
| Significant terms
^| X
^| X
|
^| X
|
| ✓
|===
@ -186,67 +253,57 @@ For information about {es} metrics aggregations, refer to {ref}/search-aggregati
[options="header"]
|===
| Type | Agg-based | Markdown | Lens | TSVB
| Type | Lens | TSVB | Agg-based
| Metrics with filters
| ✓
|
|
^| X
|
| Average
^| X
^| X
^| X
^| X
| Sum
^| X
^| X
^| X
^| X
| Average, Sum, Max, Min
| ✓
| ✓
| ✓
| Unique count (Cardinality)
^| X
^| X
^| X
^| X
| ✓
| ✓
| ✓
| Max
^| X
^| X
^| X
^| X
| Min
^| X
^| X
^| X
^| X
| Percentiles
^| X
^| X
^| X
^| X
| Percentiles and Median
| ✓
| ✓
| ✓
| Percentiles Rank
^| X
^| X
|
^| X
|
| ✓
| ✓
| Standard deviation
|
| ✓
| ✓
| Sum of squares
|
| ✓
|
| Top hit (Last value)
^| X
^| X
^| X
^| X
| ✓
| ✓
| ✓
| Value count
|
|
| ✓
| Variance
|
| ✓
|
^| X
|===
@ -261,61 +318,94 @@ For information about {es} pipeline aggregations, refer to {ref}/search-aggregat
[options="header"]
|===
| Type | Agg-based | Markdown | Lens | TSVB
| Type | Lens | TSVB | Agg-based
| Avg bucket
^| X
^| X
|
^| X
| <<lens-formulas, `overall_average` formula>>
| &check;
| &check;
| Derivative
^| X
^| X
^| X
^| X
| &check;
| &check;
| &check;
| Max bucket
^| X
^| X
|
^| X
| <<lens-formulas, `overall_max` formula>>
| &check;
| &check;
| Min bucket
^| X
^| X
|
^| X
| <<lens-formulas, `overall_min` formula>>
| &check;
| &check;
| Sum bucket
^| X
^| X
|
^| X
| <<lens-formulas, `overall_sum` formula>>
| &check;
| &check;
| Moving average
^| X
^| X
^| X
^| X
| &check;
| &check;
| &check;
| Cumulative sum
^| X
^| X
^| X
^| X
| &check;
| &check;
| &check;
| Bucket script
|
|
| &check;
| Bucket selector
|
^| X
|
|
| Serial differencing
^| X
^| X
|
^| X
| &check;
| &check;
|===
[float]
[[custom-functions]]
=== Additional functions
[options="header"]
|===
| Type | Lens | TSVB | Agg-based
| Counter rate
| &check;
| &check;
|
| <<tsvb-function-reference, Filter ratio>>
| Use <<lens-formulas, formula>>
| &check;
|
| <<tsvb-function-reference, Positive only>>
|
| &check;
|
| <<tsvb-function-reference, Series agg>>
|
| &check;
|
| Static value
|
| &check;
|
|===
@ -329,41 +419,49 @@ build their advanced visualization.
[options="header"]
|===
| Type | Agg-based | Lens | TSVB | Timelion | Vega
| Type | Lens | TSVB | Agg-based | Vega | Timelion
| Math on aggregated data
| Math
| &check;
| &check;
|
^| X
^| X
^| X
^| X
| &check;
| &check;
| Visualize two indices
| &check;
| &check;
|
^| X
^| X
^| X
^| X
| &check;
| &check;
| Math across indices
|
|
|
^| X
^| X
| &check;
| &check;
| Time shifts
| &check;
| &check;
|
^| X
^| X
^| X
^| X
| &check;
| &check;
| Fully custom {es} queries
|
|
|
| &check;
|
^| X
| Normalize by time
| &check;
| &check;
|
|
|
|===

View file

@ -139,6 +139,42 @@ image::images/lens_drag_drop_3.gif[Using drag and drop to reorder]
. Press Space bar to confirm, or to cancel, press Esc.
[float]
[[lens-formulas]]
==== Use formulas to perform math
Formulas let you perform math on aggregated data in Lens by typing
math and quick functions. To access formulas,
click the *Formula* tab in the dimension editor. Access the complete
reference for formulas from the help menu.
The most common formulas are dividing two values to produce a percent.
To display accurately, set *Value format* to *Percent*.
Filter ratio::
Use `kql=''` to filter one set of documents and compare it to other documents within the same grouping.
For example, to see how the error rate changes over time:
+
```
count(kql='response.status_code > 400') / count()
```
Week over week:: Use `shift='1w'` to get the value of each grouping from
the previous week. Time shift should not be used with the *Top values* function.
+
```
percentile(system.network.in.bytes, percentile=99) /
percentile(system.network.in.bytes, percentile=99, shift='1w')
```
Percent of total:: Formulas can calculate `overall_sum` for all the groupings,
which lets you convert each grouping into a percent of total:
+
```
sum(products.base_price) / overall_sum(sum(products.base_price))
```
[float]
[[lens-faq]]
==== Frequently asked questions