Pipeline aggregations on INFINI Pizza

Avg bucket aggregation

Mon, 01 Jan 0001 00:00:00 +0000

Avg bucket aggregation #

A sibling pipeline aggregation computing the average of a metric across another aggregation’s buckets.

"avg_day": { "avg_bucket": { "buckets_path": "per_day>revenue" } }

Example #

Average daily revenue across the date-histogram buckets:

Parameters for `avg_bucket` #

buckets_path
(Required, string) Path to the consumed metric: "<bucket_agg>><metric>".
format
(Optional, string) Output number format.
gap_policy
(Optional, string) What to do with missing buckets: skip (default) or insert_zeros.

Sum bucket aggregation

Mon, 01 Jan 0001 00:00:00 +0000

Sum bucket aggregation #

A sibling pipeline aggregation computing the sum of a metric across another aggregation’s buckets — e.g. “total of the daily totals”.

The result equals the plain sum over all documents (6750).

Min bucket aggregation

Mon, 01 Jan 0001 00:00:00 +0000

Min bucket aggregation #

A sibling pipeline aggregation identifying the smallest per-bucket metric value.

Parameters for `min_bucket` #

buckets_path
(Required, string) Path to the consumed metric.
format
(Optional, string) Output number format.
gap_policy
(Optional, string) skip (default) or insert_zeros.

Max bucket aggregation

Mon, 01 Jan 0001 00:00:00 +0000

Max bucket aggregation #

A sibling pipeline aggregation identifying the largest per-bucket metric value — e.g. the best-performing group.

Parameters for `max_bucket` #

buckets_path
(Required, string) Path to the consumed metric.
format
(Optional, string) Output number format.
gap_policy
(Optional, string) skip (default) or insert_zeros.

Stats bucket aggregation

Mon, 01 Jan 0001 00:00:00 +0000

Stats bucket aggregation #

A sibling pipeline aggregation returning count/min/max/avg/sum of a metric across buckets — the stats of the per-bucket values.

Parameters for `stats_bucket` #

buckets_path
(Required, string) Path to the consumed metric.
format
(Optional, string) Output number format.
gap_policy
(Optional, string) skip (default) or insert_zeros.

Extended stats bucket aggregation

Mon, 01 Jan 0001 00:00:00 +0000

Extended stats bucket aggregation #

A sibling pipeline aggregation extending stats_bucket with variance, standard deviation and bounds of the per-bucket metric distribution.

Parameters for `extended_stats_bucket` #

buckets_path
(Required, string) Path to the consumed metric.
format
(Optional, string) Output number format.
gap_policy
(Optional, string) skip (default) or insert_zeros.
sigma
(Optional, float, default: 2) Multiplier for the std-deviation bounds.

Percentiles bucket aggregation

Mon, 01 Jan 0001 00:00:00 +0000

Percentiles bucket aggregation #

A sibling pipeline aggregation computing percentiles of a metric across buckets — e.g. “the daily-revenue p95”.

Parameters for `percentiles_bucket` #

buckets_path
(Required, string) Path to the consumed metric.
percents
(Optional, number array) Percentiles to compute; defaults to [1, 5, 25, 50, 75, 95, 99].
format
(Optional, string) Output number format.
gap_policy
(Optional, string) skip (default) or insert_zeros.

Derivative aggregation

Mon, 01 Jan 0001 00:00:00 +0000

Derivative aggregation #

A parent pipeline aggregation computing the difference between each bucket’s metric and the previous bucket’s — “how much did it change”. The first bucket has no predecessor and answers null.

Parameters for `derivative` #

buckets_path
(Required, string) Path to the consumed metric in the SAME bucket ("revenue").
gap_policy
(Optional, string) skip (default) or insert_zeros.
format
(Optional, string) Output number format.
unit
(Optional, string) For date_histogram parents: report the derivative per time unit (e.g. "day").

Cumulative sum aggregation

Mon, 01 Jan 0001 00:00:00 +0000

Cumulative sum aggregation #

A parent pipeline aggregation adding a running total column to each bucket — the metric plus every earlier bucket’s.

The final bucket’s running equals the plain total (6750).

Cumulative cardinality aggregation

Mon, 01 Jan 0001 00:00:00 +0000

Cumulative cardinality aggregation #

A parent pipeline aggregation reporting a running count of NEW distinct values — how many unique values have been seen up to and including each bucket.

Parameters for `cumulative_cardinality` #

buckets_path
(Required, string) Path to a cardinality metric in the same bucket.
format
(Optional, string) Output number format.

Serial diff aggregation

Mon, 01 Jan 0001 00:00:00 +0000

Serial diff aggregation #

A parent pipeline aggregation computing the difference between each bucket’s metric and the bucket lag positions back — a differencing transform for trend analysis.

Parameters for `serial_diff` #

buckets_path
(Required, string) Path to the consumed metric in the same bucket.
lag
(Optional, integer, default: 1) How many buckets back to compare.
gap_policy
(Optional, string) skip (default) or insert_zeros.
format
(Optional, string) Output number format.

Moving fn aggregation

Mon, 01 Jan 0001 00:00:00 +0000

Moving fn aggregation #

A parent pipeline aggregation computing a window statistic over the last N buckets’ metrics — MovingFunctions.max(values), MovingFunctions.sum(values), MovingFunctions.min(values) and friends, with the window sliding bucket by bucket.

moving_avg is the same aggregation with a fixed averaging script.

Moving avg aggregation

Mon, 01 Jan 0001 00:00:00 +0000

Moving avg aggregation #

A parent pipeline aggregation smoothing a metric with a moving average over the last N buckets — moving_fn with a fixed averaging script.

Parameters for `moving_avg` #

buckets_path
(Required, string) Path to the consumed metric in the same bucket.
window
(Required, integer) Number of buckets in the sliding window.
model
(Optional, string) Averaging model; the engine evaluates a simple mean.
gap_policy
(Optional, string) skip (default) or insert_zeros.

Bucket script aggregation

Mon, 01 Jan 0001 00:00:00 +0000

Bucket script aggregation #

A parent pipeline aggregation computing arithmetic on a bucket’s own metrics — the script references sibling metrics by name through params and its result becomes a new per-bucket value.

Parameters for `bucket_script` #

buckets_path
(Required, object) Map of script variable names to sibling metric paths ({ "r": "revenue" }).
script
(Required, string) Expression over params.<name>.
format
(Optional, string) Output number format.
gap_policy
(Optional, string) skip (default) or insert_zeros.

Bucket selector aggregation

Mon, 01 Jan 0001 00:00:00 +0000

Bucket selector aggregation #

A parent pipeline aggregation filtering the bucket list itself: a script predicate per bucket — buckets whose script evaluates false are dropped from the response.

Parameters for `bucket_selector` #

buckets_path
(Required, object) Map of script variable names to sibling metric paths.
script
(Required, string) Keep predicate over params.<name>.
gap_policy
(Optional, string) skip (default) or insert_zeros.

Bucket sort aggregation

Mon, 01 Jan 0001 00:00:00 +0000

Bucket sort aggregation #

A parent pipeline aggregation sorting (and paginating) the bucket list by any of the bucket’s metrics — the pipeline counterpart of the request-level sort.

Parameters for `bucket_sort` #

sort
(Optional, array) Sort clauses over the bucket’s metrics ([{ "revenue": { "order": "desc" } }]).
from
(Optional, integer) Skip this many buckets — pagination offset.
size
(Optional, integer) Keep at most this many buckets.
gap_policy
(Optional, string) skip (default) or insert_zeros.

Normalize aggregation

Mon, 01 Jan 0001 00:00:00 +0000

Normalize aggregation #

A parent pipeline aggregation rescaling a bucket metric into a share or rank — e.g. each bucket’s revenue as a percent of the total (percent_of_sum).

Parameters for `normalize` #

buckets_path
(Required, string) Path to the consumed metric in the same bucket.
method
(Required, string) Rescale method: percent_of_sum, rescale_0_1, mean, z-score, softmax.
format
(Optional, string) Output number format.

Pipeline aggregations on INFINI Pizza

Avg bucket aggregation

Avg bucket aggregation #

Example #

Parameters for avg_bucket #

Sum bucket aggregation

Sum bucket aggregation #

Min bucket aggregation

Min bucket aggregation #

Parameters for min_bucket #

Max bucket aggregation

Max bucket aggregation #

Parameters for max_bucket #

Stats bucket aggregation

Stats bucket aggregation #

Parameters for stats_bucket #

Extended stats bucket aggregation

Extended stats bucket aggregation #

Parameters for extended_stats_bucket #

Percentiles bucket aggregation

Percentiles bucket aggregation #

Parameters for percentiles_bucket #

Derivative aggregation

Derivative aggregation #

Parameters for derivative #

Cumulative sum aggregation

Cumulative sum aggregation #

Cumulative cardinality aggregation

Cumulative cardinality aggregation #

Parameters for cumulative_cardinality #

Serial diff aggregation

Serial diff aggregation #

Parameters for serial_diff #

Moving fn aggregation

Moving fn aggregation #

Moving avg aggregation

Moving avg aggregation #

Parameters for moving_avg #

Bucket script aggregation

Bucket script aggregation #

Parameters for bucket_script #

Bucket selector aggregation

Bucket selector aggregation #

Parameters for bucket_selector #

Bucket sort aggregation

Bucket sort aggregation #

Parameters for bucket_sort #

Normalize aggregation

Normalize aggregation #

Parameters for normalize #

Parameters for `avg_bucket` #

Parameters for `min_bucket` #

Parameters for `max_bucket` #

Parameters for `stats_bucket` #

Parameters for `extended_stats_bucket` #

Parameters for `percentiles_bucket` #

Parameters for `derivative` #

Parameters for `cumulative_cardinality` #

Parameters for `serial_diff` #

Parameters for `moving_avg` #

Parameters for `bucket_script` #

Parameters for `bucket_selector` #

Parameters for `bucket_sort` #

Parameters for `normalize` #