avgif

This page explains how to use the avgif aggregation function in APL.

The avgif aggregation function in APL allows you to calculate the average value of a field, but only for records that satisfy a given condition. This function is particularly useful when you need to perform a filtered aggregation, such as finding the average response time for requests that returned a specific status code or filtering by geographic regions. The avgif function is highly valuable in scenarios like log analysis, performance monitoring, and anomaly detection, where focusing on subsets of data can provide more accurate insights.

For users of other query languages

If you come from other query languages, this section explains how to adjust your existing queries to achieve the same results in APL.

Splunk SPL users

In Splunk, you achieve similar functionality using the combination of a stats function with conditional filtering. In APL, avgif provides this filtering inline as part of the aggregation function, which can simplify your queries.

Splunk example

| stats avg(req_duration_ms) by id where status = "200"

ANSI SQL users

In ANSI SQL, you can use a CASE statement inside an AVG function to achieve similar behavior. APL simplifies this with avgif, allowing you to specify the condition directly.

SQL example

SELECT id, AVG(CASE WHEN status = '200' THEN req_duration_ms ELSE NULL END) 
FROM sample_http_logs 
GROUP BY id

Usage

Syntax

summarize avgif(expr, predicate) by grouping_field

Parameters

• expr: The field for which you want to calculate the average.
• predicate: A boolean condition that filters which records are included in the calculation.
• grouping_field: (Optional) A field by which you want to group the results.

Returns

The function returns the average of the values from the expr field for the records that satisfy the predicate. If no records match the condition, the result is null.

Use case examples

Log analysis

In this example, you calculate the average request duration for HTTP status 200 in different cities.

Query

['sample-http-logs'] 
| summarize avgif(req_duration_ms, status == "200") by ['geo.city']

Run in Playground

Output

geo.city	avg_req_duration_ms
New York	325
London	400
Tokyo	275

This query calculates the average request duration (req_duration_ms) for HTTP requests that returned a status of 200 (status == "200"), grouped by the city where the request originated (geo.city).

List of related aggregations

• minif: Returns the minimum value of an expression, filtered by a predicate. Use when you want to find the smallest value for a subset of data.
• maxif: Returns the maximum value of an expression, filtered by a predicate. Use when you are looking for the largest value within specific conditions.
• countif: Counts the number of records that match a condition. Use when you want to know how many records meet a specific criterion.
• sumif: Sums the values of a field that match a given condition. Ideal for calculating the total of a subset of data.