-
Notifications
You must be signed in to change notification settings - Fork 1.9k
[mdatagen] Add support for example configurations in metadata.yaml #14133
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
Open
sAchin-680
wants to merge
11
commits into
open-telemetry:main
Choose a base branch
from
sAchin-680:feat/mdatagen-example-configs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
[mdatagen] Add support for example configurations in metadata.yaml #14133
sAchin-680
wants to merge
11
commits into
open-telemetry:main
from
sAchin-680:feat/mdatagen-example-configs
+301
−30
Conversation
This file contains hidden or 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
Changes: - Add ExampleConfig struct and example_configs field to metadata schema - Update documentation template to render example configurations - Generate validation tests for example configurations (YAML syntax check) - Fix unused import in config_test.go.tmpl (conditional import of confmap) - Add example configurations to samplereceiver and samplescraper Addresses requirement from issue open-telemetry#14066 to automate validation and fulfillment of component stability documentation criteria. Testing: - All existing tests pass - New TestExampleConfigs validates example configurations are valid YAML - Documentation correctly renders example configurations Signed-off-by: SACHIN KUMAR <mrmister680@gmail.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #14133 +/- ##
==========================================
- Coverage 92.21% 92.18% -0.03%
==========================================
Files 670 670
Lines 41472 41472
==========================================
- Hits 38242 38230 -12
- Misses 2193 2201 +8
- Partials 1037 1041 +4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
florianl
reviewed
Dec 3, 2025
cmd/mdatagen/internal/samplescraper/internal/metadata/generated_metrics.go
Outdated
Show resolved
Hide resolved
- Revert semconv imports from v1.9.0 to v1.37.0 in generated files - Add changelog entry for example_configs feature
Signed-off-by: SACHIN <sachin@SACHINs-MacBook-Pro.local>
|
|
dmathieu
reviewed
Jan 8, 2026
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.
Key Features:
example_configsfield in metadata.yaml supporting multiple named examplesChanges:
ExampleConfigstruct andexample_configsfield to metadata schemaTestExampleConfigsto validate example YAML syntaxconfig_test.go.tmpl(conditional confmap import)samplereceiverandsamplescraperas demosLink to tracking issue
Addresses #14066 - Automate validation and fulfillment of criteria outlined in the "Component Stability" document
Fixes #14097 - Ensure all components have at least one sample configuration
Testing
TestExampleConfigsvalidates each example configuration is valid YAMLDocumentation
metadata-schema.yamlwithexample_configsfield documentation and usage examplesdocumentation.mdfiles