Get rollup job information

  • GET /_rollup/job/{id}
  • GET /_rollup/job
Auth Deprecated

Get the configuration, stats, and status of rollup jobs.

Note

This API returns only active (both STARTED and STOPPED) jobs. If a job was created, ran for a while, then was deleted, the API does not return any details about it. For details about a historical rollup job, the rollup capabilities API may be more useful.

Required authorization

Cluster privileges monitor_rollup

Path parameters

id string optional

Identifier for the rollup job. If it is _all or omitted, the API returns all rollup jobs.

Leave it out to use /_rollup/job.

Response

application/json
jobs object[] required
config object required

The rollup job configuration.

cron string required
groups object required
date_histogram object

A date histogram group aggregates a date field into time-based buckets. This group is mandatory; you currently cannot roll up documents without a timestamp and a date_histogram group.

delay string

How long to wait before rolling up new documents. By default, the indexer attempts to roll up all data that is available. However, it is not uncommon for data to arrive out of order. The indexer is unable to deal with data that arrives after a time-span has been rolled up. You need to specify a delay that matches the longest period of time you expect out-of-order data to arrive.

field string required

The date field that is to be rolled up.

format string
interval string
calendar_interval string

The interval of time buckets to be generated when rolling up.

fixed_interval string

The interval of time buckets to be generated when rolling up.

time_zone string

Defines what time_zone the rollup documents are stored as. Unlike raw data, which can shift timezones on the fly, rolled documents have to be stored with a specific timezone. By default, rollup documents are stored in UTC.

histogram object

The histogram group aggregates one or more numeric fields into numeric histogram intervals.

fields union oneOf required

The set of fields that you wish to build histograms for. All fields specified must be some kind of numeric. Order does not matter.

One of: string[] or string
interval number required

The interval of histogram buckets to be generated when rolling up. For example, a value of 5 creates buckets that are five units wide (0-5, 5-10, etc). Note that only one interval can be specified in the histogram group, meaning that all fields being grouped via the histogram must share the same interval.

terms object

The terms group can be used on keyword or numeric fields to allow bucketing via the terms aggregation at a later point. The indexer enumerates and stores all values of a field for each time-period. This can be potentially costly for high-cardinality groups such as IP addresses, especially if the time-bucket is particularly sparse.

fields union oneOf required

The set of fields that you wish to collect terms for. This array can contain fields that are both keyword and numerics. Order does not matter.

One of: string[] or string
id string required
index_pattern string required
metrics object[] required
field string required

The field to collect metrics for. This must be a numeric of some kind.

metrics enum[] required

An array of metrics to collect for the field. At least one metric must be configured.

Values: min max sum avg value_count
page_size number required
rollup_index string required
timeout string required
stats object required

Transient statistics about the rollup job, such as how many documents have been processed and how many rollup summary docs have been indexed. These stats are not persisted. If a node is restarted, these stats are reset.

documents_processed number required
index_failures number required
index_time_in_ms number required
index_total number required
pages_processed number required
rollups_indexed number required
search_failures number required
search_time_in_ms number required
search_total number required
trigger_count number required
processing_time_in_ms number required
processing_total number required
status object required

The current status of the indexer for the rollup job.

current_position map string to object
job_state enum required
Values: started indexing stopping stopped aborting
upgraded_doc_id boolean