Skip to content

Add EntityRef and use it in Resource.#635

Merged
jsuereth merged 5 commits intoopen-telemetry:mainfrom
jsuereth:wip-entities-for-resource
Mar 28, 2025
Merged

Add EntityRef and use it in Resource.#635
jsuereth merged 5 commits intoopen-telemetry:mainfrom
jsuereth:wip-entities-for-resource

Conversation

@jsuereth
Copy link
Copy Markdown
Contributor

@jsuereth jsuereth commented Mar 6, 2025 •
edited
Loading

As per OTEP 264 - This is the proposal for representing "Entity" in OTLP.

  • Adds a new EntityRef message where an Entity is an object of interest in observability.
    • Entity has a type (e.g. host, k8s.pod, service).
    • Entity has a set of identifying attributes (these contribute to signal identity)
    • Entity has a set of descriptive attirbutes (these are used to aide signal retreival/querying).
    • Entity can be defined and versioned (e.g. semantic conventions via schema_url).
  • Adds a new entity_refs field to Resource that allows distinguishing which key-value pairs in Resource come from which reported Entity.

Please read the OTEP for details and rationale behind this protocol design. High level this meant to be:

  • Sufficient to represent entities
  • Non-breaking for all OpenTelemetry users.

Prototypes using this protocol

@jsuereth jsuereth requested a review from a team March 6, 2025 17:20
@jsuereth jsuereth moved this to In Progress in Entities: Phase 1 Mar 6, 2025
dmitryax
dmitryax approved these changes Mar 6, 2025
View reviewed changes
Comment thread opentelemetry/proto/common/v1/common.proto
@jsuereth jsuereth mentioned this pull request Mar 6, 2025
Merged
Kielek
Kielek reviewed Mar 17, 2025
View reviewed changes
Comment thread opentelemetry/proto/common/v1/common.proto
smith
smith approved these changes Mar 17, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@smith smith left a comment

Choose a reason for hiding this comment

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

Looks good; just a few suggestions for comment changes.

Comment thread opentelemetry/proto/common/v1/common.proto Outdated
Comment thread opentelemetry/proto/common/v1/common.proto Outdated
Comment thread opentelemetry/proto/resource/v1/resource.proto Outdated
jack-berg
jack-berg reviewed Mar 17, 2025
View reviewed changes
Comment thread opentelemetry/proto/resource/v1/resource.proto
jsuereth and others added 3 commits March 18, 2025 12:17
@jsuereth @smith
Update opentelemetry/proto/resource/v1/resource.proto
5a96880 
Co-authored-by: Nathan L Smith <nathan.smith@elastic.co>
@jsuereth @smith
Update opentelemetry/proto/common/v1/common.proto
95e154b 
Co-authored-by: Nathan L Smith <nathan.smith@elastic.co>
@jsuereth @smith
Update opentelemetry/proto/common/v1/common.proto
0a24a63 
Co-authored-by: Nathan L Smith <nathan.smith@elastic.co>
@jsuereth jsuereth merged commit e4fd4f6 into open-telemetry:main Mar 28, 2025
15 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Entities: Phase 1 Mar 28, 2025
@jsuereth jsuereth deleted the wip-entities-for-resource branch March 28, 2025 17:13
jsuereth added a commit to open-telemetry/opentelemetry-specification that referenced this pull request Apr 10, 2025
@jsuereth @dyladan
@smith @kamphaus
Create initial Entities data model specification. (#4442)
9f80317 
Adds an initial cut at the Entity DataModel specification from OTEP 256.

## Changes

- Adds information to Resource readme.
- Creates an initial Resource DataModel with content from Entities SIG
discussions on purpose and usage or Resource.
- Creates an `entities` diretory for storing Entities DataModel.

See open-telemetry/opentelemetry-proto#635 for
related protocol change.

Prototypes:

- java: open-telemetry/opentelemetry-java#6855
- collector:
open-telemetry/opentelemetry-collector#11958
- go: open-telemetry/opentelemetry-go#5918

---------

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>
Co-authored-by: Nathan L Smith <nathan.smith@elastic.co>
Co-authored-by: Christophe Kamphaus <christophe.kamphaus@gmail.com>
@smith smith mentioned this pull request Apr 18, 2025
Closed
6 tasks
@MrAlias MrAlias mentioned this pull request Apr 29, 2025
Merged
@lalitb lalitb mentioned this pull request May 2, 2025
Merged
4 tasks
@AllexVeldman AllexVeldman mentioned this pull request May 27, 2025
Merged
dmitryax added a commit to dmitryax/opentelemetry-collector that referenced this pull request Jun 24, 2025
@dmitryax
[pdata] Add support for the new resource-entity refences in xpdata
6912ab0 
Add support for the new resource-entity reference API added to the proto as part of open-telemetry/opentelemetry-proto#635.

This required moving CopyTo implementation to the internal package for the structures that are used by other packages
@dmitryax dmitryax mentioned this pull request Jun 24, 2025
Merged
dmitryax added a commit to dmitryax/opentelemetry-collector that referenced this pull request Jun 24, 2025
@dmitryax
[pdata] Add support for the new resource-entity refences in xpdata
113ab6b 
Add support for the new resource-entity reference API added to the proto as part of open-telemetry/opentelemetry-proto#635.

This required moving CopyTo implementation to the internal package for the structures that are used by other packages
dmitryax added a commit to dmitryax/opentelemetry-collector that referenced this pull request Jun 24, 2025
@dmitryax
[pdata] Add support for the new resource-entity refences in xpdata
94e027e 
Add support for the new resource-entity reference API added to the proto as part of open-telemetry/opentelemetry-proto#635.

This required moving CopyTo implementation to the internal package for the structures that are used by other packages
dmitryax added a commit to dmitryax/opentelemetry-collector that referenced this pull request Jun 27, 2025
@dmitryax
[pdata] Add support for the new resource-entity refences in xpdata
adae557 
Add support for the new resource-entity reference API added to the proto as part of open-telemetry/opentelemetry-proto#635.

This required moving CopyTo implementation to the internal package for the structures that are used by other packages
dmitryax added a commit to dmitryax/opentelemetry-collector that referenced this pull request Jun 27, 2025
@dmitryax
[pdata] Add support for the new resource-entity refences in xpdata
284287b 
Add support for the new resource-entity reference API added to the proto as part of open-telemetry/opentelemetry-proto#635.

This required moving CopyTo implementation to the internal package for the structures that are used by other packages
dmitryax added a commit to dmitryax/opentelemetry-collector that referenced this pull request Jun 30, 2025
@dmitryax
[pdata] Add support for the new resource-entity refences in xpdata
cddea6a 
Add support for the new resource-entity reference API added to the proto as part of open-telemetry/opentelemetry-proto#635.

This required moving CopyTo implementation to the internal package for the structures that are used by other packages
dmitryax added a commit to dmitryax/opentelemetry-collector that referenced this pull request Jul 1, 2025
@dmitryax
[pdata] Add support for the new resource-entity references in xpdata
e91922d 
Add support for the new resource-entity reference API added to the proto as part of open-telemetry/opentelemetry-proto#635.

This required moving CopyTo implementation to the internal package for the structures that are used by other packages
dmitryax added a commit to dmitryax/opentelemetry-collector that referenced this pull request Jul 2, 2025
@dmitryax
[pdata] Add support for the new resource-entity references in xpdata
770f58c 
Add support for the new resource-entity reference API added to the proto as part of open-telemetry/opentelemetry-proto#635.

This required moving CopyTo implementation to the internal package for the structures that are used by other packages
github-merge-queue Bot pushed a commit to open-telemetry/opentelemetry-collector that referenced this pull request Jul 2, 2025
@dmitryax
[pdata] Add support for the new resource-entity references in xpdata (#…
08d9627 
…13264)

Add support for the new resource-entity reference API added to the proto
as part of
open-telemetry/opentelemetry-proto#635.

The API is separated into the experimental xpdata module since the new
entity related protobuf definitions are in development

This is the first step towards adopting Entities in Collector which was
drafted in
#11958
github-merge-queue Bot pushed a commit to open-telemetry/opentelemetry-collector that referenced this pull request Jul 2, 2025
@dmitryax
[pdata] Add support for the new resource-entity references in xpdata (#…
627e36f 
…13264)

Add support for the new resource-entity reference API added to the proto
as part of
open-telemetry/opentelemetry-proto#635.

The API is separated into the experimental xpdata module since the new
entity related protobuf definitions are in development

This is the first step towards adopting Entities in Collector which was
drafted in
#11958
@dmitryax dmitryax mentioned this pull request Jul 3, 2025
Open
@dmitryax dmitryax mentioned this pull request Feb 25, 2026
Closed
@dmitryax dmitryax mentioned this pull request Mar 12, 2026
Open
@jmacd jmacd mentioned this pull request Apr 7, 2026
Open
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@carlosalberto carlosalberto carlosalberto approved these changes

@bogdandrutu bogdandrutu bogdandrutu approved these changes

@dyladan dyladan dyladan approved these changes

@jack-berg jack-berg jack-berg approved these changes

+3 more reviewers

@dmitryax dmitryax dmitryax approved these changes

@smith smith smith approved these changes

@Kielek Kielek Kielek approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

Entities: Phase 1
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@jsuereth @smith @carlosalberto @bogdandrutu @dyladan @Kielek @dmitryax @jack-berg