* [DOCS] Lens features and changes for 7.14 * Aggregation reference * Formatting * Fixes terminology * Updates from 8-Jul meeting * Terminology * Updates terminology, images, and tutorial steps * Update docs/user/dashboard/lens-advanced.asciidoc Co-authored-by: Wylie Conlon <wylieconlon@gmail.com> * Update docs/user/dashboard/create-panels-with-editors.asciidoc Co-authored-by: Wylie Conlon <wylieconlon@gmail.com> * Update docs/user/dashboard/lens.asciidoc Co-authored-by: Wylie Conlon <wylieconlon@gmail.com> * Comments from review * Cleans up unused images * Fixes image reference Co-authored-by: Wylie Conlon <wylieconlon@gmail.com>
496 lines
6 KiB
Text
496 lines
6 KiB
Text
[[aggregation-reference]]
|
|
== Create panels with editors
|
|
|
|
{kib} provides several editors that you can use to create panels of your data. Each editor supports different features and {ref}/search-aggregations.html[{es} aggregations]. To choose the best editor for your data, review the following information.
|
|
|
|
[float]
|
|
[[chart-types]]
|
|
=== Supported panel types
|
|
|
|
[options="header"]
|
|
|===
|
|
|
|
| Panel type | *Lens* | *TSVB* | *Aggregation-based* | *Vega* | *Timelion*
|
|
|
|
| Table
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
|
|
|
|
|
|
|
|
| Bar, line, and area
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
|
|
| Split chart and small multiples
|
|
|
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
|
|
|
|
|
| Pie and donut
|
|
| ✓
|
|
|
|
|
| ✓
|
|
| ✓
|
|
|
|
|
|
|
| Sunburst
|
|
| ✓
|
|
|
|
|
| ✓
|
|
| ✓
|
|
|
|
|
|
|
| Treemap
|
|
| ✓
|
|
|
|
|
|
|
|
| ✓
|
|
|
|
|
|
|
| Heatmap
|
|
| ✓
|
|
|
|
|
| ✓
|
|
| ✓
|
|
|
|
|
|
|
| Gauge and Goal
|
|
|
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
|
|
|
|
|
| Markdown
|
|
|
|
|
| ✓
|
|
|
|
|
|
|
|
|
|
|
|
|
| Metric
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
|
|
|
|
|
| Tag cloud
|
|
|
|
|
|
|
|
| ✓
|
|
| ✓
|
|
|
|
|
|
|
|===
|
|
|
|
[float]
|
|
[[xy-features]]
|
|
=== Bar, line, and area chart features
|
|
|
|
[options="header"]
|
|
|===
|
|
|
|
| Feature | *Lens* | *TSVB* | *Aggregation-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]
|
|
[[other-features]]
|
|
=== Advanced features
|
|
|
|
[options="header"]
|
|
|===
|
|
|
|
| Feature | *Lens* | *TSVB* | *Vega* | *Timelion*
|
|
|
|
| Math
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
|
|
| Math across indices
|
|
|
|
|
|
|
|
| ✓
|
|
| ✓
|
|
|
|
| Visualize two indices
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
|
|
| Time shift
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
|
|
| Custom {es} queries
|
|
|
|
|
|
|
|
| ✓
|
|
|
|
|
|
|
| Normalize by time
|
|
| ✓
|
|
| ✓
|
|
|
|
|
|
|
|
|
|
| Automatically generated suggestions
|
|
| ✓
|
|
|
|
|
|
|
|
|
|
|
|
|
| Annotations
|
|
|
|
|
| ✓
|
|
|
|
|
|
|
|
|
|
|===
|
|
|
|
[float]
|
|
[[table-features]]
|
|
=== Table features
|
|
|
|
[options="header"]
|
|
|===
|
|
|
|
| Feature | *Lens* | *TSVB* | *Aggregation-based*
|
|
|
|
| Summary row
|
|
| ✓
|
|
|
|
|
| ✓
|
|
|
|
| Pivot table
|
|
| ✓
|
|
|
|
|
|
|
|
|
|
| Calculated column
|
|
| Formula
|
|
| ✓
|
|
| Percent only
|
|
|
|
| Color by value
|
|
| ✓
|
|
| ✓
|
|
|
|
|
|
|
|===
|
|
|
|
[float]
|
|
[[custom-functions]]
|
|
=== Functions
|
|
|
|
[options="header"]
|
|
|===
|
|
|
|
| Function | *Lens* | *TSVB*
|
|
|
|
| Counter rate
|
|
| ✓
|
|
| ✓
|
|
|
|
| <<tsvb-function-reference, Filter ratio>>
|
|
| Use <<lens-formulas, formula>>
|
|
| ✓
|
|
|
|
| <<tsvb-function-reference, Positive only>>
|
|
|
|
|
| ✓
|
|
|
|
| <<tsvb-function-reference, Series agg>>
|
|
|
|
|
| ✓
|
|
|
|
| Static value
|
|
|
|
|
| ✓
|
|
|
|
|===
|
|
|
|
[float]
|
|
[[metrics-aggregations]]
|
|
=== Metrics aggregations
|
|
|
|
Metric aggregations are calculated from the values in the aggregated documents. The values are extracted from the document fields.
|
|
|
|
[options="header"]
|
|
|===
|
|
|
|
| Aggregation | *Lens* | *TSVB* | *Aggregation-based* | *Vega*
|
|
|
|
| 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
|
|
|
|
|
| ✓
|
|
|
|
|
| ✓
|
|
|
|
|===
|
|
|
|
For information about {es} metrics aggregations, refer to {ref}/search-aggregations-metrics.html[Metrics aggregations].
|
|
|
|
[float]
|
|
[[bucket-aggregations]]
|
|
=== Bucket aggregations
|
|
|
|
Bucket aggregations group, or bucket, documents based on the aggregation type. To define the document buckets, bucket aggregations compute and return the number of documents for each bucket.
|
|
|
|
[options="header"]
|
|
|===
|
|
| Aggregation | *Lens* | *TSVB* | *Aggregation-based* | *Vega*
|
|
|
|
| Histogram
|
|
| ✓
|
|
|
|
|
| ✓
|
|
| ✓
|
|
|
|
| Date histogram
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
|
|
| Date range
|
|
| Use filters
|
|
|
|
|
| ✓
|
|
| ✓
|
|
|
|
| Filter
|
|
|
|
|
| ✓
|
|
|
|
|
| ✓
|
|
|
|
| Filters
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
|
|
| GeoHash grid
|
|
|
|
|
|
|
|
| ✓
|
|
| ✓
|
|
|
|
| IP range
|
|
| Use filters
|
|
| Use filters
|
|
| ✓
|
|
| ✓
|
|
|
|
| Range
|
|
| ✓
|
|
| Use filters
|
|
| ✓
|
|
| ✓
|
|
|
|
| Terms
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
|
|
| Significant terms
|
|
|
|
|
|
|
|
| ✓
|
|
| ✓
|
|
|
|
|===
|
|
|
|
For information about {es} bucket aggregations, refer to {ref}/search-aggregations-bucket.html[Bucket aggregations].
|
|
|
|
[float]
|
|
[[pipeline-aggregations]]
|
|
=== Pipeline aggregations
|
|
|
|
Pipeline aggregations are dependent on the outputs calculated from other aggregations. Parent pipeline aggregations are provided with the output of the parent aggregation, and compute new buckets or aggregations that are added to existing buckets. Sibling pipeline aggregations are provided with the output of a sibling aggregation, and compute new aggregations for the same level as the sibling aggregation.
|
|
|
|
[options="header"]
|
|
|===
|
|
|
|
| Aggregation | *Lens* | *TSVB* | *Aggregation-based* | *Vega*
|
|
|
|
| Avg bucket
|
|
| <<lens-formulas, `overall_average` formula>>
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
|
|
| Derivative
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
|
|
| Max bucket
|
|
| <<lens-formulas, `overall_max` formula>>
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
|
|
| Min bucket
|
|
| <<lens-formulas, `overall_min` formula>>
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
|
|
| Sum bucket
|
|
| <<lens-formulas, `overall_sum` formula>>
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
|
|
| Moving average
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
|
|
| Cumulative sum
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
|
|
| Bucket script
|
|
|
|
|
|
|
|
| ✓
|
|
| ✓
|
|
|
|
| Bucket selector
|
|
|
|
|
|
|
|
|
|
|
| ✓
|
|
|
|
| Serial differencing
|
|
|
|
|
| ✓
|
|
| ✓
|
|
| ✓
|
|
|
|
|===
|
|
|
|
For information about {es} pipeline aggregations, refer to {ref}/search-aggregations-pipeline.html[Pipeline aggregations].
|
|
|
|
include::lens.asciidoc[]
|
|
include::tsvb.asciidoc[]
|
|
include::vega.asciidoc[]
|
|
include::aggregation-based.asciidoc[]
|
|
include::timelion.asciidoc[]
|