Composite aggregationedit
A multi-bucket aggregation that creates composite buckets from different sources.
Unlike the other multi-bucket aggregation the composite aggregation can be used
to paginate all buckets from a multi-level aggregation efficiently. This aggregation
provides a way to stream all buckets of a specific aggregation similarly to what
scroll does for documents.
The composite buckets are built from the combinations of the values extracted/created for each document and each combination is considered as a composite bucket.
For instance the following document:
{
"keyword": ["foo", "bar"],
"number": [23, 65, 76]
}
... creates the following composite buckets when keyword and number are used as values source
for the aggregation:
{ "keyword": "foo", "number": 23 }
{ "keyword": "foo", "number": 65 }
{ "keyword": "foo", "number": 76 }
{ "keyword": "bar", "number": 23 }
{ "keyword": "bar", "number": 65 }
{ "keyword": "bar", "number": 76 }
Values sourceedit
The sources parameter controls the sources that should be used to build the composite buckets.
The order that the sources are defined is important because it also controls the order
the keys are returned.
The name given to each sources must be unique.
There are three different types of values source:
Termsedit
The terms value source is equivalent to a simple terms aggregation.
The values are extracted from a field or a script exactly like the terms aggregation.
Example:
GET /_search
{
"size": 0,
"aggs" : {
"my_buckets": {
"composite" : {
"sources" : [
{ "product": { "terms" : { "field": "product" } } }
]
}
}
}
}
Like the terms aggregation it is also possible to use a script to create the values for the composite buckets:
GET /_search
{
"size": 0,
"aggs" : {
"my_buckets": {
"composite" : {
"sources" : [
{
"product": {
"terms" : {
"script" : {
"source": "doc['product'].value",
"lang": "painless"
}
}
}
}
]
}
}
}
}
Histogramedit
The histogram value source can be applied on numeric values to build fixed size
interval over the values. The interval parameter defines how the numeric values should be
transformed. For instance an interval set to 5 will translate any numeric values to its closest interval,
a value of 101 would be translated to 100 which is the key for the interval between 100 and 105.
Example:
GET /_search
{
"size": 0,
"aggs" : {
"my_buckets": {
"composite" : {
"sources" : [
{ "histo": { "histogram" : { "field": "price", "interval": 5 } } }
]
}
}
}
}
The values are built from a numeric field or a script that return numerical values:
GET /_search
{
"size": 0,
"aggs" : {
"my_buckets": {
"composite" : {
"sources" : [
{
"histo": {
"histogram" : {
"interval": 5,
"script" : {
"source": "doc['price'].value",
"lang": "painless"
}
}
}
}
]
}
}
}
}
Date histogramedit
The date_histogram is similar to the histogram value source except that the interval
is specified by date/time expression:
GET /_search
{
"size": 0,
"aggs" : {
"my_buckets": {
"composite" : {
"sources" : [
{ "date": { "date_histogram" : { "field": "timestamp", "calendar_interval": "1d" } } }
]
}
}
}
}
The example above creates an interval per day and translates all timestamp values to the start of its closest intervals.
Available expressions for interval: year, quarter, month, week, day, hour, minute, second
Time values can also be specified via abbreviations supported by time units parsing.
Note that fractional time values are not supported, but you can address this by shifting to another
time unit (e.g., 1.5h could instead be specified as 90m).
Format
Internally, a date is represented as a 64 bit number representing a timestamp in milliseconds-since-the-epoch. These timestamps are returned as the bucket keys. It is possible to return a formatted date string instead using the format specified with the format parameter:
GET /_search
{
"size": 0,
"aggs" : {
"my_buckets": {
"composite" : {
"sources" : [
{
"date": {
"date_histogram" : {
"field": "timestamp",
"calendar_interval": "1d",
"format": "yyyy-MM-dd"
}
}
}
]
}
}
}
}
|
Supports expressive date format pattern |
Time Zone
Date-times are stored in Elasticsearch in UTC. By default, all bucketing and
rounding is also done in UTC. The time_zone parameter can be used to indicate
that bucketing should use a different time zone.
Time zones may either be specified as an ISO 8601 UTC offset (e.g. +01:00 or
-08:00) or as a timezone id, an identifier used in the TZ database like
America/Los_Angeles.
Offset
Use the offset parameter to change the start value of each bucket by the
specified positive (+) or negative offset (-) duration, such as 1h for
an hour, or 1d for a day. See Time units for more possible time
duration options.
For example, when using an interval of day, each bucket runs from midnight
to midnight. Setting the offset parameter to +6h changes each bucket
to run from 6am to 6am:
PUT my_index/_doc/1?refresh
{
"date": "2015-10-01T05:30:00Z"
}
PUT my_index/_doc/2?refresh
{
"date": "2015-10-01T06:30:00Z"
}
GET my_index/_search?size=0
{
"aggs": {
"my_buckets": {
"composite" : {
"sources" : [
{
"date": {
"date_histogram" : {
"field": "date",
"calendar_interval": "day",
"offset": "+6h",
"format": "iso8601"
}
}
}
]
}
}
}
}
Instead of a single bucket starting at midnight, the above request groups the documents into buckets starting at 6am:
{
...
"aggregations": {
"my_buckets": {
"after_key": { "date": "2015-10-01T06:00:00.000Z" },
"buckets": [
{
"key": { "date": "2015-09-30T06:00:00.000Z" },
"doc_count": 1
},
{
"key": { "date": "2015-10-01T06:00:00.000Z" },
"doc_count": 1
}
]
}
}
}
The start offset of each bucket is calculated after time_zone
adjustments have been made.
Mixing different values sourceedit
The sources parameter accepts an array of values source.
It is possible to mix different values source to create composite buckets.
For example:
GET /_search
{
"size": 0,
"aggs" : {
"my_buckets": {
"composite" : {
"sources" : [
{ "date": { "date_histogram": { "field": "timestamp", "calendar_interval": "1d" } } },
{ "product": { "terms": {"field": "product" } } }
]
}
}
}
}
This will create composite buckets from the values created by two values source, a date_histogram and a terms.
Each bucket is composed of two values, one for each value source defined in the aggregation.
Any type of combinations is allowed and the order in the array is preserved
in the composite buckets.
GET /_search
{
"size": 0,
"aggs" : {
"my_buckets": {
"composite" : {
"sources" : [
{ "shop": { "terms": {"field": "shop" } } },
{ "product": { "terms": { "field": "product" } } },
{ "date": { "date_histogram": { "field": "timestamp", "calendar_interval": "1d" } } }
]
}
}
}
}
Orderedit
By default the composite buckets are sorted by their natural ordering. Values are sorted
in ascending order of their values. When multiple value sources are requested, the ordering is done per value
source, the first value of the composite bucket is compared to the first value of the other composite bucket and if they are equals the
next values in the composite bucket are used for tie-breaking. This means that the composite bucket
[foo, 100] is considered smaller than [foobar, 0] because foo is considered smaller than foobar.
It is possible to define the direction of the sort for each value source by setting order to asc (default value)
or desc (descending order) directly in the value source definition.
For example:
GET /_search
{
"size": 0,
"aggs" : {
"my_buckets": {
"composite" : {
"sources" : [
{ "date": { "date_histogram": { "field": "timestamp", "calendar_interval": "1d", "order": "desc" } } },
{ "product": { "terms": {"field": "product", "order": "asc" } } }
]
}
}
}
}
... will sort the composite bucket in descending order when comparing values from the date_histogram source
and in ascending order when comparing values from the terms source.
Missing bucketedit
By default documents without a value for a given source are ignored.
It is possible to include them in the response by setting missing_bucket to
true (defaults to false):
GET /_search
{
"size": 0,
"aggs" : {
"my_buckets": {
"composite" : {
"sources" : [
{ "product_name": { "terms" : { "field": "product", "missing_bucket": true } } }
]
}
}
}
}
In the example above the source product_name will emit an explicit null value
for documents without a value for the field product.
The order specified in the source dictates whether the null values should rank
first (ascending order, asc) or last (descending order, desc).
Sizeedit
The size parameter can be set to define how many composite buckets should be returned.
Each composite bucket is considered as a single bucket so setting a size of 10 will return the
first 10 composite buckets created from the values source.
The response contains the values for each composite bucket in an array containing the values extracted
from each value source.
Paginationedit
If the number of composite buckets is too high (or unknown) to be returned in a single response
it is possible to split the retrieval in multiple requests.
Since the composite buckets are flat by nature, the requested size is exactly the number of composite buckets
that will be returned in the response (assuming that they are at least size composite buckets to return).
If all composite buckets should be retrieved it is preferable to use a small size (100 or 1000 for instance)
and then use the after parameter to retrieve the next results.
For example:
GET /_search
{
"size": 0,
"aggs" : {
"my_buckets": {
"composite" : {
"size": 2,
"sources" : [
{ "date": { "date_histogram": { "field": "timestamp", "calendar_interval": "1d" } } },
{ "product": { "terms": {"field": "product" } } }
]
}
}
}
}
... returns:
{
...
"aggregations": {
"my_buckets": {
"after_key": {
"date": 1494288000000,
"product": "mad max"
},
"buckets": [
{
"key": {
"date": 1494201600000,
"product": "rocky"
},
"doc_count": 1
},
{
"key": {
"date": 1494288000000,
"product": "mad max"
},
"doc_count": 2
}
]
}
}
}
To get the next set of buckets, resend the same aggregation with the after
parameter set to the after_key value returned in the response.
For example, this request uses the after_key value provided in the previous response:
GET /_search
{
"size": 0,
"aggs" : {
"my_buckets": {
"composite" : {
"size": 2,
"sources" : [
{ "date": { "date_histogram": { "field": "timestamp", "calendar_interval": "1d", "order": "desc" } } },
{ "product": { "terms": {"field": "product", "order": "asc" } } }
],
"after": { "date": 1494288000000, "product": "mad max" }
}
}
}
}
The after_key is usually the key to the last bucket returned in
the response, but that isn’t guaranteed. Always use the returned after_key instead
of derriving it from the buckets.
Early terminationedit
For optimal performance the index sort should be set on the index so that it matches parts or fully the source order in the composite aggregation. For instance the following index sort:
PUT twitter
{
"settings" : {
"index" : {
"sort.field" : ["username", "timestamp"],
"sort.order" : ["asc", "desc"]
}
},
"mappings": {
"properties": {
"username": {
"type": "keyword",
"doc_values": true
},
"timestamp": {
"type": "date"
}
}
}
}
|
This index is sorted by |
|
|
… in ascending order for the
|
GET /_search
{
"size": 0,
"aggs" : {
"my_buckets": {
"composite" : {
"sources" : [
{ "user_name": { "terms" : { "field": "user_name" } } }
]
}
}
}
}
GET /_search
{
"size": 0,
"aggs" : {
"my_buckets": {
"composite" : {
"sources" : [
{ "user_name": { "terms" : { "field": "user_name" } } },
{ "date": { "date_histogram": { "field": "timestamp", "calendar_interval": "1d", "order": "desc" } } }
]
}
}
}
}
|
|
|
|
|
In order to optimize the early termination it is advised to set track_total_hits in the request
to false. The number of total hits that match the request can be retrieved on the first request
and it would be costly to compute this number on every page:
GET /_search
{
"size": 0,
"track_total_hits": false,
"aggs" : {
"my_buckets": {
"composite" : {
"sources" : [
{ "user_name": { "terms" : { "field": "user_name" } } },
{ "date": { "date_histogram": { "field": "timestamp", "calendar_interval": "1d", "order": "desc" } } }
]
}
}
}
}
Note that the order of the source is important, in the example below switching the user_name with the timestamp
would deactivate the sort optimization since this configuration wouldn’t match the index sort specification.
If the order of sources do not matter for your use case you can follow these simple guidelines:
- Put the fields with the highest cardinality first.
- Make sure that the order of the field matches the order of the index sort.
- Put multi-valued fields last since they cannot be used for early termination.
index sort can slowdown indexing, it is very important to test index sorting
with your specific use case and dataset to ensure that it matches your requirement. If it doesn’t note that composite
aggregations will also try to early terminate on non-sorted indices if the query matches all document (match_all query).
Sub-aggregationsedit
Like any multi-bucket aggregations the composite aggregation can hold sub-aggregations.
These sub-aggregations can be used to compute other buckets or statistics on each composite bucket created by this
parent aggregation.
For instance the following example computes the average value of a field
per composite bucket:
GET /_search
{
"size": 0,
"aggs" : {
"my_buckets": {
"composite" : {
"sources" : [
{ "date": { "date_histogram": { "field": "timestamp", "calendar_interval": "1d", "order": "desc" } } },
{ "product": { "terms": {"field": "product" } } }
]
},
"aggregations": {
"the_avg": {
"avg": { "field": "price" }
}
}
}
}
}
... returns:
{
...
"aggregations": {
"my_buckets": {
"after_key": {
"date": 1494201600000,
"product": "rocky"
},
"buckets": [
{
"key": {
"date": 1494460800000,
"product": "apocalypse now"
},
"doc_count": 1,
"the_avg": {
"value": 10.0
}
},
{
"key": {
"date": 1494374400000,
"product": "mad max"
},
"doc_count": 1,
"the_avg": {
"value": 27.0
}
},
{
"key": {
"date": 1494288000000,
"product" : "mad max"
},
"doc_count": 2,
"the_avg": {
"value": 22.5
}
},
{
"key": {
"date": 1494201600000,
"product": "rocky"
},
"doc_count": 1,
"the_avg": {
"value": 10.0
}
}
]
}
}
}
Pipeline aggregationsedit
The composite agg is not currently compatible with pipeline aggregations, nor does it make sense in most cases. E.g. due to the paging nature of composite aggs, a single logical partition (one day for example) might be spread over multiple pages. Since pipeline aggregations are purely post-processing on the final list of buckets, running something like a derivative on a composite page could lead to inaccurate results as it is only taking into account a "partial" result on that page.
Pipeline aggs that are self contained to a single bucket (such as bucket_selector) might be supported in the future.