kibana/docs/user/dashboard/aggregation-reference.asciidoc
Wylie Conlon f49ecb3d1a
Update chart reference docs (#102430)
* Update chart reference docs

* Update from feedback

* Update from review feedback

* Update more from comments

* Apply left alignment
2021-06-23 09:53:16 -04:00

467 lines
4.9 KiB
Text

[[aggregation-reference]]
== Supported features by panel type
Each panel type in {kib} supports different features and {ref}/search-aggregations.html[{es} aggregations].
This reference can help simplify the comparison if you need a specific feature.
[float]
[[chart-types]]
=== Supported panel types by editor
[options="header"]
|===
| Type | Lens | TSVB | Agg-based | Vega | Timelion
| Table
| ✓
| ✓
| ✓
|
|
| Bar, line, and area
| ✓
| ✓
| ✓
| ✓
| ✓
| Split chart/small multiples
|
| ✓
| ✓
| ✓
|
| Pie and donut
| ✓
|
| ✓
| ✓
|
| Sunburst
| ✓
|
| ✓
| ✓
|
| Treemap
| ✓
|
|
| ✓
|
| Heat map
| ✓
| ✓
| ✓
| ✓
|
| Gauge and Goal
|
| ✓
| ✓
| ✓
|
| Markdown
|
| ✓
|
|
|
| Metric
| ✓
| ✓
| ✓
| ✓
|
| Tag cloud
|
|
| ✓
| ✓
|
|===
[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
|
| ✓
|
|
|
|===
[float]
[[bucket-aggregations]]
=== Bucket aggregations
Vega supports all bucket aggregations because it allows custom queries.
For information about {es} bucket aggregations, refer to {ref}/search-aggregations-bucket.html[Bucket aggregations].
[options="header"]
|===
| Type | Lens | TSVB | Agg-based
| Histogram
| ✓
|
| ✓
| Date histogram
| ✓
| ✓
| ✓
| Date range
| Use filters
|
| ✓
| Filter
|
| ✓
|
| Filters
| ✓
| ✓
| ✓
| GeoHash grid
|
|
| ✓
| IP range
| Use filters
| Use filters
| ✓
| Range
| ✓
| Use filters
| ✓
| Terms
| ✓
| ✓
| ✓
| Significant terms
|
|
| ✓
|===
[float]
[[metrics-aggregations]]
=== Metrics aggregations
Vega supports all metric aggregations because it allows custom queries.
For information about {es} metrics aggregations, refer to {ref}/search-aggregations-metrics.html[Metrics aggregations].
[options="header"]
|===
| Type | Lens | TSVB | Agg-based
| Metrics with filters
| ✓
|
|
| Average, Sum, Max, Min
| ✓
| ✓
| ✓
| Unique count (Cardinality)
| ✓
| ✓
| ✓
| Percentiles and Median
| ✓
| ✓
| ✓
| Percentiles Rank
|
| ✓
| ✓
| Standard deviation
|
| ✓
| ✓
| Sum of squares
|
| ✓
|
| Top hit (Last value)
| ✓
| ✓
| ✓
| Value count
|
|
| ✓
| Variance
|
| ✓
|
|===
[float]
[[pipeline-aggregations]]
=== Pipeline aggregations
Vega supports all pipeline aggregations because it allows custom queries.
For information about {es} pipeline aggregations, refer to {ref}/search-aggregations-pipeline.html[Pipeline aggregations].
[options="header"]
|===
| Type | Lens | TSVB | Agg-based
| Avg bucket
| <<lens-formulas, `overall_average` formula>>
| &check;
| &check;
| Derivative
| &check;
| &check;
| &check;
| Max bucket
| <<lens-formulas, `overall_max` formula>>
| &check;
| &check;
| Min bucket
| <<lens-formulas, `overall_min` formula>>
| &check;
| &check;
| Sum bucket
| <<lens-formulas, `overall_sum` formula>>
| &check;
| &check;
| Moving average
| &check;
| &check;
| &check;
| Cumulative sum
| &check;
| &check;
| &check;
| Bucket script
|
|
| &check;
| Bucket selector
|
|
|
| Serial differencing
|
| &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;
|
|===
[float]
[[other-features]]
=== Other features
This comparison is meant for users who are not sure about which {kib} panel type to
build their advanced visualization.
[options="header"]
|===
| Type | Lens | TSVB | Agg-based | Vega | Timelion
| Math
| &check;
| &check;
|
| &check;
| &check;
| Visualize two indices
| &check;
| &check;
|
| &check;
| &check;
| Math across indices
|
|
|
| &check;
| &check;
| Time shifts
| &check;
| &check;
|
| &check;
| &check;
| Fully custom {es} queries
|
|
|
| &check;
|
| Normalize by time
| &check;
| &check;
|
|
|
|===