mdatagen: support custom package name #11232
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds support for a new `--package_name` flag to allow mdatagen to generate packages with names other than `metadata`.
bogdandrutu
reviewed
Sep 20, 2024
codeboten
reviewed
Sep 25, 2024
There was a problem hiding this comment.
Overall this looks pretty good, just a couple of comments, it looks like make gofmt needs to be run to sort out the import statements. Also please add a note in the schema file: https://github.com/open-telemetry/opentelemetry-collector/blob/main/cmd/mdatagen/metadata-schema.yaml
cmd/mdatagen/internal/samplereceiver/generated_component_test.go
Outdated
Show resolved
Hide resolved
cmd/mdatagen/internal/samplereceiver/internal/metadata/generated_config_test.go
Outdated
Show resolved
Hide resolved
cmd/mdatagen/internal/samplereceiver/internal/metadata/generated_metrics_test.go
Outdated
Show resolved
Hide resolved
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #11232 +/- ##
=======================================
Coverage 92.15% 92.15%
=======================================
Files 432 432
Lines 20291 20293 +2
=======================================
+ Hits 18700 18702 +2
Misses 1228 1228
Partials 363 363 ☔ View full report in Codecov by Sentry. |
dmitryax
approved these changes
Oct 9, 2024
braydonk
added a commit
to braydonk/opentelemetry-collector
that referenced
this pull request
Oct 16, 2024
I noticed a mistake in my previous PR open-telemetry#11232; some function calls did not pass the correct package name in (passing in "metadata" instead of the intended generated package name). This PR attempts to address the potential for this mistake to even occur by providing a wrapper `generateFile` function that automatically uses the generated package name from the metadata. The original version of the function that accepts a package name is intact for the templates that are going in the base package instead of the generated one.
braydonk
added a commit
to braydonk/opentelemetry-collector
that referenced
this pull request
Oct 16, 2024
I noticed a mistake in my previous PR open-telemetry#11232; some function calls did not pass the correct package name in (passing in "metadata" instead of the intended generated package name). This PR attempts to address the potential for this mistake to even occur by providing a wrapper `generateFile` function that automatically uses the generated package name from the metadata. The original version of the function that accepts a package name is intact for the templates that are going in the base package instead of the generated one.
djaglowski
pushed a commit
to djaglowski/opentelemetry-collector
that referenced
this pull request
Nov 21, 2024
#### Description This PR adds support for a new ~~`--package_name` flag~~ `generated_package_name` config field to allow mdatagen to generate packages with names other than `metadata`. #### Link to tracking issue Fixes open-telemetry#11231 #### Testing * Unit tests * `go install`ing this branch and using it in a test scenario with two yaml files and generating two packages. #### Documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds support for a new
--package_nameflaggenerated_package_nameconfig field to allow mdatagen to generate packages with names other thanmetadata.Link to tracking issue
Fixes #11231
Testing
go installing this branch and using it in a test scenario with two yaml files and generating two packages.Documentation