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

Commit

Permalink
Generate toc.
Browse files Browse the repository at this point in the history
  • Loading branch information
jsuereth committed Aug 30, 2024
1 parent ec469b4 commit 7a900c9
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions text/entities/0264-resource-and-entities.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,51 @@ It is an expansion on the [previous entity proposal](0256-entities-data-model.md

<!-- toc -->

- [Motivation](#motivation)
- [Design](#design)
* [Approach - Resource Improvements](#approach---resource-improvements)
+ [Resource Coordinator](#resource-coordinator)
+ [Entity Detector](#entity-detector)
+ [Entity Merging and Resource](#entity-merging-and-resource)
+ [Environment Variable Detector](#environment-variable-detector)
* [Interactions with OpenTelemetry Collector](#interactions-with-opentelemetry-collector)
- [Datamodel Changes](#datamodel-changes)
* [Resource](#resource)
* [ResourceEntityRef](#resourceentityref)
- [How this proposal solves the problems that motivated it](#how-this-proposal-solves-the-problems-that-motivated-it)
* [Problem 1: Commingling of Entities](#problem-1-commingling-of-entities)
* [Problem 2: Lack of Precise Identity](#problem-2-lack-of-precise-identity)
* [Problem 3: Lack of Mutable Attributes](#problem-3-lack-of-mutable-attributes)
* [Problem 4: Metric Cardinality Problem](#problem-4-metric-cardinality-problem)
- [Entity WG Rubric](#entity-wg-rubric)
* [Resource detectors (soon to be entity detectors) need to be composable / disjoint](#resource-detectors-soon-to-be-entity-detectors-need-to-be-composable--disjoint)
* [New entities added by extension should not break existing code](#new-entities-added-by-extension-should-not-break-existing-code)
* [Navigational attributes need to exist and can be used to identify an entity but could be augmented with UUID or other aspects. - Having ONLY a UUID for entity identification is not good enough](#navigational-attributes-need-to-exist-and-can-be-used-to-identify-an-entity-but-could-be-augmented-with-uuid-or-other-aspects---having-only-a-uuid-for-entity-identification-is-not-good-enough)
* [Collector augmentation / enrichment (resource, e.g.) - Should be extensible and not hard-coded. We need a general algorithm not specific rulesets](#collector-augmentation--enrichment-resource-eg---should-be-extensible-and-not-hard-coded-we-need-a-general-algorithm-not-specific-rulesets)
* [Users are expected to provide / prioritize "detectors" and determine which entity is "producing" or most-important for a signal](#users-are-expected-to-provide--prioritize-detectors-and-determine-which-entity-is-producing-or-most-important-for-a-signal)
* [For an SDK - ALL telemetry should be associated with the same set of entities (resource labels)](#for-an-sdk---all-telemetry-should-be-associated-with-the-same-set-of-entities-resource-labels)
- [Open Questions](#open-questions)
* [How to attach Entity "bundle" information in Resource?](#how-to-attach-entity-bundle-information-in-resource)
* [How to deal with Resource/Entities whose lifecycle does not match the SDK?](#how-to-deal-with-resourceentities-whose-lifecycle-does-not-match-the-sdk)
* [How to deal with Prometheus Compatibility for non-SDK telemetry?](#how-to-deal-with-prometheus-compatibility-for-non-sdk-telemetry)
* [Should entities have a domain?](#should-entities-have-a-domain)
* [Should resources have only one associated entity?](#should-resources-have-only-one-associated-entity)
* [What identity should entities use (LID, UUID / GUID, or other)?](#what-identity-should-entities-use-lid-uuid--guid-or-other)
* [What happens if existing Resource translation in the collector remove resource attributes an Entity relies on?](#what-happens-if-existing-resource-translation-in-the-collector-remove-resource-attributes-an-entity-relies-on)
* [What about advanced entity interaction in the Collector?](#what-about-advanced-entity-interaction-in-the-collector)
- [Trade-offs and mitigations](#trade-offs-and-mitigations)
- [Prior art and alternatives](#prior-art-and-alternatives)
- [Future Posibilities](#future-posibilities)
- [Use Cases](#use-cases)
* [SDK - Multiple Detectors of the same Entity type](#sdk---multiple-detectors-of-the-same-entity-type)
* [SDK and Collector - Simple coordination](#sdk-and-collector---simple-coordination)
* [SDK and Collector - Entity coordination with descriptive attributes](#sdk-and-collector---entity-coordination-with-descriptive-attributes)
* [SDK and Collector - Entity coordination with conflicts](#sdk-and-collector---entity-coordination-with-conflicts)
* [SDK and Collector - Entity coordination across versions](#sdk-and-collector---entity-coordination-across-versions)
- [Collection of Resource detectors and attributes used](#collection-of-resource-detectors-and-attributes-used)
* [Implications](#implications)
* [What could this mean for chosing entities that belong on resource?](#what-could-this-mean-for-chosing-entities-that-belong-on-resource)

<!-- tocstop -->

## Motivation
Expand Down

0 comments on commit 7a900c9

Please sign in to comment.