Skip to content

Add supplementary guidelines for SDK self-observability#5135

Open
cijothomas wants to merge 17 commits into
open-telemetry:mainfrom
cijothomas:cijothomas/self-observability-supplementary-guidelines
Open

Add supplementary guidelines for SDK self-observability#5135
cijothomas wants to merge 17 commits into
open-telemetry:mainfrom
cijothomas:cijothomas/self-observability-supplementary-guidelines

Conversation

@cijothomas

@cijothomas cijothomas commented Jun 5, 2026

Copy link
Copy Markdown
Member

Adds non-normative supplementary guidelines covering lifecycle ordering, avoiding telemetry-induced-telemetry loops, and stability handling for SDK self-observability.

Towards #5128. Follow-up to #5087.

Comment thread specification/self-observability-supplementary-guidelines.md
Comment thread specification/self-observability-supplementary-guidelines.md
Comment thread specification/self-observability-supplementary-guidelines.md Outdated
- Note that explicit + global-fallback is a valid combined acquisition pattern

- Reframe telemetry-induced-telemetry loops as primarily a logs/traces concern
Comment thread specification/self-observability-supplementary-guidelines.md
Comment thread specification/self-observability-supplementary-guidelines.md
Comment thread specification/self-observability-supplementary-guidelines.md
Comment thread specification/self-observability-supplementary-guidelines.md
@cijothomas cijothomas requested a review from a team as a code owner June 8, 2026 23:36

@dashpole dashpole left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds a new non-normative “supplementary guidelines” document to expand the SDK self-observability guidance introduced in self-observability.md, and wires it into the existing docs and changelog.

Changes:

  • Add specification/self-observability-supplementary-guidelines.md with implementation guidance on lifecycle ordering, avoiding telemetry loops, and stability handling.
  • Link the supplementary guidelines from specification/self-observability.md.
  • Add an Unreleased changelog entry for the new supplementary guidelines document.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
specification/self-observability.md Adds a pointer to the new supplementary guidelines document.
specification/self-observability-supplementary-guidelines.md Introduces the new non-normative guidance document for SDK implementers.
CHANGELOG.md Records the addition under “Supplementary Guidelines” in Unreleased.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread specification/self-observability-supplementary-guidelines.md Outdated
Comment thread specification/self-observability-supplementary-guidelines.md Outdated

@pellared pellared left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nit: can we just use "events" consistently?

Comment thread specification/self-observability-supplementary-guidelines.md Outdated
Comment thread specification/self-observability-supplementary-guidelines.md Outdated
Comment thread specification/self-observability-supplementary-guidelines.md Outdated
Comment thread specification/self-observability-supplementary-guidelines.md
cijothomas and others added 5 commits June 10, 2026 14:01

@pellared pellared left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Issue #5128 asked for a few topics this PR does not really cover: startup configuration event/log and schema URL / telemetry versioning guidance. Since the PR says "Fixes #5128", I’d either add short sections for those, or explicitly say they are deferred/follow-up. We can also change to "Towards #5128". Otherwise the doc is good, but the issue closure may feel a little broader than the actual content.

It would be probably good to describe something like a "lazy provider" in a separate PR.

Comment thread specification/self-observability-supplementary-guidelines.md Outdated
Comment thread specification/self-observability-supplementary-guidelines.md Outdated
@jack-berg jack-berg self-assigned this Jun 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants