docs: add documentation for experimental browser proxy handler#1742
docs: add documentation for experimental browser proxy handler#1742AlanPonnachan wants to merge 4 commits intopydantic:mainfrom
Conversation
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
| !!! info "Securely Sending Traces" | ||
| Logfire does not directly expose an endpoint suitable for sending traces from the browser, as this would make your write token publicly accessible. | ||
|
|
||
| To safely send traces, you must route them through a backend proxy that attaches the `Authorization` header server-side. |
There was a problem hiding this comment.
the deleted "forwards requests from your browser instrumentation to Logfire" was good to have for clarity
| Logfire does not directly expose an endpoint suitable for sending traces from the browser, as this would make your write token publicly accessible. | ||
|
|
||
| To safely send traces, you must route them through a backend proxy that attaches the `Authorization` header server-side. | ||
| - **Python:** Use the built-in `logfire_proxy` handler for [FastAPI](../web-frameworks/fastapi.md#proxying-browser-telemetry) or [Starlette](../web-frameworks/starlette.md#proxying-browser-telemetry). |
There was a problem hiding this comment.
the forward_export_request function is worth mentioning for generic usage.
| It can also be useful for grouping together child logs and spans produced by the request. | ||
|
|
||
|
|
||
| ## Proxying Browser Telemetry |
There was a problem hiding this comment.
i don't think this belongs on this page, same for starlette. it's not about how to instrument fastapi. i think the browser page should get a proper section on the topic with this info, explaining how to do it with fastapi, starlette, or anything else. the fastapi and starlette pages can briefly mention and link to that.
2 participants
Summary
This PR adds the documentation for the newly merged experimental browser proxy handler (
logfire.experimental.forwarding.logfire_proxy) introduced in #1697.It bridges the gap between frontend browser telemetry and Python backends by explaining how to securely route OTLP payloads to Logfire without exposing the Write Token in the client-side code.
Changes Made
docs/integrations/javascript/browser.md:url.pathname = "/logfire-proxy/v1/traces".docs/integrations/web-frameworks/fastapi.md:@app.postwhile injecting theRequestobject.Depends(addressing security considerations discussed in the previous PR).docs/integrations/web-frameworks/starlette.md:Route.