13 KiB

Raw Blame History

layout	title
doc_page	Aggregations

Aggregations

Aggregations can be provided at ingestion time as part of the ingestion spec as a way of summarizing data before it enters Druid. Aggregations can also be specified as part of many queries at query time.

Available aggregations are:

Count aggregator

count computes the count of Druid rows that match the filters.

{ "type" : "count", "name" : <output_name> }

Please note the count aggregator counts the number of Druid rows, which does not always reflect the number of raw events ingested. This is because Druid can be configured to roll up data at ingestion time. To count the number of ingested rows of data, include a count aggregator at ingestion time, and a longSum aggregator at query time.

Sum aggregators

`longSum` aggregator

computes the sum of values as a 64-bit, signed integer

{ "type" : "longSum", "name" : <output_name>, "fieldName" : <metric_name> }

name – output name for the summed value fieldName – name of the metric column to sum over

`doubleSum` aggregator

Computes and stores the sum of values as 64-bit floating point value. Similar to longSum

{ "type" : "doubleSum", "name" : <output_name>, "fieldName" : <metric_name> }

`floatSum` aggregator

Computes and stores the sum of values as 32-bit floating point value. Similar to longSum and doubleSum

{ "type" : "floatSum", "name" : <output_name>, "fieldName" : <metric_name> }

Min / Max aggregators

`doubleMin` aggregator

doubleMin computes the minimum of all metric values and Double.POSITIVE_INFINITY

{ "type" : "doubleMin", "name" : <output_name>, "fieldName" : <metric_name> }

`doubleMax` aggregator

doubleMax computes the maximum of all metric values and Double.NEGATIVE_INFINITY

{ "type" : "doubleMax", "name" : <output_name>, "fieldName" : <metric_name> }

`floatMin` aggregator

floatMin computes the minimum of all metric values and Float.POSITIVE_INFINITY

{ "type" : "floatMin", "name" : <output_name>, "fieldName" : <metric_name> }

`floatMax` aggregator

floatMax computes the maximum of all metric values and Float.NEGATIVE_INFINITY

{ "type" : "floatMax", "name" : <output_name>, "fieldName" : <metric_name> }

`longMin` aggregator

longMin computes the minimum of all metric values and Long.MAX_VALUE

{ "type" : "longMin", "name" : <output_name>, "fieldName" : <metric_name> }

`longMax` aggregator

longMax computes the maximum of all metric values and Long.MIN_VALUE

{ "type" : "longMax", "name" : <output_name>, "fieldName" : <metric_name> }

First / Last aggregator

(Double/Float/Long) First and Last aggregator cannot be used in ingestion spec, and should only be specified as part of queries.

Note that queries with first/last aggregators on a segment created with rollup enabled will return the rolled up value, and not the last value within the raw ingested data.

`doubleFirst` aggregator

doubleFirst computes the metric value with the minimum timestamp or 0 if no row exist

{
  "type" : "doubleFirst",
  "name" : <output_name>,
  "fieldName" : <metric_name>
}

`doubleLast` aggregator

doubleLast computes the metric value with the maximum timestamp or 0 if no row exist

{
  "type" : "doubleLast",
  "name" : <output_name>,
  "fieldName" : <metric_name>
}

`floatFirst` aggregator

floatFirst computes the metric value with the minimum timestamp or 0 if no row exist

{
  "type" : "floatFirst",
  "name" : <output_name>,
  "fieldName" : <metric_name>
}

`floatLast` aggregator

floatLast computes the metric value with the maximum timestamp or 0 if no row exist

{
  "type" : "floatLast",
  "name" : <output_name>,
  "fieldName" : <metric_name>
}

`longFirst` aggregator

longFirst computes the metric value with the minimum timestamp or 0 if no row exist

{
  "type" : "longFirst",
  "name" : <output_name>,
  "fieldName" : <metric_name>
}

`longLast` aggregator

longLast computes the metric value with the maximum timestamp or 0 if no row exist

{ 
  "type" : "longLast",
  "name" : <output_name>, 
  "fieldName" : <metric_name>,
}

`stringFirst` aggregator

stringFirst computes the metric value with the minimum timestamp or null if no row exist

{
  "type" : "stringFirst",
  "name" : <output_name>,
  "fieldName" : <metric_name>,
  "maxStringBytes" : <integer> # (optional, defaults to 1024),
  "filterNullValues" : <boolean> # (optional, defaults to false)
}

`stringLast` aggregator

stringLast computes the metric value with the maximum timestamp or null if no row exist

{
  "type" : "stringLast",
  "name" : <output_name>,
  "fieldName" : <metric_name>,
  "maxStringBytes" : <integer> # (optional, defaults to 1024),
  "filterNullValues" : <boolean> # (optional, defaults to false)
}

JavaScript aggregator

Computes an arbitrary JavaScript function over a set of columns (both metrics and dimensions are allowed). Your JavaScript functions are expected to return floating-point values.

{ "type": "javascript",
  "name": "<output_name>",
  "fieldNames"  : [ <column1>, <column2>, ... ],
  "fnAggregate" : "function(current, column1, column2, ...) {
                     <updates partial aggregate (current) based on the current row values>
                     return <updated partial aggregate>
                   }",
  "fnCombine"   : "function(partialA, partialB) { return <combined partial results>; }",
  "fnReset"     : "function()                   { return <initial value>; }"
}

Example

{
  "type": "javascript",
  "name": "sum(log(x)*y) + 10",
  "fieldNames": ["x", "y"],
  "fnAggregate" : "function(current, a, b)      { return current + (Math.log(a) * b); }",
  "fnCombine"   : "function(partialA, partialB) { return partialA + partialB; }",
  "fnReset"     : "function()                   { return 10; }"
}

JavaScript-based functionality is disabled by default. Please refer to the Druid JavaScript programming guide for guidelines about using Druid's JavaScript functionality, including instructions on how to enable it.

## Approximate Aggregations

Count distinct

DataSketches Theta Sketch

The DataSketches Theta Sketch extension-provided aggregator gives distinct count estimates with support for set union, intersection, and difference post-aggregators, using Theta sketches from the datasketches library.

DataSketches HLL Sketch

The DataSketches HLL Sketch extension-provided aggregator gives distinct count estimates using the HyperLogLog algorithm. The HLL Sketch is faster and requires less storage than the Theta Sketch, but does not support intersection or difference operations.

Cardinality/HyperUnique (Deprecated)

The Cardinality and HyperUnique aggregators are deprecated. Please use DataSketches HLL Sketch instead.

The Cardinality and HyperUnique aggregators are older aggregator implementations available by default in Druid that also provide distinct count estimates using the HyperLogLog algorithm. The newer DataSketches HLL Sketch extension-provided aggregator has superior accuracy and performance and is recommended instead.

The DataSketches team has published a comparison study between Druid's original HLL algorithm and the DataSketches HLL algorithm. Based on the demonstrated advantages of the DataSketches implementation, we have deprecated Druid's original HLL aggregator.

Please note that DataSketches HLL aggregators and hyperUnique aggregators are not mutually compatible.

Histograms and quantiles

DataSketches Quantiles Sketch

The DataSketches Quantiles Sketch extension-provided aggregator provides quantile estimates and histogram approximations using the numeric quantiles DoublesSketch from the datasketches library.

We recommend this aggregator in general for quantiles/histogram use cases, as it provides formal error bounds and has distribution-independent accuracy.

Moments Sketch (Experimental)

The Moments Sketch extension-provided aggregator is an experimental aggregator that provides quantile estimates using the Moments Sketch.

The Moments Sketch aggregator is provided as an experimental option. It is optimized for merging speed and it can have higher aggregation performance compared to the DataSketches quantiles aggregator. However, the accuracy of the Moments Sketch is distribution-dependent, so users will need to empirically verify that the aggregator is suitable for their input data.

As a general guideline for experimentation, the Moments Sketch paper points out that this algorithm works better on inputs with high entropy. In particular, the algorithm is not a good fit when the input data consists of a small number of clustered discrete values.

Fixed Buckets Histogram

Druid also provides a [simple histogram implementation]((../development/extensions-core/approxiate-histograms.html#fixed-buckets-histogram) that uses a fixed range and fixed number of buckets with support for quantile estimation, backed by an array of bucket count values.

The fixed buckets histogram can perform well when the distribution of the input data allows a small number of buckets to be used.

We do not recommend the fixed buckets histogram for general use, as its usefulness is extremely data dependent. However, it is made available for users that have already identified use cases where a fixed buckets histogram is suitable.

Approximate Histogram (Deprecated)

The Approximate Histogram extension-provided aggregator also provides quantile estimates and histogram approximations, based on http://jmlr.org/papers/volume11/ben-haim10a/ben-haim10a.pdf.

The algorithm used by this deprecated aggregator is highly distribution-dependent and its output is subject to serious distortions when the input does not fit within the algorithm's limitations.

A study published by the DataSketches team demonstrates some of the known failure modes of this algorithm:

The algorithm's quantile calculations can fail to provide results for a large range of rank values (all ranks less than 0.89 in the example used in the study), returning all zeroes instead.
The algorithm can completely fail to record spikes in the tail ends of the distribution
In general, the histogram produced by the algorithm can deviate significantly from the true histogram, with no bounds on the errors.

It is not possible to determine a priori how well this aggregator will behave for a given input stream, nor does the aggregator provide any indication that serious distortions are present in the output.

For these reasons, we have deprecated this aggregator and do not recommend its use.

Miscellaneous Aggregations

Filtered Aggregator

A filtered aggregator wraps any given aggregator, but only aggregates the values for which the given dimension filter matches.

This makes it possible to compute the results of a filtered and an unfiltered aggregation simultaneously, without having to issue multiple queries, and use both results as part of post-aggregations.

Note: If only the filtered results are required, consider putting the filter on the query itself, which will be much faster since it does not require scanning all the data.

{
  "type" : "filtered",
  "filter" : {
    "type" : "selector",
    "dimension" : <dimension>,
    "value" : <dimension value>
  }
  "aggregator" : <aggregation>
}

13 KiB Raw Blame History Unescape Escape

Aggregations

Count aggregator

Sum aggregators

longSum aggregator

doubleSum aggregator

floatSum aggregator

Min / Max aggregators

doubleMin aggregator

doubleMax aggregator

floatMin aggregator

floatMax aggregator

longMin aggregator

longMax aggregator