Get rollup job capabilities API

Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.

This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

Request

GET _rollup/data/<index>

Prerequisites

  • If the Elasticsearch security features are enabled, you must have monitor, monitor_rollup, manage or manage_rollup cluster privileges to use this API. For more information, see Security privileges.

Description

This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration.

This API enables you to inspect an index and determine:

  1. Does this index have associated rollup data somewhere in the cluster?
  2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live?

Path parameters

<index>

(string) Index, indices or index-pattern to return rollup capabilities for. _all may be used to fetch rollup capabilities from all jobs.

Examples

Imagine we have an index named sensor-1 full of raw data. We know that the data will grow over time, so there will be a sensor-2, sensor-3, etc. Let’s create a rollup job that targets the index pattern sensor-* to accommodate this future scaling:

  1. PUT _rollup/job/sensor
  2. {
  3.   "index_pattern": "sensor-*",
  4.   "rollup_index": "sensor_rollup",
  5.   "cron": "*/30 * * * * ?",
  6.   "page_size": 1000,
  7.   "groups": {
  8.     "date_histogram": {
  9.       "field": "timestamp",
  10.       "fixed_interval": "1h",
  11.       "delay": "7d"
  12.     },
  13.     "terms": {
  14.       "fields": [ "node" ]
  15.     }
  16.   },
  17.   "metrics": [
  18.     {
  19.       "field": "temperature",
  20.       "metrics": [ "min", "max", "sum" ]
  21.     },
  22.     {
  23.       "field": "voltage",
  24.       "metrics": [ "avg" ]
  25.     }
  26.   ]
  27. }

We can then retrieve the rollup capabilities of that index pattern (sensor-*) via the following command:

  1. GET _rollup/data/sensor-*

Which will yield the following response:

  1. {
  2.   "sensor-*" : {
  3.     "rollup_jobs" : [
  4.       {
  5.         "job_id" : "sensor",
  6.         "rollup_index" : "sensor_rollup",
  7.         "index_pattern" : "sensor-*",
  8.         "fields" : {
  9.           "node" : [
  10.             {
  11.               "agg" : "terms"
  12.             }
  13.           ],
  14.           "temperature" : [
  15.             {
  16.               "agg" : "min"
  17.             },
  18.             {
  19.               "agg" : "max"
  20.             },
  21.             {
  22.               "agg" : "sum"
  23.             }
  24.           ],
  25.           "timestamp" : [
  26.             {
  27.               "agg" : "date_histogram",
  28.               "time_zone" : "UTC",
  29.               "fixed_interval" : "1h",
  30.               "delay": "7d"
  31.             }
  32.           ],
  33.           "voltage" : [
  34.             {
  35.               "agg" : "avg"
  36.             }
  37.           ]
  38.         }
  39.       }
  40.     ]
  41.   }
  42. }

The response that is returned contains information that is similar to the original rollup configuration, but formatted differently. First, there are some house-keeping details: the rollup job ID, the index that holds the rolled data, and the index pattern that the job was targeting.

Next it shows a list of fields that contain data eligible for rollup searches. Here we see four fields: node, temperature, timestamp and voltage. Each of these fields list the aggregations that are possible. For example, you can use a min, max or sum aggregation on the temperature field, but only a date_histogram on timestamp.

Note that the rollup_jobs element is an array; there can be multiple, independent jobs configured for a single index or index pattern. Each of these jobs may have different configurations, so the API returns a list of all the various configurations available.

We could also retrieve the same information with a request to _all:

  1. GET _rollup/data/_all

But note that if we use the concrete index name (sensor-1), we’ll retrieve no rollup capabilities:

  1. GET _rollup/data/sensor-1
  1. {
  3. }

Why is this? The original rollup job was configured against a specific index pattern (sensor-*) not a concrete index (sensor-1). So while the index belongs to the pattern, the rollup job is only valid across the entirety of the pattern not just one of it’s containing indices. So for that reason, the get rollup capabilities API only returns information based on the originally configured index name or pattern.