Skip to content

[CONFIGURATION] validate and update config files to yaml schema 1.1.0 - #4374

Merged
dbarker merged 10 commits into
open-telemetry:mainfrom
dbarker:yaml_schema_validation
Aug 7, 2026
Merged

[CONFIGURATION] validate and update config files to yaml schema 1.1.0#4374
dbarker merged 10 commits into
open-telemetry:mainfrom
dbarker:yaml_schema_validation

Conversation

@dbarker

@dbarker dbarker commented Aug 6, 2026

Copy link
Copy Markdown
Member

Followup to: #4340

Adds a script and test to validate the otel-config yaml files against the schema and update files as needed.

Changes

  • Adds an entry in third_party_release for the opentelemetry-configuration schema version
  • Adds a python script to validate the otel-confg yaml files against the schema version
  • Adds a github job in the CI workflow to validate the config files in examples and functional.
  • Updates the example kitchen-sink.yaml and extnesions.yaml to the 1.1 schema
  • Update the CMake and Bazel tests to run the example with those two files using the --test arg.

For significant contributions please make sure you have completed the following items:

  • CHANGELOG.md updated for non-trivial changes
  • Unit tests have been added
  • Changes in public API reviewed

Comment thread .github/workflows/ci.yml
@codecov

codecov Bot commented Aug 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.78%. Comparing base (4c973db) to head (77faf76).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #4374      +/-   ##
==========================================
- Coverage   81.79%   81.78%   -0.01%     
==========================================
  Files         493      493              
  Lines       19474    19474              
==========================================
- Hits        15926    15924       -2     
- Misses       3548     3550       +2     

see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dbarker dbarker changed the title [CI] validate and update otel-config yaml files [CONFIGURATION] validate and update otel-config files to yaml schema 1.1.0 Aug 7, 2026
@dbarker dbarker changed the title [CONFIGURATION] validate and update otel-config files to yaml schema 1.1.0 [CONFIGURATION] validate and update config files to yaml schema 1.1.0 Aug 7, 2026
@dbarker
dbarker marked this pull request as ready for review August 7, 2026 03:59
@dbarker
dbarker requested a review from a team as a code owner August 7, 2026 03:59
dbarker added a commit to dbarker/opentelemetry-cpp that referenced this pull request Aug 7, 2026
@marcalff

marcalff commented Aug 7, 2026

Copy link
Copy Markdown
Member

Really confused by:

[DO NOT REVIEW - this commit is to take the yaml file and example changes from https://github.com//pull/4374 and should be reviewed in that PR]

Here is PR 4374, what is this about ?

@dbarker dbarker left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The yaml files have updates for 1.1:

  • Move TLS settings under the tls: key
  • Remove zipkin as it is no longer in the schema
  • add event_to_span_event_bridge/development (commented out pending #4309
  • update logger_configurator/development to add the current config keys.
  • add max_export_batch_size/development to the periodic reader
  • update meter_configurator/development and tracer_configurator/development key from disabled to enabled
  • add id_generator to tracer provider
  • update the sampler field to instantiate all supported samplers
  • remove peer from the instrumentation section as it has been removed from the schema.

Comment thread examples/configuration/extensions.yaml
Comment thread tools/validate_otel_config_yaml.py

@marcalff marcalff left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, excellent tooling improvement.

@dbarker

dbarker commented Aug 7, 2026

Copy link
Copy Markdown
Member Author

Really confused by:

[DO NOT REVIEW - this commit is to take the yaml file and example changes from https://github.com/https://github.com//pull/4374 and should be reviewed in that PR]

Here is PR 4374, what is this about ?

My intent was to test #4367 with this PR's changes early by adding them to both PRs. The review of these yaml file updates should be done in this PR. Once this PR is merged, #4367 will show far fewer files/lines changed.

@marcalff

marcalff commented Aug 7, 2026

Copy link
Copy Markdown
Member

CI failures:

example_yaml --test --yaml shelltests/prometheus_translation_broken.yaml
Expected stdout: 
[ERROR] <shelltests/prometheus_translation_broken.yaml>:9[10](164): Illegal TranslationStrategy: broken
FAILED TO PARSE MODEL

Got stdout:      
[ERROR] <shelltests/prometheus_translation_broken.yaml>:10[10](238): Illegal TranslationStrategy: broken
FAILED TO PARSE MODEL

9[10](164) changed to 10[10](238), this is the line[column](offset) of the yaml text in the file.

Most likely due to adding the magic SKIP_SCHEMA_VALIDATION comment.

@marcalff marcalff added the ok-to-merge The PR is ok to merge (has two approves or raised by a maintainer/approver and has one approve) label Aug 7, 2026
@marcalff

marcalff commented Aug 7, 2026

Copy link
Copy Markdown
Member

@dbarker

Label ok-to-merge: feel free to merge once the shelltest ci passes.

@dbarker
dbarker merged commit b1efe57 into open-telemetry:main Aug 7, 2026
73 checks passed
@dbarker
dbarker deleted the yaml_schema_validation branch August 7, 2026 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ok-to-merge The PR is ok to merge (has two approves or raised by a maintainer/approver and has one approve)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants