Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Use YAML descriptions for Resources #1400

Merged
merged 10 commits into from
Sep 16, 2024
Merged

Use YAML descriptions for Resources #1400

merged 10 commits into from
Sep 16, 2024

Conversation

jsuereth
Copy link
Contributor

@jsuereth jsuereth commented Sep 10, 2024 •
edited
Loading

Fixes #1399

Sending for feedback on approach.

Changes

  • Update service + telemetry.sdk YAML to officially mark themselves as stable.
  • Update snippet template to generate FULL resource semconv template, forcing all markdown to by in sync
  • Add name to resource groups that denote the type field previously in markdown only.
  • Add policy requiring naming conventions on name for resource group types.
  • Add backwards compatibility check on resource - required/recommended attributes cannot be removed once stable.

Merge requirement checklist

@jsuereth
Mark service/telemetry.sdk groups as stable.
262e934
@jsuereth
Update resource semantic conventions to pull information from yaml.
7fe9823 
- Add name to all resoruce semconv groups denoting the "type" for now.
- Remove type/description from markdown in favor of pulling from YAML
  file.
- Update all yaml + md for the new generation techniques.
@jsuereth jsuereth marked this pull request as ready for review September 10, 2024 15:29
@jsuereth jsuereth requested review from a team September 10, 2024 15:29
lmolkova
lmolkova reviewed Sep 10, 2024
View reviewed changes
.chloggen/2921.yaml Outdated Show resolved Hide resolved
docs/resource/README.md Show resolved Hide resolved
model/resource/process.yaml Show resolved Hide resolved
policies/compatibility.rego Outdated Show resolved Hide resolved
docs/resource/k8s.md Outdated Show resolved Hide resolved
model/resource/service.yaml Outdated Show resolved Hide resolved
policies/compatibility.rego Show resolved Hide resolved
model/resource/service_experimental.yaml Show resolved Hide resolved
policies/yaml_schema.rego Outdated Show resolved Hide resolved
@jsuereth jsuereth mentioned this pull request Sep 11, 2024
Merged
@jsuereth jsuereth merged commit f14f54c into open-telemetry:main Sep 16, 2024
14 checks passed
@jsuereth jsuereth deleted the wip-resource-groups branch September 16, 2024 13:01
drewby pushed a commit to drewby/otel-semantic-conventions that referenced this pull request Oct 1, 2024
@jsuereth @drewby
Use YAML descriptions for Resources (open-telemetry#1400)
a985fc8
@lmolkova lmolkova mentioned this pull request Nov 22, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tigrannajaryan tigrannajaryan tigrannajaryan left review comments

@ChrsMark ChrsMark ChrsMark approved these changes

@joaopgrassi joaopgrassi joaopgrassi approved these changes

@lmolkova lmolkova lmolkova approved these changes

@AlexanderWert AlexanderWert AlexanderWert approved these changes

@lquerel lquerel lquerel approved these changes

Assignees

@arminru arminru

Labels
None yet
Projects
Semantic Conventions Triage
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Resource Semantic Convention Stabilization Issues
8 participants
@jsuereth @lquerel @AlexanderWert @lmolkova @tigrannajaryan @joaopgrassi @ChrsMark @arminru