Repository navigation
Open
Labels
enhancementNew feature or requestNew feature or request
Description
Problem
Backend logs and AWS X-Ray traces can't be tied to the user journeys the library records:
- No scenario id attached to the backend requests. A scenario's id links its RUM record, BI events and client logs, but requests made during the scenario carry nothing the backend can log or search by.
- Relative URLs get no X-Ray header. The RUM client checks its X-Ray rule against the URL exactly as the app passes it. Angular
HttpClientpasses relative URLs (/api/...), but the library's default rule only matches absolute same-origin URLs. So mostHttpClientrequests go out withoutX-Amzn-Trace-Id, even in a single app, and the backend can't continue the browser's trace. - Fragment requests aren't traced at all. In a micro-frontend page, the RUM client runs only in the shell and patches only the shell's
fetchandXMLHttpRequest. Each fragment (e.g. Web Fragments) runs in its own hidden iframe with its own copies of these, so its requests get no X-Ray header and no RUM HTTP events.
Proposed change
- Scenario header. Add
uwtScenarioHeaderInterceptor()anduwtScenarioContext(scenario). A request marked with a scenario gets anX-Uwt-Scenario-Id: <scenario.id>header; apps can rename it with{ headerName }. Requests are marked one by one, because several scenarios can run at once and nothing else can tell which one a request belongs to. The header is sent only on same-origin requests, only while telemetry is on, and never on unmarked requests. The interceptor only adds the header: settling the scenario stays with the caller ortraceScenario. - Relative URLs. Treat relative URLs as same-origin in the default
httptelemetry config. - Fragments. Let the shell's RUM sink trace fragments. At startup, a fragment's
'broadcast'sink hands itswindowto the shell, and the shell applies the RUM client's own fetch/XHR plugins to it. The fragment keeps its ownfetch, XHR and zone.js. The shell lets go of the window when the fragment is removed or destroyed. - Backend convention (documented). The backend logs the header as
scenarioIdand adds it to its X-Ray trace as thescenarioIdannotation, soannotation.scenarioId = "<id>"finds every trace of a journey.
Acceptance criteria
- Marked same-origin requests carry
X-Uwt-Scenario-Id. Unmarked requests, cross-origin requests, requests made while telemetry is off and server-side requests don't. - Concurrent scenarios each send their own id, and a retried request sends the same id again.
- Same-origin requests with relative URLs carry
X-Amzn-Trace-Id; cross-origin requests still don't. - Requests from a fragment using
provideUwtTelemetrySink('broadcast')carryX-Amzn-Trace-Id, with both the fetch and XHR backends. - Those requests appear as RUM HTTP and X-Ray events in the shell's session.
- A removed fragment is unpatched and not kept in memory by the shell.
- DESIGN.md and the README describe the behaviour, the backend convention and the limits.
Notes
- New public API:
uwtScenarioHeaderInterceptor,uwtScenarioContext,UwtScenarioHeaderOptionsandUWT_DEFAULT_SCENARIO_HEADER. The X-Ray changes need no changes in consumer apps. - Fragment requests count against the shared session's event budget (200 by default), the same as the shell's.
- Requests made before the shell's RUM client loads aren't traced, the same as in the shell today.
- Apps that pass their own
telemetriesconfig keep their own X-Ray rule.
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request
Activity