Skip to content

Commit

Permalink
[extension/healthcheckv2] Update readme to reflect current status (op…
Browse files Browse the repository at this point in the history
…en-telemetry#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.
  • Loading branch information
mwear authored and f7o committed Sep 12, 2024
1 parent b1cdf7e commit 95c52c4
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions extension/healthcheckv2extension/README.md
Original file line number Diff line number Diff line change
@@ -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** ⚠️⚠️⚠️
>
Expand Down

0 comments on commit 95c52c4

Please sign in to comment.