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

Create a command line tool to generate configschema yaml files #15231

Closed
pmcollins opened this issue Oct 17, 2022 · 6 comments
Closed

Create a command line tool to generate configschema yaml files #15231

pmcollins opened this issue Oct 17, 2022 · 6 comments
Assignees
Labels
cmd/configschema configschema command enhancement New feature or request Stale

Comments

@pmcollins
Copy link
Member

Is your feature request related to a problem? Please describe.

Documentation generators and tools could benefit from access to the data generated by the configschema API. If this data were written as YAML files to each component directory, it would be relatively straightforward for writers of tools and documentation to access them.

Also, the zip archive mode of this command will be useful for #13991 so that that tool can live in a separate repo and have access to the data it needs to run.

Describe the solution you'd like

A simple CLI tool to generate, based on CLI flags, either config schema YAML files for each component, or a single zip archive containing all of the YAML files.

Describe alternatives you've considered

No response

Additional context

Additional details provided in the readme of a PR to be opened shortly.

@pmcollins pmcollins added enhancement New feature or request needs triage New item requiring triage labels Oct 17, 2022
@evan-bradley evan-bradley removed the needs triage New item requiring triage label Oct 17, 2022
@abeach-nr
Copy link

another potential feature for this could be the metrics for each component that are emitted to the prometheus metrics for the collector. It would be useful to have this information in the metadata.yaml files.

@dmitryax
Copy link
Member

dmitryax commented Nov 2, 2022

another potential feature for this could be the metrics for each component that are emitted to the prometheus metrics for the collector. It would be useful to have this information in the metadata.yaml files.

This seems like a good idea even if most of the component expose the same metrics. In order to achieve that, we need to parse the code and generate that file automatically, but this probably should wait until we switch from OpenCensus instrumentation. And this a completely different topic, @abeach-nr if you want to continue the discussion let's create an a separate issue.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 2, 2023

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

@github-actions github-actions bot added the Stale label Jan 2, 2023
@fatsheep9146
Copy link
Contributor

This issue is solved by #15233, right? @dmitryax

@atoulme atoulme added the cmd/configschema configschema command label Mar 12, 2023
@github-actions
Copy link
Contributor

Pinging code owners for cmd/configschema: @mx-psi @dmitryax @pmcollins. See Adding Labels via Comments if you do not have permissions to add labels yourself.

@atoulme
Copy link
Contributor

atoulme commented Mar 12, 2023

Closed as fixed per #15233, please reopen if more work is needed.

@atoulme atoulme closed this as completed Mar 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cmd/configschema configschema command enhancement New feature or request Stale
Projects
None yet
Development

No branches or pull requests

6 participants