[cmd/mdatagen] Add lint/ordering validation for metadata.yaml #13782

paulojmdias · 2025-09-06T08:39:33Z

Description

Extend mdatagen to validate that keys in metadata.yaml files are alphabetically sorted (resource_attributes, attributes, metrics, events, and telemetry.metrics).

The idea came from open-telemetry/opentelemetry-collector-contrib#42477 (comment)

Link to tracking issue

Fixes #13781

Testing

I added tests to validate unordered data and expect an error on it.

❯ mdatagen metadata.yaml
Error: metadata.yaml ordering check failed: [telemetry metrics] keys are not sorted: [metric1 metric0]
Error: metadata.yaml ordering check failed: [telemetry metrics] keys are not sorted: [metric1 metric0]

❯ mdatagen metadata.yaml
Error: metadata.yaml ordering check failed: [resource_attributes] keys are not sorted: [cloud.region cloud.availability_zone cloud.provider host.id host.name]
Error: metadata.yaml ordering check failed: [resource_attributes] keys are not sorted: [cloud.region cloud.availability_zone cloud.provider host.id host.name]

Signed-off-by: Paulo Dias <[email protected]>

codecov · 2025-09-06T12:19:41Z

Codecov Report

❌ Patch coverage is 83.01887% with 9 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.59%. Comparing base (266beca) to head (ee2eba5).
⚠️ Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
cmd/mdatagen/internal/command.go	83.01%	6 Missing and 3 partials ⚠️

❌ Your patch status has failed because the patch coverage (83.01%) is below the target coverage (95.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #13782      +/-   ##
==========================================
- Coverage   91.61%   91.59%   -0.02%     
==========================================
  Files         655      655              
  Lines       42729    42782      +53     
==========================================
+ Hits        39147    39188      +41     
- Misses       2761     2769       +8     
- Partials      821      825       +4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Signed-off-by: Paulo Dias <[email protected]>

github-actions · 2025-09-23T03:20:58Z

This PR was marked stale due to lack of activity. It will be closed in 14 days.

paulojmdias · 2025-09-23T08:50:43Z

/label -stale never-stale

github-actions · 2025-10-09T03:22:56Z

This PR was marked stale due to lack of activity. It will be closed in 14 days.

dmitryax · 2025-10-09T04:05:37Z

The proposal LGTM. @paulojmdias are you planning to finalize the PR?

paulojmdias · 2025-10-09T06:34:52Z

@dmitryax yes, I will work into it soon

… into feat/13781 Signed-off-by: Paulo Dias <[email protected]>

Signed-off-by: Paulo Dias <[email protected]>

paulojmdias · 2025-10-10T22:32:22Z

@dmitryax I think you can review now.

All the reordering of metadata.yaml files are on this PR, but please let me know if you prefer to move it into a different PRs.

The contrib_tests are expected to fail, as a lot of metadata.yaml files are not properly sorted.

The changelog pipeline failure will be fixed in #14000

dmitryax

Do you have any script or temporary command to update existing files? It'll be painful to sort all the metadata.yaml files in contrib manually

cmd/mdatagen/internal/command.go

…telemetry#43447) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…pen-telemetry#43449) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…metry#43477) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…etry#43478) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…en-telemetry#43472) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…-telemetry#43471) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…pen-telemetry#43462) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…metry#43459) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…pen-telemetry#43451) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…emetry#43463) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…metry#43476) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…telemetry#43469) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…lemetry#43468) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…n-telemetry#43461) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…lemetry#43460) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…en-telemetry#43465) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…telemetry#43455) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…pen-telemetry#43450) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

open-telemetry#43454) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…tries (open-telemetry#43446) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…pen-telemetry#43445) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…pen-telemetry#43441) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…n-telemetry#43583) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…lemetry#43578) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…lemetry#43582) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…lemetry#43581) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…en-telemetry#43580) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

open-telemetry#43579) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 --------- Signed-off-by: Paulo Dias <[email protected]> Co-authored-by: Alex Boten <[email protected]>

…telemetry#43627) #### Description Sort metadata.yaml file in preparation for sort validation using mdatagen. Context: open-telemetry/opentelemetry-collector#13782 Signed-off-by: Paulo Dias <[email protected]>

…elemetry#43639) #### Description Sort metadata.yaml files since sort validation using mdatagen was already merged. Context: open-telemetry/opentelemetry-collector#13782 Fixes core collector tests. Core pipeline failed: https://github.com/open-telemetry/opentelemetry-collector/actions/runs/18602672590/job/53044660662 Signed-off-by: Paulo Dias <[email protected]>

paulojmdias added 2 commits September 6, 2025 09:37

[cmd/mdatagen] Add lint/ordering validation for metadata.yaml

10be8fe

Signed-off-by: Paulo Dias <[email protected]>

feat: add tests

d7c634c

Signed-off-by: Paulo Dias <[email protected]>

paulojmdias marked this pull request as ready for review September 6, 2025 08:42

paulojmdias requested review from a team and dmitryax as code owners September 6, 2025 08:42

github-actions bot added the cmd/mdatagen label Sep 6, 2025

paulojmdias marked this pull request as draft September 6, 2025 08:54

paulojmdias and others added 2 commits September 6, 2025 12:22

chore: improve linting

ca48de9

Signed-off-by: Paulo Dias <[email protected]>

fix: revert test

73c7c28

paulojmdias added 2 commits September 7, 2025 21:16

chore: sort

0d4b186

Signed-off-by: Paulo Dias <[email protected]>

fix: improve testing

598d295

Signed-off-by: Paulo Dias <[email protected]>

github-actions bot added the Stale label Sep 23, 2025

github-actions bot removed the Stale label Sep 24, 2025

github-actions bot added the Stale label Oct 9, 2025

dmitryax removed the Stale label Oct 9, 2025

paulojmdias and others added 5 commits October 10, 2025 23:07

Merge branch 'main' of github.com:paulojmdias/opentelemetry-collector…

f840faf

… into feat/13781 Signed-off-by: Paulo Dias <[email protected]>

chore: make gotidy

c473418

Signed-off-by: Paulo Dias <[email protected]>

Merge branch 'main' into feat/13781

5d766cc

chore: fix metadata

8039f9c

Signed-off-by: Paulo Dias <[email protected]>

chore: update docs

ab936eb

Signed-off-by: Paulo Dias <[email protected]>

paulojmdias marked this pull request as ready for review October 10, 2025 22:30

paulojmdias requested a review from bogdandrutu as a code owner October 10, 2025 22:30

dmitryax reviewed Oct 11, 2025

View reviewed changes

cmd/mdatagen/internal/command.go Outdated Show resolved Hide resolved

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[cmd/mdatagen] Add lint/ordering validation for metadata.yaml #13782

[cmd/mdatagen] Add lint/ordering validation for metadata.yaml #13782

Uh oh!

paulojmdias commented Sep 6, 2025 •

edited

Loading

Uh oh!

codecov bot commented Sep 6, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Sep 23, 2025

Uh oh!

paulojmdias commented Sep 23, 2025

Uh oh!

github-actions bot commented Oct 9, 2025

Uh oh!

dmitryax commented Oct 9, 2025

Uh oh!

paulojmdias commented Oct 9, 2025

Uh oh!

paulojmdias commented Oct 10, 2025

Uh oh!

dmitryax left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

[cmd/mdatagen] Add lint/ordering validation for metadata.yaml #13782

[cmd/mdatagen] Add lint/ordering validation for metadata.yaml #13782

Uh oh!

Conversation

paulojmdias commented Sep 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Link to tracking issue

Testing

Uh oh!

codecov bot commented Sep 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions bot commented Sep 23, 2025

Uh oh!

paulojmdias commented Sep 23, 2025

Uh oh!

github-actions bot commented Oct 9, 2025

Uh oh!

dmitryax commented Oct 9, 2025

Uh oh!

paulojmdias commented Oct 9, 2025

Uh oh!

paulojmdias commented Oct 10, 2025

Uh oh!

dmitryax left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

paulojmdias commented Sep 6, 2025 •

edited

Loading

codecov bot commented Sep 6, 2025 •

edited

Loading