Calls the named function on a field over a set of events. The result is returned in a field named _function for the selected function. This allows having the function name as a dashboard parameter.
Function Traits: Aggregate
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
as | string | optional | _function | Name of output field. |
field | string | required | Field to extract a number from and calculate function over. | |
function [a] | string | required | Function to run. | |
Valid Values | avg | The avg() function | ||
count | The count() function | |||
max | The max() function | |||
min | The min() function | |||
range | The range() function | |||
sum | The sum() function | |||
The parameter name for function
can be omitted; the following forms are equivalent:
logscale
callFunction("avg")
and:
logscale
callFunction(function="avg")
callFunction()
Examples
Find the average bytes sent in http responses using callFunction() rather than using avg directly.
logscale
avg_sent:=callFunction("avg", field=bytes_sent)
Use a query parameter (i.e., ?function
)
to select the aggregation function for a
timeChart()
. This is useful for dashboard widgets.
logscale
timechart(function=[callFunction(?{function=count}, field=value)])