Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[extension/healthcheckv2] Update readme to reflect current status #34913

Merged
merged 1 commit into from
Sep 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading