Skip to content

Add bare minimum Entity Association capabilities - Apply to System + Process semconv#2123

Merged
jsuereth merged 8 commits intoopen-telemetry:mainfrom
jsuereth:wip-entity-associations
Apr 28, 2025
Merged

Add bare minimum Entity Association capabilities - Apply to System + Process semconv#2123
jsuereth merged 8 commits intoopen-telemetry:mainfrom
jsuereth:wip-entity-associations

Conversation

@jsuereth
Copy link
Copy Markdown
Contributor

@jsuereth jsuereth commented Apr 16, 2025 •
edited
Loading

Fixes #1276

Changes

  • Adds policies ensuring entity_associations declared link to valid resource groups defined in semantic conventions.
  • Adds rendering template support for showing required entity_associations in all signals
  • Updates System + Process metrics to include entity associations (cc @open-telemetry/semconv-system-approvers for review)

Future Fixes

  • Update registry generation to include a registry of Entities in addition to registry of Attributes.
  • Adding links to Entity definitions from entity association references (may depend on registry)
  • Stability policies around entity associations.

Merge requirement checklist

@jsuereth jsuereth requested review from a team as code owners April 16, 2025 14:19
@jsuereth jsuereth requested review from a team as code owners April 16, 2025 14:19
lmolkova
lmolkova reviewed Apr 16, 2025
View reviewed changes
Comment thread docs/system/process-metrics.md Outdated
@github-actions github-actions Bot added the enhancement New feature or request label Apr 16, 2025
ChrsMark
ChrsMark approved these changes Apr 17, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@ChrsMark ChrsMark left a comment

Choose a reason for hiding this comment

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

Thank's for addressing this!

One question: The linked issue mentioned that metrics would be linked to resources but here we link entities. Is this a decision made that is documented somewhere? I'm mostly trying to think what is the way forward for areas like k8s where we "verbally" link metrics to already existing resources.

@adrielp adrielp mentioned this pull request Apr 17, 2025
Closed
@jsuereth
Copy link
Copy Markdown
Contributor Author

jsuereth commented Apr 17, 2025

One question: The linked #1276 mentioned that metrics would be linked to resources but here we link entities. Is this a decision made that is documented somewhere? I'm mostly trying to think what is the way forward for areas like k8s where we "verbally" link metrics to already existing resources.

We're going to be using the term Entity, as now a Resource is a collection of Entity. The existing resource modelling in semantic conventions is problematic, as it's basically un-enforcable. It's unclear how we would ensure compliance or even do schema url migrations given there's no clear way to recognize a "bundle of attributes". So we're using Entity to represent this going forward.

You can see the plans here:

lmolkova
lmolkova approved these changes Apr 18, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@lmolkova lmolkova left a comment

Choose a reason for hiding this comment

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

this is awesome!

I hope we can add associations for at least obvious cases, but it's also ok to do it as a follow up if it'd be your preference.

Comment thread templates/registry/markdown/event_macros.j2
Comment thread policies/entity_association.rego
Comment thread docs/http/http-metrics.md
Comment thread docs/otel/sdk-metrics.md
Comment thread docs/hardware/host.md
Comment thread docs/faas/faas-metrics.md
@github-project-automation github-project-automation Bot moved this from Untriaged to Needs More Approval in Semantic Conventions Triage Apr 18, 2025
@lmolkova lmolkova mentioned this pull request Apr 18, 2025
Merged
3 tasks
@ChrsMark ChrsMark mentioned this pull request Apr 24, 2025
Closed
3 tasks
rogercoll
rogercoll approved these changes Apr 25, 2025
View reviewed changes
Comment thread docs/system/process-metrics.md
trask
trask approved these changes Apr 25, 2025
View reviewed changes
Comment thread templates/registry/markdown/metric_table.j2
@lmolkova lmolkova moved this from Needs More Approval to Ready to be Merged in Semantic Conventions Triage Apr 27, 2025
@lmolkova lmolkova added this to the 1.33.0 milestone Apr 27, 2025
@jsuereth jsuereth enabled auto-merge April 28, 2025 12:49
@jsuereth jsuereth added this pull request to the merge queue Apr 28, 2025
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Apr 28, 2025
@trask trask added this pull request to the merge queue Apr 28, 2025
github-merge-queue Bot pushed a commit that referenced this pull request Apr 28, 2025
@jsuereth
Add bare minimum Entity Association capabilities - Apply to System + …
7ee2cfe 
…Process semconv (#2123)
@trask
Copy link
Copy Markdown
Member

trask commented Apr 28, 2025

@jsuereth it looks like this just needs a rebase and make

@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Apr 28, 2025
@jsuereth jsuereth added this pull request to the merge queue Apr 28, 2025
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Apr 28, 2025
@jsuereth jsuereth enabled auto-merge April 28, 2025 16:27
@jsuereth jsuereth added this pull request to the merge queue Apr 28, 2025
Merged via the queue into open-telemetry:main with commit c114663 Apr 28, 2025
15 checks passed
@jsuereth jsuereth deleted the wip-entity-associations branch April 28, 2025 16:29
@github-project-automation github-project-automation Bot moved this from Ready to be Merged to Needs More Approval in Semantic Conventions Triage Apr 28, 2025
@lmolkova lmolkova mentioned this pull request Apr 29, 2025
Merged
2 tasks
lmolkova pushed a commit to lmolkova/semantic-conventions that referenced this pull request May 13, 2025
@jsuereth
Add bare minimum Entity Association capabilities - Apply to System + …
48e2d1e 
…Process semconv (open-telemetry#2123)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@trask trask trask approved these changes

@lmolkova lmolkova lmolkova approved these changes

@dmitryax dmitryax dmitryax approved these changes

@ChrsMark ChrsMark ChrsMark approved these changes

@rogercoll rogercoll rogercoll approved these changes

+1 more reviewer

@smith smith smith approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

area:system enhancement New feature or request

Projects

Semantic Conventions Triage
Archived in project

Milestone

1.33.0

Development

Successfully merging this pull request may close these issues.

Schema should allow to express which resource attributes need to be associated with a signal

7 participants

@jsuereth @trask @smith @lmolkova @dmitryax @ChrsMark @rogercoll