Skip to content
This repository was archived by the owner on Aug 23, 2023. It is now read-only.

Commit f333637

Browse files
authored
Merge pull request #1620 from grafana/cleanup-render-docs
Cleanup render docs
2 parents 02376a7 + 6535edb commit f333637

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/render-path docs/render-path.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22

33
## quantized form
44

5-
a raw is quantized when the timestamps are adjusted to be regular.
5+
a raw series is quantized when the timestamps are adjusted to be regular (at fixed intervals).
6+
Note that some points may be null (have no data), but they should be included.
67
E.g. an input stream that has:
78
* an interval of 10
89
* points with timestamps 58, 67, 75, 95
910

10-
is quantized to a series with points with timestamps 60, 70, 80, 90 (this one has no data), 100.
11+
is quantized to a series with points with timestamps 60, 70, 80, 90 (null), 100.
1112

1213
## fixed form
1314

1415
a series is fixed, with respect to a query with from/to time, when
1516
* it is quantized.
16-
* contains a point for each interval (possibly null).
17-
* contains only timestamps such that `from <= timestams < to`.
17+
* contains only timestamps such that `from <= timestamps < to`.
1818

1919
## canonical form
2020

@@ -25,7 +25,7 @@ with respect to how many points it contains and which timestamps they have.
2525
It is important here to keep in mind that consolidated points get the timestamp of the last of its input points.
2626

2727
Continuing the above example, if we need to normalize the above series with aggNum 3 (OutInterval is 30s)
28-
We would normally get a series of (60,70,80), (90, 100, 110 - this one has no data), so 80, 110.
28+
we would normally get a series of (60,70,80), (90, 100, 110 - null), so the 30-second timestamps become 80 and 110.
2929
But this is not the quantized form of a series with an interval of 30.
3030

3131
So, what typically happens to make a series canonical, is at fetch time, also fetch some extra earlier data.
@@ -58,6 +58,7 @@ I.O.W. is a series that is fetched in such a way that when it is fed to Consolid
5858
See above for more details.
5959

6060
## nudging
61+
6162
in graphite, nudging happens when doing MDP-based consolidation:
6263
after determining the post-consolidation interval (here referred to as postInterval)
6364
it removes a few points from the beginning of the series (if needed),
@@ -66,18 +67,18 @@ such that:
6667
(i.o.w. the first point in the series is the first point for an aggregation bucket)
6768
* across different requests, where points arrive on the right and leave the window on the left,
6869
the same timestamps are always aggregated together, and the timestamp is always consistent
69-
and diviseble by the postInterval.
70+
and divisible by the postInterval.
7071

7172

7273

7374
In metrictank we do the same, via nudge(), invoked when doing MDP-based consolidation.
74-
Except, when we have only few points, strict applicating of nudging may result in confusing,
75+
Except, when we have only few points, strict application of nudging may result in confusing,
7576
strongly altered results. We only nudge when we have points > 2 * postAggInterval's worth.
7677
This means that in cases of few points and a low MDP value, where we don't nudge,
7778
we do not provide the above 2 guarantees, but a more useful result.
7879

7980

80-
## normalizing
81+
## normalization
8182

8283
given multiple series being fetched of different resolution, normalizing is runtime consolidation
8384
but only for the purpose of bringing series of different resolutions to a common, lower resolution

0 commit comments

Comments
 (0)