search

open-telemetry / semantic-conventions

Defines standards for generating consistent, accessible telemetry across a variety of domains
Apache License 2.0
274 stars 175 forks source link

Add a PR check to enforce Schema file presence/content if a semantic convention is changed #31

Open tigrannajaryan opened 3 years ago

tigrannajaryan commented 3 years ago

To ensure the Schema files correctly capture changes we make to semantic conventions I suggest that we add an automatic check that verifies that any PR that changes a semantic convention in a way that matters from Schema file perspective enforces that the Schema file change is also present (and ideally verifies that the changes match).

The only supported Schema file change is currently the renaming of attributes so the check needs to see any of attribute name is changed semantic convention yaml file and see if there is a corresponding change recorded in the Schema file.

tigrannajaryan commented 3 years ago

Help is needed on this one, especially if you are familiar with build-tools that generate the semantic conventions currently.

yurishkuro commented 3 years ago

+1. I thought we already had that, since it was called out in the original schemas OTEP.

tigrannajaryan commented 3 years ago

+1. I thought we already had that, since it was called out in the original schemas OTEP.

No yet. We have a check that verifies that every release has a corresponding Schema file. But we don't yet check individual PRs that modify semantic conventions.

tigrannajaryan commented 2 years ago

We need this and need help to implement it.