Skip to content
This repository has been archived by the owner on Dec 6, 2024. It is now read-only.

Initial Entity and Resource proposal. #264

Merged
merged 52 commits into from
Sep 26, 2024
Merged
Changes from 1 commit
Commits
Show all changes
52 commits
Select commit Hold shift + click to select a range
1eba75b
Initial Entity and Resource proposal.
jsuereth Aug 13, 2024
fbf4b09
Rename OTEP to match PR reservation number.
jsuereth Aug 13, 2024
245b7aa
Spellcheck.
jsuereth Aug 13, 2024
72a67ad
More spellcheck.
jsuereth Aug 13, 2024
e3a3de0
Remove accidental readdition of template file.
jsuereth Aug 13, 2024
64c6b15
Some lint fixes.
jsuereth Aug 13, 2024
2057fa4
More lint fixes.
jsuereth Aug 13, 2024
7dd3c5d
Fix more lint.
jsuereth Aug 13, 2024
76df4d0
Fix spellcheck issue.
jsuereth Aug 14, 2024
38c237f
Outline prometheus path forward.
jsuereth Aug 14, 2024
78e3b41
Fix spelling.
jsuereth Aug 14, 2024
0ddcf23
Update capitalization of resource.
jsuereth Aug 14, 2024
090b817
Add link to prometheus compatibility doc.
jsuereth Aug 14, 2024
3eb9339
Update text/entities/0264-resource-and-entities.md
jsuereth Aug 14, 2024
1fec84c
Updates to address some comments.
jsuereth Aug 20, 2024
5cbc0d5
Add use case to check rendering on github.
jsuereth Aug 22, 2024
d4f2965
Update text/entities/0264-resource-and-entities.md
jsuereth Aug 22, 2024
1faf62f
Fix from review.
jsuereth Aug 22, 2024
7fb267f
Add link to previous proposal
jsuereth Aug 22, 2024
b6c7ef9
Add more examples.
jsuereth Aug 26, 2024
d40f1e0
Add last use case.
jsuereth Aug 26, 2024
f679af2
Fix mermaid diagram syntax.
jsuereth Aug 26, 2024
22ac1fa
Update merge algorithm based on feedback.
jsuereth Aug 27, 2024
1555b42
Fix descriptive attribute merge description.
jsuereth Aug 28, 2024
b567974
Add a survey of existing resource attributes detected and how they ar…
jsuereth Aug 28, 2024
af0165d
Add some analysis of bundled entities from detection.
jsuereth Aug 28, 2024
26de765
Add go survey of resource attributes.
jsuereth Aug 28, 2024
dc95ee9
Add litmus test for when to include an entity on a resource.
jsuereth Aug 28, 2024
c1c1eeb
Add one open question from WG.
jsuereth Aug 29, 2024
41c4d6e
Fix typo.
jsuereth Aug 29, 2024
0bc047b
Fix link issue.
jsuereth Aug 29, 2024
ec469b4
Fix lint issues.
jsuereth Aug 29, 2024
7a900c9
Generate toc.
jsuereth Aug 30, 2024
43454e2
Fix algorithm to account for existing schema url.
jsuereth Sep 10, 2024
775bb30
Add clarification on entity detector API.
jsuereth Sep 11, 2024
8d9a12e
Add definition of platform.
jsuereth Sep 11, 2024
061808c
Fix typo and clarify.
jsuereth Sep 11, 2024
a3052af
Fixes from review.
jsuereth Sep 13, 2024
5bc6120
Rename Resource Coordinator to Resource Provider.
jsuereth Sep 13, 2024
f3395fb
Fixes from review.
jsuereth Sep 16, 2024
792124a
Fix typo.
jsuereth Sep 17, 2024
818d666
Add call out about offline usage.
jsuereth Sep 17, 2024
5793f36
Add resource identity section.
jsuereth Sep 17, 2024
a55d61e
Regenerate TOC.
jsuereth Sep 17, 2024
408862a
Fix spelling error.
jsuereth Sep 17, 2024
4010a33
Add some more options for Prometheus compatibility.
jsuereth Sep 17, 2024
0ee5dc8
Fix spelling issue.
jsuereth Sep 17, 2024
7c9e529
Update prometheus proposals based on discussions.
jsuereth Sep 19, 2024
36234ff
Update proposal with result of discussions.
jsuereth Sep 19, 2024
67f9389
Update text/entities/0264-resource-and-entities.md
jsuereth Sep 19, 2024
48b9517
Update text/entities/0264-resource-and-entities.md
jsuereth Sep 20, 2024
caf2f37
Merge branch 'main' into wip/entities-and-resource
jsuereth Sep 26, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add resource identity section.
jsuereth committed Sep 17, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit 5793f366d4bf0eb4e41b4ac87e5f28f7c7eb1570
13 changes: 13 additions & 0 deletions text/entities/0264-resource-and-entities.md
Original file line number Diff line number Diff line change
@@ -221,6 +221,19 @@ The entityref data model, would have the following changes from the original [en
| identifying_attributes_keys | repeated string | Attribute Keys that identify the entity.<br/>MUST not change during the lifetime of the entity. The Id must contain at least one attribute.<br/><br/>These keys MUST exists in Resource.attributes.<br/><br/>Follows OpenTelemetry common attribute definition. SHOULD follow OpenTelemetry semantic conventions for attributes.| now a reference |
tigrannajaryan marked this conversation as resolved.
Show resolved Hide resolved
jsuereth marked this conversation as resolved.
Show resolved Hide resolved
| descriptive_attributes_keys | repeated string | Descriptive (non-identifying) attribute keys of the entity.<br/>MAY change over the lifetime of the entity. MAY be empty. These attribute keys are not part of entity's identity.<br/><br/>These keys MUST exist in Resource.attributes.<br/><br/>Follows any value definition in the OpenTelemetry spec - it can be a scalar value, byte array, an array or map of values. Arbitrary deep nesting of values for arrays and maps is allowed.<br/><br/>SHOULD follow OpenTelemetry semantic conventions for attributes.| now a reference |
jsuereth marked this conversation as resolved.
Show resolved Hide resolved
jsuereth marked this conversation as resolved.
Show resolved Hide resolved

### Resource Identity

OpenTelemetry resource identity will be modified as follows:

- When `entities` is empty on resource, then its identity is the collection
of all `attributes` (both key and values).
- When `entities` is non-empty on resource, then its identity is the collection
of all `attributes` where the key is found in `entities.identify_attribute_keys`.
jsuereth marked this conversation as resolved.
Show resolved Hide resolved

When grouping or mixing OTLP data, you can detect if two resources are the same
using its identity and merge descriptive attributes (if applicable) using the
entity merge algorithm (described above) which will be formalized in the data model.

## How this proposal solves the problems that motivated it

Let's look at some motivating problems from the [Entities Proposal](https://docs.google.com/document/d/1VUdBRInLEhO_0ABAoiLEssB1CQO_IcD5zDnaMEha42w/edit#heading=h.atg5m85uw9w8):