Skip to content

Commit fd50ced

Browse files
committed
native histogram spec: update NHCB TODOs
Signed-off-by: beorn7 <[email protected]>
1 parent 7a9b216 commit fd50ced

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

content/docs/specs/native_histograms.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -318,9 +318,7 @@ the exponential bucketing featured by the standard schemas is a bad match for
318318
the distribution to be represented by the histogram. Histograms with different
319319
custom bucket boundaries are generally not mergeable with each other.
320320
Therefore, schema -53 SHOULD only be used as an informed decision in specific
321-
use cases. (TODO: NHCB aren't fully merged into main as of now (2024-11-03).
322-
They are worked into this document as far as possible already. This information
323-
might not yet be relevant for released Prometheus versions.)
321+
use cases.
324322

325323
### Buckets
326324

@@ -688,8 +686,11 @@ message BucketSpan {
688686
// [...]
689687
```
690688

691-
(TODO: The above does not yet contain the custom values needed for NHCBs. Update
692-
once merged into main.)
689+
(TODO: The above does not yet contain the custom values needed for NHCBs. We do
690+
not need it right now because NHCB can be ingested via scraping classic
691+
histograms. However, it might still be useful to have custom buckets in the
692+
exposition format eventually, e.g. for federation, and for future schemas that
693+
might also utilize the custom values.)
693694

694695
Note the following:
695696

@@ -1117,8 +1118,9 @@ as just one series with their unmodified name. (Example: A histogram called
11171118
### Scraping classic histograms as NHCBs
11181119

11191120
The aforementioned NHCB is capable of modeling a classic histogram as a native
1120-
histogram. Prometheus can be configured to ingest classic histograms as NHCBs
1121-
rather than classic histograms. (TODO: Explain how to do that once it is merged.)
1121+
histogram. Via the boolean scrape config option
1122+
`convert_classic_histograms_to_nhcb`, Prometheus can be configured to ingest
1123+
classic histograms as NHCBs.
11221124

11231125
NHCBs have the same issue with limited mergeability as classic histograms, but
11241126
they are generally much less expensive to store.

0 commit comments

Comments
 (0)