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

[docs]: Is the healthcheckv2 extension actually active, or just baked into the release but not available? #33301

Closed
diranged opened this issue May 29, 2024 · 5 comments
Labels
documentation Improvements or additions to documentation extension/healthcheckv2

Comments

@diranged
Copy link

Component(s)

extension/healthcheckv2

What happened?

Description

The healthcheckv2 extension doesn't seem active or available in the https://github.com/open-telemetry/opentelemetry-collector-contrib/releases/tag/v0.101.0 or https://github.com/open-telemetry/opentelemetry-collector-contrib/releases/tag/v0.100.0 docker images - even though it was listed as being released in the New Components section of the https://github.com/open-telemetry/opentelemetry-collector-contrib/releases/tag/v0.100.0 readme:

image

If it's not available yet - can we update the README to indicate that?

#32523

error decoding 'extensions': unknown type: "healthcheckv2" for id: "healthcheckv2" (valid values: [asapclient basicauth otlp_encoding http_forwarder k8s_observer file_storage zpages ack ecs_task_observer sigv4auth db_storage awsproxy zipkin_encoding docker_observer ecs_observer opamp pprof jaeger_encoding headers_setter health_check jaegerremotesampling oauth2client host_observer oidc memory_ballast bearertokenauth])

Collector version

0.101.0

Environment information

Environment

OS: (e.g., "Ubuntu 20.04")
Compiler(if manually compiled): (e.g., "go 14.2")

OpenTelemetry Collector configuration

No response

Log output

No response

Additional context

No response

@diranged diranged added bug Something isn't working needs triage New item requiring triage labels May 29, 2024
Copy link
Contributor

Pinging code owners:

See Adding Labels via Comments if you do not have permissions to add labels yourself.

@mwear
Copy link
Member

mwear commented May 29, 2024

@diranged, thanks for your report. Only the skeleton exists at this point. The rest of the extension is written, but it's being reviewed and merged in smaller chunks. We can update the readme as you suggest.

@mwear mwear removed the needs triage New item requiring triage label May 29, 2024
@crobert-1 crobert-1 added documentation Improvements or additions to documentation and removed bug Something isn't working labels May 30, 2024
@twistypigeon
Copy link

Agreed README needs an update. I've spent most of today building a custom collector that includes this component but it appears it doesn't actually work or do anything as none of the ports are listening. A note on the README to indicate that it shouldn't be used yet would be very helpful.
Saying that I am looking forward to seeing it complete so that gRPC can be used for health checks as well as the runtime config view HTTP endpoint. Thanks for your work on this.

bogdandrutu pushed a commit that referenced this issue May 30, 2024
…#33313)

**Description:**
Several users have tried to use this extension as the README makes it
appear as though it's ready for use. I've updated
the README to include a warning and a note that the README is forward
looking. I think it's useful to describe the functionality that the
extension will provide when #30673 has been fully decomposed and
integrated.

cc: @diranged @twistypigeon

Let me know if stronger wording is needed.

**Link to tracking Issue:** #33301 

**Documentation:** README update
@mwear
Copy link
Member

mwear commented May 30, 2024

Apologies for the confusion. I sincerely hope we can get the extension in a usable form shortly. In the meantime, the readme has been updated to note that it's not currently ready for use. If you'd like any further changes to the readme, comment and I'll address them.

@diranged
Copy link
Author

diranged commented Sep 4, 2024

@mwear I noticed that the healthcheckv2extension has been in the collector go.mod since v0.100.0... what is the current status for this thing? Is it ready for use yet?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation extension/healthcheckv2
Projects
None yet
Development

No branches or pull requests

4 participants