forked from fastapi/full-stack-fastapi-template
-
Notifications
You must be signed in to change notification settings - Fork 0
feat(frontend): propagate trace context via OpenAPI interceptor #16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ncolesummers
wants to merge
6
commits into
master
Choose a base branch
from
codex/issue-6-trace-context-propagation
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
a581cf8
✨ feat(frontend): propagate trace context via OpenAPI interceptor
uidaho-nsummers 7acec1b
📝 docs(observability): document OpenAPI trace propagation pattern
uidaho-nsummers c99429d
✨ feat(routes): add root path to FileRoutesByFullPath and update full…
uidaho-nsummers 9429dba
♻️ refactor(telemetry): centralize trace header propagation in interc…
uidaho-nsummers 70789a2
✅ test(observability): assert traceparent on frontend API requests
uidaho-nsummers 2c8b3ab
📝 docs(observability): clarify interceptor-only header injection
uidaho-nsummers File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| import { context, propagation } from "@opentelemetry/api" | ||
| import type { AxiosRequestConfig } from "axios" | ||
| import { OpenAPI } from "./client" | ||
|
|
||
| let traceContextInterceptorRegistered = false | ||
|
|
||
| const toHeaderRecord = ( | ||
| headers: AxiosRequestConfig["headers"], | ||
| ): Record<string, string> => { | ||
| if (!headers) { | ||
| return {} | ||
| } | ||
|
|
||
| const maybeAxiosHeaders = headers as { | ||
| toJSON?: () => Record<string, unknown> | ||
| } | ||
| const serializedHeaders = | ||
| typeof maybeAxiosHeaders.toJSON === "function" | ||
| ? maybeAxiosHeaders.toJSON() | ||
| : (headers as Record<string, unknown>) | ||
|
|
||
| return Object.fromEntries( | ||
| Object.entries(serializedHeaders) | ||
| .filter(([, value]) => value !== undefined && value !== null) | ||
| .map(([key, value]) => [key, String(value)]), | ||
| ) | ||
| } | ||
|
|
||
| export const traceContextInterceptor = ( | ||
| config: AxiosRequestConfig, | ||
| ): AxiosRequestConfig => { | ||
| const traceHeaders: Record<string, string> = {} | ||
| propagation.inject(context.active(), traceHeaders) | ||
|
|
||
| if (Object.keys(traceHeaders).length === 0) { | ||
| return config | ||
| } | ||
|
|
||
| config.headers = { | ||
| ...toHeaderRecord(config.headers), | ||
| ...traceHeaders, | ||
| } | ||
|
|
||
| return config | ||
| } | ||
|
|
||
| export const registerTraceContextInterceptor = (): void => { | ||
| if (traceContextInterceptorRegistered) { | ||
| return | ||
| } | ||
|
|
||
| OpenAPI.interceptors.request.use(traceContextInterceptor) | ||
| traceContextInterceptorRegistered = true | ||
| } | ||
|
ncolesummers marked this conversation as resolved.
|
||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| import { expect, test } from "@playwright/test" | ||
|
|
||
| const TRACEPARENT_PATTERN = /^00-[0-9a-f]{32}-[0-9a-f]{16}-0[0-3]$/ | ||
|
|
||
| test("API requests include a W3C traceparent header", async ({ page }) => { | ||
| const observedTraceparents = new Set<string>() | ||
|
|
||
| page.on("request", (request) => { | ||
| if (!request.url().includes("/api/v1/")) { | ||
| return | ||
| } | ||
|
|
||
| const traceparent = request.headers().traceparent | ||
| if (traceparent) { | ||
| observedTraceparents.add(traceparent) | ||
| } | ||
| }) | ||
|
|
||
| await page.goto("/") | ||
| await page.waitForResponse( | ||
| (response) => | ||
| response.url().includes("/api/v1/users/me") && response.status() === 200, | ||
| ) | ||
|
|
||
| expect(observedTraceparents.size).toBeGreaterThan(0) | ||
| for (const traceparent of observedTraceparents) { | ||
| expect(traceparent).toMatch(TRACEPARENT_PATTERN) | ||
| } | ||
| }) |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.