opentelemetry-collector-contrib
opentelemetry-collector-contrib copied to clipboard
[cmd/configschema] use contrib components, simplify grepmod code
The configschema module makes available an API to get metadata about component configs. It also provides a command, docsgen
, to generate markdown files for each component, describing its configuration fields, types, and default values.
This functionality got moved from core a few months back, but there was some additional work remaining. This change finishes that work, making configschema compatible with contrib.
This change also adds a makefile target, which runs docsgen all
, writing over 140 markdown files to their corresponding component directories. For reference, one example markdown file is included in this PR (for the Redis receiver).
We will likely want to get a markdown generation job running as well, but that will be handled as a separate effort.
Addresses https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/12639
Please take a look at the failing CI checks
@pmcollins can you please fix the failing CI checks and rebase?
Failing tests seem to be related. In order to make markdown-link-check
tool happy, you'd probably need to add another section in https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/.github/workflows/check_links_config.json#L2 to ignore anchor links
Hi @dmitryax -- all checks have passed 🎉
Oh I see you created https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/13384 already. Let's move the discussion there