From 44841a0a4f46cc674fa1ee7db90775671b57b03c Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Tue, 12 Dec 2023 08:48:37 -0800 Subject: [PATCH] [chore] add warning documentation around healthcheck extension This follows https://github.com/open-telemetry/opentelemetry-collector/pull/9065#issuecomment-1852396742 Signed-off-by: Alex Boten --- extension/healthcheckextension/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/extension/healthcheckextension/README.md b/extension/healthcheckextension/README.md index 8c94345e1f5b..a7adc0cb1422 100644 --- a/extension/healthcheckextension/README.md +++ b/extension/healthcheckextension/README.md @@ -1,5 +1,14 @@ # Health Check +> ⚠️⚠️⚠️ **Warning** ⚠️⚠️⚠️ +> +> The `check_collector_pipeline` feature of this extension is not working as expected. It +> is recommended to not use the feature. The work to to add a new version of the healthcheck extension +> that relies on individual component status is in progress. To avoid breaking backwards compatibility, +> the configuration will not be changed until the new extension is available as a replacement for this +> one. See https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/11780 for more +> details. + | Status | | | ------------- |-----------|