Aggregations

OpenSearch isn’t just for search. Aggregations let you tap into OpenSearch’s powerful analytics engine to analyze your data and extract statistics from it.

The use cases of aggregations vary from analyzing data in real time to take some action to using OpenSearch Dashboards to create a visualization dashboard.

OpenSearch can perform aggregations on massive datasets in milliseconds. Compared to queries, aggregations consume more CPU cycles and memory.

Aggregations on text fields

By default, OpenSearch doesn’t support aggregations on a text field. Because text fields are tokenized, an aggregation on a text field has to reverse the tokenization process back to its original string and then formulate an aggregation based on that. This kind of an operation consumes significant memory and degrades cluster performance.

While you can enable aggregations on text fields by setting the fielddata parameter to true in the mapping, the aggregations are still based on the tokenized words and not on the raw text.

We recommend keeping a raw version of the text field as a keyword field that you can aggregate on.

In this case, you can perform aggregations on the title.raw field, instead of on the title field:

  1. PUT movies
  2. {
  3.   "mappings": {
  4.     "properties": {
  5.       "title": {
  6.         "type": "text",
  7.         "fielddata": true,
  8.         "fields": {
  9.           "raw": {
  10.             "type": "keyword"
  11.           }
  12.         }
  13.       }
  14.     }
  15.   }
  16. }

General aggregation structure

The structure of an aggregation query is as follows:

  1. GET _search
  2. {
  3.   "size": 0,
  4.   "aggs": {
  5.     "NAME": {
  6.       "AGG_TYPE": {}
  7.     }
  8.   }
  9. }

If you’re only interested in the aggregation result and not in the results of the query, set size to 0.

In the aggs property (you can use aggregations if you want), you can define any number of aggregations. Each aggregation is defined by its name and one of the types of aggregations that OpenSearch supports.

The name of the aggregation helps you to distinguish between different aggregations in the response. The AGG_TYPE property is where you specify the type of aggregation.

Sample aggregation

This section uses the OpenSearch Dashboards sample ecommerce data and web log data. To add the sample data, log in to OpenSearch Dashboards, choose Home, and then choose Try our sample data. For Sample eCommerce orders and Sample web logs, choose Add data.

avg

To find the average value of the taxful_total_price field:

  1. GET opensearch_dashboards_sample_data_ecommerce/_search
  2. {
  3.   "size": 0,
  4.   "aggs": {
  5.     "avg_taxful_total_price": {
  6.       "avg": {
  7.         "field": "taxful_total_price"
  8.       }
  9.     }
  10.   }
  11. }

Sample response

  1. {
  2.   "took" : 1,
  3.   "timed_out" : false,
  4.   "_shards" : {
  5.     "total" : 1,
  6.     "successful" : 1,
  7.     "skipped" : 0,
  8.     "failed" : 0
  9.   },
  10.   "hits" : {
  11.     "total" : {
  12.       "value" : 4675,
  13.       "relation" : "eq"
  14.     },
  15.     "max_score" : null,
  16.     "hits" : [ ]
  17.   },
  18.   "aggregations" : {
  19.     "avg_taxful_total_price" : {
  20.       "value" : 75.05542864304813
  21.     }
  22.   }
  23. }

The aggregation block in the response shows the average value for the taxful_total_price field.

Types of aggregations

There are three main types of aggregations:

  • Metric aggregations - Calculate metrics such as sum, min, max, and avg on numeric fields.
  • Bucket aggregations - Sort query results into groups based on some criteria.
  • Pipeline aggregations - Pipe the output of one aggregation as an input to another.

Nested aggregations

Aggregations within aggregations are called nested or subaggregations.

Metric aggregations produce simple results and can’t contain nested aggregations.

Bucket aggregations produce buckets of documents that you can nest in other aggregations. You can perform complex analysis on your data by nesting metric and bucket aggregations within bucket aggregations.

General nested aggregation syntax

  1. {
  2.   "aggs": {
  3.     "name": {
  4.       "type": {
  5.         "data"
  6.       },
  7.       "aggs": {
  8.         "nested": {
  9.           "type": {
  10.             "data"
  11.           }
  12.         }
  13.       }
  14.     }
  15.   }
  16. }

The inner aggs keyword begins a new nested aggregation. The syntax of the parent aggregation and the nested aggregation is the same. Nested aggregations run in the context of the preceding parent aggregations.

You can also pair your aggregations with search queries to narrow down things you’re trying to analyze before aggregating. If you don’t add a query, OpenSearch implicitly uses the match_all query.

Table of contents