From 1c798ec9300afeb021847d9decc69c69f81dca74 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Rabenstein?= Date: Fri, 14 Oct 2022 13:05:27 +0200 Subject: [PATCH] doc: Add notes about feature not yet supported for native histograms (#11453) Namely federation and recording rules. Signed-off-by: beorn7 --- docs/configuration/recording_rules.md | 4 ++++ docs/federation.md | 3 +++ 2 files changed, 7 insertions(+) diff --git a/docs/configuration/recording_rules.md b/docs/configuration/recording_rules.md index a14aab09d8..8ac6c15fc6 100644 --- a/docs/configuration/recording_rules.md +++ b/docs/configuration/recording_rules.md @@ -17,6 +17,10 @@ Rule files use YAML. The rule files can be reloaded at runtime by sending `SIGHUP` to the Prometheus process. The changes are only applied if all rule files are well-formatted. +_Note about native histograms (experimental feature): Rules evaluating to +native histograms do not yet work as expected. Instead of a native histogram, +the sample stored is just a floating point value of zero._ + ## Syntax-checking rules To quickly check whether a rule file is syntactically correct without starting diff --git a/docs/federation.md b/docs/federation.md index 1b4f04d73d..0a241144a1 100644 --- a/docs/federation.md +++ b/docs/federation.md @@ -8,6 +8,9 @@ sort_rank: 6 Federation allows a Prometheus server to scrape selected time series from another Prometheus server. +_Note about native histograms (experimental feature): Federation does not +support native histograms yet._ + ## Use cases There are different use cases for federation. Commonly, it is used to either