mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 09:19:04 -04:00
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:
parent
6d8f53d8d0
commit
f49ecb3d1a
2 changed files with 312 additions and 178 deletions
|
@ -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>>
|
||||
| ✓
|
||||
| ✓
|
||||
|
||||
| Derivative
|
||||
^| X
|
||||
^| X
|
||||
^| X
|
||||
^| X
|
||||
| ✓
|
||||
| ✓
|
||||
| ✓
|
||||
|
||||
| Max bucket
|
||||
^| X
|
||||
^| X
|
||||
|
|
||||
^| X
|
||||
| <<lens-formulas, `overall_max` formula>>
|
||||
| ✓
|
||||
| ✓
|
||||
|
||||
| Min bucket
|
||||
^| X
|
||||
^| X
|
||||
|
|
||||
^| X
|
||||
| <<lens-formulas, `overall_min` formula>>
|
||||
| ✓
|
||||
| ✓
|
||||
|
||||
| Sum bucket
|
||||
^| X
|
||||
^| X
|
||||
|
|
||||
^| X
|
||||
| <<lens-formulas, `overall_sum` formula>>
|
||||
| ✓
|
||||
| ✓
|
||||
|
||||
| Moving average
|
||||
^| X
|
||||
^| X
|
||||
^| X
|
||||
^| X
|
||||
| ✓
|
||||
| ✓
|
||||
| ✓
|
||||
|
||||
| Cumulative sum
|
||||
^| X
|
||||
^| X
|
||||
^| X
|
||||
^| X
|
||||
| ✓
|
||||
| ✓
|
||||
| ✓
|
||||
|
||||
| Bucket script
|
||||
|
|
||||
|
|
||||
| ✓
|
||||
|
||||
| Bucket selector
|
||||
|
|
||||
^| X
|
||||
|
|
||||
|
|
||||
|
||||
| Serial differencing
|
||||
^| X
|
||||
^| X
|
||||
|
|
||||
^| X
|
||||
| ✓
|
||||
| ✓
|
||||
|
||||
|===
|
||||
|
||||
[float]
|
||||
[[custom-functions]]
|
||||
=== Additional functions
|
||||
|
||||
[options="header"]
|
||||
|===
|
||||
|
||||
| Type | Lens | TSVB | Agg-based
|
||||
|
||||
| Counter rate
|
||||
| ✓
|
||||
| ✓
|
||||
|
|
||||
|
||||
| <<tsvb-function-reference, Filter ratio>>
|
||||
| Use <<lens-formulas, formula>>
|
||||
| ✓
|
||||
|
|
||||
|
||||
| <<tsvb-function-reference, Positive only>>
|
||||
|
|
||||
| ✓
|
||||
|
|
||||
|
||||
| <<tsvb-function-reference, Series agg>>
|
||||
|
|
||||
| ✓
|
||||
|
|
||||
|
||||
| Static value
|
||||
|
|
||||
| ✓
|
||||
|
|
||||
|
||||
|
||||
|===
|
||||
|
||||
|
@ -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
|
||||
| ✓
|
||||
| ✓
|
||||
|
|
||||
^| X
|
||||
^| X
|
||||
^| X
|
||||
^| X
|
||||
| ✓
|
||||
| ✓
|
||||
|
||||
| Visualize two indices
|
||||
| ✓
|
||||
| ✓
|
||||
|
|
||||
^| X
|
||||
^| X
|
||||
^| X
|
||||
^| X
|
||||
| ✓
|
||||
| ✓
|
||||
|
||||
| Math across indices
|
||||
|
|
||||
|
|
||||
|
|
||||
^| X
|
||||
^| X
|
||||
| ✓
|
||||
| ✓
|
||||
|
||||
| Time shifts
|
||||
| ✓
|
||||
| ✓
|
||||
|
|
||||
^| X
|
||||
^| X
|
||||
^| X
|
||||
^| X
|
||||
| ✓
|
||||
| ✓
|
||||
|
||||
| Fully custom {es} queries
|
||||
|
|
||||
|
|
||||
|
|
||||
| ✓
|
||||
|
|
||||
^| X
|
||||
|
||||
| Normalize by time
|
||||
| ✓
|
||||
| ✓
|
||||
|
|
||||
|
|
||||
|
|
||||
|
||||
|
||||
|===
|
||||
|
|
|
@ -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
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue