moment() Query Function

EXPERIMENTAL. Calculates percentiles over numbers. Returns one event with a field for each of the percentiles specified in the percentiles parameter. Fields are named like by appending _ (underscore) to the values specified in the percentiles parameter. For example the event could contain the fields _50, _75 and _99. Input can be a number OR the special format for the moment sketch “[min,max,Σv⁰,Σv¹,Σ,²,...]” used for client-side computed sketches.

Parameters

Name

Type

Required

Default

Description

field

string

Yes

Specifies the field for which to calculate percentiles. The field must contain numbers.

k

number

No

5

Specifies the order of the underlying polynomial.

percentiles

number

No

[50, 75, 99]

Specifies which percentiles to calculate.

as

string

No

Prefix of output fields.

The implied parameter is field.

Examples

Calculate 50 75 99 and 99.9 percentiles for events with the field responsetime.

humio
percentile(field=responsetime, percentiles=[50, 75, 99, 99.9])

In a timechart, calculate percentiles for both of the fields r1 and r2.

humio
timechart(function=[percentile(field=r1,as=r1),percentile(field=r2,as=r2)])