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

Expose Collector component metadata in registry #4921

Open
mx-psi opened this issue Jul 31, 2024 · 1 comment
Open

Expose Collector component metadata in registry #4921

mx-psi opened this issue Jul 31, 2024 · 1 comment

Comments

@mx-psi
Copy link
Member

mx-psi commented Jul 31, 2024

Desired feature or idea: Components in the OpenTelemetry Collector repositories have a metadata.yaml file (example) that documents the stability of the component across several signals.

Stability definitions are available here and follow OTEP 232 definitions. Making this information available on the opentelemetry.io website would help users understand what components are mature enough to be used in their build depending on their requirements.

Additional context: We would like to have this information available in the registry for the Collector 1.0 distro.

@svrnm
Copy link
Member

svrnm commented Aug 1, 2024

I created open-telemetry/community#2246 to address this project-wide, but independent of that, we should try to address this need from the collector SIG.

What we want to do boils down to merging the following two files:
https://github.com/open-telemetry/opentelemetry.io/blob/main/data/registry/collector-receiver-host-metrics.yml
and
https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/hostmetricsreceiver/metadata.yaml

The easiest is probably taking the status from the metadata YML and copy it into the registry YML and then turn that into a workflow that checks for changes and transfers that to the otel.io repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Status: Need Docs Review
Development

No branches or pull requests

2 participants