Skip to content

[entities] Define rules for entity-resource referencing model#4499

Merged
jsuereth merged 1 commit intoopen-telemetry:mainfrom
dmitryax:add-resource-entities-section
Jun 5, 2025
Merged

[entities] Define rules for entity-resource referencing model#4499
jsuereth merged 1 commit intoopen-telemetry:mainfrom
dmitryax:add-resource-entities-section

Conversation

@dmitryax
Copy link
Member

@dmitryax dmitryax commented May 8, 2025

Add description of how entities reference resource attributes and clarifies rules for handling shared descriptive attributes across entities.

Fixes #4370

@dmitryax dmitryax requested review from a team May 8, 2025 05:16
@dmitryax dmitryax force-pushed the add-resource-entities-section branch 3 times, most recently from fb0a302 to 5b74b75 Compare May 8, 2025 15:25
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.

On board with the normative portions of this.

Have suggestions for how to rework the specification wording so this is about the data-model, and flexible enough to support future evolution.

@github-actions
Copy link

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label May 17, 2025
@dmitryax dmitryax force-pushed the add-resource-entities-section branch 2 times, most recently from 8cdc84a to 1359107 Compare May 22, 2025 06:40
@jsuereth jsuereth added entities and removed Stale labels May 22, 2025
@github-actions
Copy link

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label May 31, 2025
@dmitryax dmitryax force-pushed the add-resource-entities-section branch from 1359107 to f8a4a6d Compare June 1, 2025 20:09
Copy link
Member

@tigrannajaryan tigrannajaryan left a comment

Choose a reason for hiding this comment

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

Mostly LGTM, just one comment remaining about a term used ("most specific").

@github-actions github-actions bot removed the Stale label Jun 3, 2025
Adds description of how entities reference resource attributes and clarifies
rules for handling shared descriptive attributes across entities.
@dmitryax dmitryax force-pushed the add-resource-entities-section branch from f8a4a6d to a022920 Compare June 5, 2025 15:02
@jsuereth jsuereth enabled auto-merge June 5, 2025 15:07
@jsuereth jsuereth added this pull request to the merge queue Jun 5, 2025
Merged via the queue into open-telemetry:main with commit bea81b1 Jun 5, 2025
6 checks passed
If multiple entities share the same descriptive attribute key with potentially
conflicting values, the attribute MUST logically belong to **only one** of them.
All others SHOULD NOT reference it. The attribute MUST be referenced by the
**most specific** entity, the one closest in the topology graph to the entity

Choose a reason for hiding this comment

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

I don't understand what "closest in the topology graph" means. The confusing example is not k8s.node and k8s.cluster, it's k8s.node and gce.instance, where the resources come from two different topologies.

Copy link
Member Author

Choose a reason for hiding this comment

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

What shared attributes k8s.node and gce.instance would have? I cannot think of any

@dmitryax dmitryax deleted the add-resource-entities-section branch June 5, 2025 19:49
@carlosalberto carlosalberto mentioned this pull request Jun 6, 2025
github-merge-queue bot pushed a commit that referenced this pull request Jun 12, 2025
### Metrics

- Prometheus receiver can expect `otel_scope_schema_url` and
`otel_scope_[attribute]` labels on all metrics.

([#4505](#4505))
- Prometheus receiver no longer expects `otel_scope_info` metric.

([#4505](#4505))
- Prometheus exporter adds `otel_scope_schema_url` and
`otel_scope_[attribute]` labels on all metrics.

([#4505](#4505))
- Prometheus exporter no longer exports `otel_scope_info` metric.

([#4505](#4505))

### Entities

- Define rules for setting identifying attributes.

([#4498](#4498))
- Define rules for entity-resource referencing model.

([#4499](#4499))

### Common

- Move Instrumentation Scope definition from glossary to a dedicated
document and use normative language.

([#4488](#4488))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Entities] Overlapping attribute names in different entity types

5 participants