Skip to content

Commit 9ddec25

Browse files
tothmanoRambatino
andauthored
Add disclaimer to statistical functions (#183)
Co-authored-by: Mark Ramotowski <[email protected]>
1 parent 9837234 commit 9ddec25

File tree

4 files changed

+13
-1
lines changed

4 files changed

+13
-1
lines changed

apl/aggregation-function/dcount.mdx

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ The `dcount` aggregation function in Axiom Processing Language (APL) counts the
77

88
Use `dcount` for analyzing datasets where it’s important to identify the number of distinct occurrences, such as unique IP addresses in security logs, unique user IDs in application logs, or unique trace IDs in OpenTelemetry traces.
99

10+
<Note>
11+
The `dcount` aggregation in APL is a statistical aggregation that returns estimated results. The estimation comes with the benefit of speed at the expense of accuracy. This means that `dcount` is fast and light on resources even on a large or high-cardinality dataset, but it doesn’t provide precise results.
12+
</Note>
13+
1014
## For users of other query languages
1115

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

apl/aggregation-function/histogram.mdx

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ The `histogram` aggregation in APL allows you to create a histogram that groups
77

88
The `histogram` aggregation is ideal for identifying peaks, valleys, and outliers in your data. For example, you can analyze the distribution of request durations in web server logs or span durations in OpenTelemetry traces to understand performance bottlenecks.
99

10+
<Note>
11+
The `histogram` aggregation in APL is a statistical aggregation that returns estimated results. The estimation comes with the benefit of speed at the expense of accuracy. This means that `histogram` is fast and light on resources even on a large or high-cardinality dataset, but it doesn’t provide precise results.
12+
</Note>
13+
1014
## For users of other query languages
1115

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

apl/aggregation-function/percentile.mdx

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ The `percentile` aggregation function in Axiom Processing Language (APL) allows
77

88
You can apply the `percentile` function to various use cases, such as analyzing log data for request durations, OpenTelemetry traces for service latencies, or security logs to assess risk patterns.
99

10+
<Note>
11+
The `percentile` aggregation in APL is a statistical aggregation that returns estimated results. The estimation comes with the benefit of speed at the expense of accuracy. This means that `percentile` is fast and light on resources even on a large or high-cardinality dataset, but it doesn’t provide precise results.
12+
</Note>
13+
1014
## For users of other query languages
1115

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

apl/aggregation-function/topk.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The `topk` aggregation in Axiom Processing Language (APL) allows you to identify
88
Use `topk` to find the most common or relevant entries in datasets, especially in log analysis, telemetry data, and monitoring systems. This aggregation helps you focus on the most important data points, filtering out the noise.
99

1010
<Note>
11-
The `topk` aggregation in APL is estimated. The estimation comes with the benefit of speed at the expense of accuracy. This means that `topk` is fast and light on resources even on a large or high-cardinality dataset, but it doesn’t provide the most accurate results.
11+
The `topk` aggregation in APL is a statistical aggregation that returns estimated results. The estimation comes with the benefit of speed at the expense of accuracy. This means that `topk` is fast and light on resources even on a large or high-cardinality dataset, but it doesn’t provide precise results.
1212

1313
For completely accurate results, use the [`top` operator](/apl/tabular-operators/top-operator).
1414
</Note>

0 commit comments

Comments
 (0)