elasticsearch/docs/reference/aggregations/bucket
Salvatore Campagna 9de75c2ac5
Add an aggregator for IPv4 and IPv6 subnets (#82410)
Parameters accepted by the aggregator include:

* prefix_length (integer, required): defines the network size of the subnet mask;
* is_ipv6 (boolean, optional, default: false): defines whether the prefix applies to IPv6 (true) or IPv4 (false) IP addresses;
* min_doc_count (integer, optional, default: 1): defines the minimum number of documents for a bucket to be returned in the results;
* append_prefix_length (boolean, optional, default: false): defines if the prefix length is appended to the IP address key when returning results;
* keyed (boolean, optional, default: false): defines whether the result is returned keyed or as an array of buckets;

Each bucket returned by the aggregator represents a different subnet. IPv4 subnets also include a netmask field set to the subnet mask value (i.e. "255.255.0.0" for a /16 subnet).

Related to: #57964 and elastic/kibana#68424
2022-01-28 11:59:07 +01:00
..
adjacency-matrix-aggregation.asciidoc [DOCS] Reformat adjacency matrix agg reference (#70034) 2021-03-08 12:33:46 -05:00
autodatehistogram-aggregation.asciidoc Convert bucket aggs docs to runtime fields (#71202) 2021-04-02 12:12:06 -04:00
categorize-text-aggregation.asciidoc [ML] fail on poor configuration for categorize_text (#79586) 2021-10-21 12:14:27 -04:00
children-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
composite-aggregation.asciidoc [DOCS] Clarify supported parameters for terms value source (#81775) 2021-12-15 14:32:16 -05:00
datehistogram-aggregation.asciidoc Remove deprecated date histo interval (#75000) 2021-07-20 13:08:45 -04:00
daterange-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
diversified-sampler-aggregation.asciidoc Convert bucket aggs docs to runtime fields (#71202) 2021-04-02 12:12:06 -04:00
filter-aggregation.asciidoc Update docs for filter agg (#72508) 2021-05-06 14:51:16 -04:00
filters-aggregation.asciidoc Update docs for filter agg (#72508) 2021-05-06 14:51:16 -04:00
geodistance-aggregation.asciidoc [DOCS] Fix typo (#82344) (#82379) 2022-01-10 13:47:03 -05:00
geohashgrid-aggregation.asciidoc [GeoPoint] Grid aggregations with bounds should exclude touching tiles (#72493) 2021-04-30 08:43:18 +02:00
geohexgrid-aggregation.asciidoc New GeoHexGrid aggregation (#82924) 2022-01-27 07:45:51 +01:00
geotilegrid-aggregation.asciidoc [GeoPoint] Grid aggregations with bounds should exclude touching tiles (#72493) 2021-04-30 08:43:18 +02:00
global-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
histogram-aggregation.asciidoc [DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
ipprefix-aggregation.asciidoc Add an aggregator for IPv4 and IPv6 subnets (#82410) 2022-01-28 11:59:07 +01:00
iprange-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
missing-aggregation.asciidoc Update JSON parser and snippets (#77983) 2021-09-20 11:08:26 +01:00
multi-terms-aggregation.asciidoc [DOCS] Remove testenv annotations from doc snippet tests (#80023) 2021-11-05 18:38:50 -04:00
nested-aggregation.asciidoc [DOCS] Add filter example to nested agg docs (#76118) 2021-08-05 09:48:28 -04:00
parent-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
range-aggregation.asciidoc [DOCS] Include index in range agg snippets (#77290) (#77568) 2021-09-10 12:36:05 -04:00
range-field-note.asciidoc [DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
rare-terms-aggregation.asciidoc [DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
reverse-nested-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
sampler-aggregation.asciidoc [DOCS] Change agg titles to sentence case (#64425) 2020-10-30 13:25:21 -04:00
significantterms-aggregation.asciidoc [ML] add new normalize_above parameter to p_value significant terms heuristic (#78833) 2021-10-12 10:38:09 -04:00
significanttext-aggregation.asciidoc [DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
terms-aggregation.asciidoc [DOCS] Re-add paragraph noting doc_count is approximate (#83154) 2022-01-26 11:07:59 -05:00
variablewidthhistogram-aggregation.asciidoc Drop experimental from variable width histogram (#66055) 2020-12-08 14:15:21 -05:00