diff options
Diffstat (limited to 'docs/reference/aggregations/metrics.asciidoc')
-rw-r--r-- | docs/reference/aggregations/metrics.asciidoc | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/reference/aggregations/metrics.asciidoc b/docs/reference/aggregations/metrics.asciidoc new file mode 100644 index 0000000000..f80c36f2eb --- /dev/null +++ b/docs/reference/aggregations/metrics.asciidoc @@ -0,0 +1,48 @@ +[[search-aggregations-metrics]] +== Metrics Aggregations + +The aggregations in this family compute metrics based on values extracted in one way or another from the documents that +are being aggregated. The values are typically extracted from the fields of the document (using the field data), but +can also be generated using scripts. + +Numeric metrics aggregations are a special type of metrics aggregation which output numeric values. Some aggregations output +a single numeric metric (e.g. `avg`) and are called `single-value numeric metrics aggregation`, others generate multiple +metrics (e.g. `stats`) and are called `multi-value numeric metrics aggregation`. The distinction between single-value and +multi-value numeric metrics aggregations plays a role when these aggregations serve as direct sub-aggregations of some +bucket aggregations (some bucket aggregations enable you to sort the returned buckets based on the numeric metrics in each bucket). + +include::metrics/avg-aggregation.asciidoc[] + +include::metrics/cardinality-aggregation.asciidoc[] + +include::metrics/extendedstats-aggregation.asciidoc[] + +include::metrics/geobounds-aggregation.asciidoc[] + +include::metrics/max-aggregation.asciidoc[] + +include::metrics/min-aggregation.asciidoc[] + +include::metrics/percentile-aggregation.asciidoc[] + +include::metrics/percentile-rank-aggregation.asciidoc[] + +include::metrics/scripted-metric-aggregation.asciidoc[] + +include::metrics/stats-aggregation.asciidoc[] + +include::metrics/sum-aggregation.asciidoc[] + +include::metrics/tophits-aggregation.asciidoc[] + +include::metrics/valuecount-aggregation.asciidoc[] + + + + + + + + + + |