Skip to content

Add strict YAML parsing guidance to supplementary guidelines#4878

Open
zeitlinger wants to merge 3 commits intoopen-telemetry:mainfrom
zeitlinger:strict-yaml
Open

Add strict YAML parsing guidance to supplementary guidelines#4878
zeitlinger wants to merge 3 commits intoopen-telemetry:mainfrom
zeitlinger:strict-yaml

Conversation

@zeitlinger
Copy link
Member

@zeitlinger zeitlinger commented Feb 6, 2026

Adds a new section recommending strict YAML parsing practices for configuration files, including use of YAML 1.2 Core Schema, disabling dangerous deserialization features, and using safe parser modes. This helps prevent security issues and unintended type coercion.

Fixes #

Changes

Please provide a brief description of the changes here.

For non-trivial changes, follow the change proposal process.

  • Related issues #
  • Related OTEP(s) #
  • Links to the prototypes (when adding or changing features)
  • CHANGELOG.md file updated for non-trivial changes
    • For trivial changes, include [chore] in the PR title to skip the changelog check
  • Spec compliance matrix updated if necessary

Adds a new section recommending strict YAML parsing practices for
configuration files, including use of YAML 1.2 Core Schema, disabling
dangerous deserialization features, and using safe parser modes. This
helps prevent security issues and unintended type coercion.
@zeitlinger zeitlinger requested review from a team as code owners February 6, 2026 15:30
Reframe guidance toward configuration file authors instead of
implementations, remove normative language (SHOULD), and add note
clarifying that practices are derived from the YAML 1.2 Core Schema
and common security best practices.
@jack-berg
Copy link
Member

This seems like a good addition. Adhering to strict YAML increases the likelihood of a consistent experience across languages.

However, its unlikely that all language implementations can configure their YAML parsers to enforce strict parsing. And so supplementary guidance to users seems like the most appropriate way to encourage this.

@zeitlinger
Copy link
Member Author

/easycla

@jack-berg jack-berg self-assigned this Feb 18, 2026
@carlosalberto
Copy link
Contributor

@jack-berg @zeitlinger Do we need more reviews from the config SIG? Or we good to go?

@zeitlinger
Copy link
Member Author

I think we're good — two spec approver approvals should be sufficient. Thanks for the review!

@pellared pellared added the area:configuration Related to configuring the SDK label Mar 4, 2026
Comment on lines +59 to +60
- Add strict YAML parsing guidance to configuration supplementary guidelines.
([#4878](https://github.com/open-telemetry/opentelemetry-specification/pull/4878))
Copy link
Member

Choose a reason for hiding this comment

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

(nit) How about moving to "SDK Configuration" section?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:configuration Related to configuring the SDK

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants