Repository navigation
docs: clarify correlation header configuration - #2795
Open
Aditya Reddy (adityareddy-dev) wants to merge 1 commit into
Open
Aditya Reddy (adityareddy-dev) wants to merge 1 commit into
Aditya Reddy (adityareddy-dev) wants to merge 1 commit into
Conversation
Aditya Reddy (adityareddy-dev)
requested a review
from a team
as a code owner
November 5, 2026 00:10
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
There are no active review issues for this documentation-only clarification of correlation-header configuration.
No open issues 🎉
What changed in this PR
Clarifies correlation-header configuration in the SDK documentation, addressing the confusion described in #2348. This PR changes documentation only, not runtime behavior.
Changes:
- Explains how host checks and domain/URL filters determine which requests can receive correlation headers.
- Clarifies which trace headers each distributed tracing mode adds.
- Documents that
Request-Contextrequires an availableappId.
| File | Description |
|---|---|
| shared/AppInsightsCore/src/interfaces/ai/IConfig.ts | Updates API comments for correlation settings and tracing modes. |
| README.md | Aligns configuration descriptions with header eligibility and app ID requirements. |
Review effort: Balanced
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README and API comments said correlation headers were added to every request. I clarified the host checks, exclusions, tracing mode and app ID requirement.
Related to #2348