Skip to content

Update semconv JSON schema for entities #731

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.

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

smith
Copy link

@smith smith commented May 7, 2025

  • Add entity_associations for metrics
  • Update display_name description to be more generic
  • Replace resource with updated entity schema

To try this out in VS Code, update the .vscode/settings.json in your semconv checkout to point to "../weaver/schemas/semconv.schema.json", assuming your weaver and semconv checkouts are in sibling directories. You may need to close and reopen the semconv window.

When this is merged and a release happens a PR to semconv can be made to update the version of the JSON schema.

- Add `entity_associations` for metrics
- Update `display_name` description to be more generic
- Replace resource with updated entity schema
@smith smith requested a review from a team as a code owner May 7, 2025 03:26
Copy link

codecov bot commented May 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.7%. Comparing base (6301f33) to head (bc107b8).

Additional details and impacted files
@@           Coverage Diff           @@
##            main    #731     +/-   ##
=======================================
- Coverage   76.7%   76.7%   -0.1%     
=======================================
  Files         65      65             
  Lines       5012    5012             
=======================================
- Hits        3846    3845      -1     
- Misses      1166    1167      +1     

☔ 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.

Copy link
Contributor

@jsuereth jsuereth left a comment

Choose a reason for hiding this comment

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

Thanks for updating this! A few comments on what we can/should support right now.

},
"description": "list of identifying attributes for the entity type"
},
"descriptive_attributes": {
Copy link
Contributor

Choose a reason for hiding this comment

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

This doesn't exist yet.

Also I'm going to be talking about this in today's tooling sync, but we may actually want descriptive to be an aspect of attribute, vs. a separate bundle, both for the ref aspect of weaver and the diff aspect.

},
"description": "list of descriptive attributes for the entity type"
},
"relationships": {
Copy link
Contributor

Choose a reason for hiding this comment

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

This also doesn't exist in weaver yet, so we should hold off adding it.

@@ -458,6 +503,11 @@
"unit": {
"type": "string",
"description": "The unit in which the metric is measured in."
},
"entity_associations": {
Copy link
Contributor

Choose a reason for hiding this comment

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

We can actually add this to Event + Span as well.

@smith
Copy link
Author

smith commented May 7, 2025

@jsuereth I'll keep the parts that don't exist yet in this PR and move it to draft. I'll open a new PR with the remaining changes that can be made now. Thanks for looking!

@smith smith marked this pull request as draft May 7, 2025 16:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants