Skip to content

docs: clarify resource describes observed entity, not telemetry emitter#4905

Merged
jsuereth merged 2 commits intoopen-telemetry:mainfrom
svencowart:clarify-resource-definition
Mar 16, 2026
Merged

docs: clarify resource describes observed entity, not telemetry emitter#4905
jsuereth merged 2 commits intoopen-telemetry:mainfrom
svencowart:clarify-resource-definition

Conversation

@svencowart
Copy link
Contributor

@svencowart svencowart commented Feb 26, 2026

Fixes #4903

Changes

Disambiguates the Resource definition to account for auto-instrumentation scenarios (e.g., eBPF agents) where the technical producer of telemetry differs from the entity being observed.

  • specification/resource/README.md: reframe definition as "entity for which telemetry is being produced"; add NOTE callout explaining that Resource MUST describe the observed workload in agent-based instrumentation, with guidance on telemetry.sdk.name / telemetry.distro.name
  • specification/resource/data-model.md: align definition language; explicitly note the observed entity vs. emitter distinction
  • specification/resource/sdk.md: same alignment for the SDK spec
  • specification/logs/data-model.md: update table description from "source of the log" to "observed entity that generated the log"

@svencowart svencowart requested review from a team as code owners February 26, 2026 21:37
@svencowart svencowart force-pushed the clarify-resource-definition branch from 38a63d1 to aedda40 Compare February 26, 2026 23:39
@pellared
Copy link
Member

pellared commented Mar 2, 2026

@svencowart, could you please add a changelog entry?

@pellared pellared added clarification clarify ambiguity in specification spec:resource Related to the specification/resource directory labels Mar 2, 2026
Disambiguates the Resource definition to account for auto-instrumentation
scenarios (e.g., eBPF agents) where the technical producer of telemetry
differs from the entity being observed.

- specification/resource/README.md: reframe definition as "entity for
  which telemetry is being produced"; add NOTE callout explaining that
  Resource MUST describe the observed workload in agent-based
  instrumentation, with guidance on telemetry.sdk.name / telemetry.distro.name
- specification/resource/data-model.md: align definition language;
  explicitly note the observed entity vs. emitter distinction
- specification/resource/sdk.md: same alignment for the SDK spec
- specification/logs/data-model.md: update table description from
  "source of the log" to "observed entity that generated the log"
@svencowart svencowart force-pushed the clarify-resource-definition branch from aedda40 to 8a637d6 Compare March 2, 2026 17:06
@svencowart
Copy link
Contributor Author

@pellared done.

@dyladan
Copy link
Member

dyladan commented Mar 11, 2026

Its both though isn't it? At least in the case of the telemetry SDK attributes they reference the SDK which is monitoring the process. Admittedly it is a bit of an odd case because the SDK is a part of the process being monitored as well.

@jsuereth jsuereth added this pull request to the merge queue Mar 16, 2026
Merged via the queue into open-telemetry:main with commit 720364f Mar 16, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clarification clarify ambiguity in specification spec:resource Related to the specification/resource directory

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify Resource definition for auto instrumentation

8 participants