Skip to content

Commit 9cab91b

Browse files
authored
DOCS-653 - Add rate to quantize articles (#4998)
1 parent d45fca3 commit 9cab91b

File tree

2 files changed

+12
-30
lines changed

2 files changed

+12
-30
lines changed

docs/metrics/introduction/metric-quantization.md

Lines changed: 10 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
99

1010
Sumo ingests individual metric data points from your metric sources. In metric visualizations, rather than charting individual data points, Sumo presents the aggregated value of the data points received during an interval.
1111

12-
Quantization is the process of aggregating metric data points for time series over an interval, for example, an hour or a minute, using a particular aggregation function: `avg`, `min`, `max`, `sum`, or `count`.
12+
Quantization is the process of aggregating metric data points for time series over an interval, for example, an hour or a minute, using a particular aggregation function: `avg`, `min`, `max`, `sum`, `count`, or `rate`.
1313

1414

1515
### Quantization terminology
@@ -38,38 +38,20 @@ By default, Sumo uses the `avg` rollup type. You can specify another rollup type
3838

3939
We use the term rollup to refer to the aggregation function Sumo uses when quantizing metrics. This table describes the different rollup types you can select when running a query.
4040

41-
<table>
42-
<tr>
43-
<td><strong>Rollup type</strong> </td>
44-
<td><strong>Description</strong> </td>
45-
</tr>
46-
<tr>
47-
<td><code>avg</code> </td>
48-
<td>Calculates the average value of the data points for a time series in each bucket. </td>
49-
</tr>
50-
<tr>
51-
<td><code>min</code> </td>
52-
<td>Calculates the minimum value among the data points for a time series in each bucket. </td>
53-
</tr>
54-
<tr>
55-
<td><code>max</code> </td>
56-
<td>Calculates the maximum value among the data points for a time series in each bucket. </td>
57-
</tr>
58-
<tr>
59-
<td><code>sum</code></td>
60-
<td>Calculates the sum of the values of the data points for a time series in each bucket. </td>
61-
</tr>
62-
<tr>
63-
<td><code>count</code></td>
64-
<td>Calculates the count of data points for a time series in each bucket. </td>
65-
</tr>
66-
</table>
41+
| Rollup type | Description |
42+
| :-- | :-- |
43+
| [`avg`](/docs/metrics/metrics-operators/avg/) | Calculates the average value of the data points for a time series in each bucket. |
44+
| [`min`](/docs/metrics/metrics-operators/min/) | Calculates the minimum value among the data points for a time series in each bucket. |
45+
| [`max`](/docs/metrics/metrics-operators/max/) | Calculates the maximum value among the data points for a time series in each bucket. |
46+
| [`sum`](/docs/metrics/metrics-operators/sum/) | Calculates the sum of the values of the data points for a time series in each bucket. |
47+
| [`count`](/docs/metrics/metrics-operators/count/) | Calculates the count of data points for a time series in each bucket. |
48+
| [`rate`](/docs/metrics/metrics-operators/rate/) | Calculates the per-second rate of change between data points in a time series in each bucket. |
6749

6850
Sumo quantizes metrics upon ingestion and at query time.
6951

7052
### Quantization at ingestion
7153

72-
Upon ingestion, Sumo quantizes raw metric data points to one hour resolutions for all rollup types: `avg`, `min`, `max`, `sum`, and `count`. This data is stored in one hour rollup tables in Sumo. The raw data is stored in a table referred to as the baseline table. For information about retention times, see [Metric Ingestion and Storage](/docs/metrics/manage-metric-volume/metric-ingestion-and-storage.md).
54+
Upon ingestion, Sumo quantizes raw metric data points to one hour resolutions for all rollup types: `avg`, `min`, `max`, `sum`, `count`, and `rate`. This data is stored in one hour rollup tables in Sumo. The raw data is stored in a table referred to as the baseline table. For information about retention times, see [Metric Ingestion and Storage](/docs/metrics/manage-metric-volume/metric-ingestion-and-storage.md).
7355

7456
### Automatic quantization at query time
7557

docs/metrics/metrics-operators/quantize.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ You can use the `quantize` operator to control the Sumo’s quantization behavio
99
You can specify:
1010

1111
* The size of the time buckets across which Sumo aggregates your metrics. If you do not specify a quantization interval, Sumo determines an optimum size for time buckets, as described in [Automatic quantization at query time](../introduction/metric-quantization.md).  
12-
* The rollup type that Sumo uses to aggregate the individual data points in a time bucket, which can be one of `avg, min, max, sum,` or `count`. If you do not specify a rollup type in the `quantize` clause of your query, for each time bucket, Sumo presents the average of the data points in that bucket.  
12+
* The rollup type that Sumo uses to aggregate the individual data points in a time bucket, which can be one of `avg`, `min`, `max`, `sum`, `count`, or `rate`. If you do not specify a rollup type in the `quantize` clause of your query, for each time bucket, Sumo presents the average of the data points in that bucket.  
1313

1414
## Syntax
1515

@@ -20,7 +20,7 @@ quantize [to INTERVAL] [using ROLLUP] [drop last]
2020
where:
2121

2222
* `INTERVAL` is the duration over which you want to quantize the metrics, in seconds (`s`), minutes (`m`), hours (`h`), or days (`d`).
23-
* `ROLLUP` is  `avg, min, max, sum`, or `count`.
23+
* `ROLLUP` is  `avg`, `min`, `max`, `sum`, `count`, or `rate`.
2424
* `drop last` causes the last time bucket to be dropped, if the end of that bucket is after the end of the query time range.
2525
* At least one of the `to INTERVAL` or `using ROLLUP` clauses needs to be present.
2626

0 commit comments

Comments
 (0)