From 95c52c4bc98145643728c0e71e164bc246d0bd31 Mon Sep 17 00:00:00 2001 From: Matthew Wear Date: Thu, 5 Sep 2024 08:09:57 -0700 Subject: [PATCH] [extension/healthcheckv2] Update readme to reflect current status (#34913) There was a warning added to the readme indicating that the health check v2 extension was not ready for use. This was added because the extension was sliced up into a number of smaller PRs that were incrementally reviewed and merged. That process finished a while ago, but was followed by a component status refactor on core. Now that that work is complete, the extension is available for experimentation purposes for those who want to build a custom collector binary. This PR updates the readme to reflect the current status of the extension. --- extension/healthcheckv2extension/README.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/extension/healthcheckv2extension/README.md b/extension/healthcheckv2extension/README.md index 07e40e40177a..20f6242c1974 100644 --- a/extension/healthcheckv2extension/README.md +++ b/extension/healthcheckv2extension/README.md @@ -1,15 +1,12 @@ -# Health Check Extension - -> ⚠️⚠️⚠️ **Warning** ⚠️⚠️⚠️ -> This extension is not ready for use. The code is written, but the -[original PR](https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/30673) -is being sliced up into smaller PRs that are being reviewed and merged -incrementally. - -## Forward Looking README - -The remainder of this README is forward looking and serves as a reference for -the future functionality that will be provided and how it will be configured. +# Health Check Extension V2 + +This is an experimental extension that is intended to replace the existing +health check extension. As the stability level is currently development, users +wishing to experiment with this extension will have to build a custom collector +binary using the [OpenTelemetry Collector Builder](https://github.com/open-telemetry/opentelemetry-collector/tree/main/cmd/builder). +Health check extension V2 has new functionality that can be opted-in to, and +also supports original healthcheck extension functionality with the exception +of the `check_collector_pipeline` feature. See the warning below. > ⚠️⚠️⚠️ **Warning** ⚠️⚠️⚠️ >