Docs: AI Gateway guide, web UI and reference updates#2051
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (5)
🔗 Linked repositories identifiedCodeRabbit considers these linked repositories for cross-repo context during reviews:
💤 Files with no reviewable changes (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThis PR updates AI observability and evals documentation, adds the AI Gateway reference and navigation, revises alerting and Slack setup guides, standardizes endpoint examples, and expands CLI, configuration, and comparison docs. It also refreshes FAQ, dashboard/evals guides, and product positioning copy to reflect the newer AI feature set and updated URLs. Changes
Sequence Diagram(s)Not applicable. Related Issues: Not specified in provided context. Related PRs: Not specified in provided context. Suggested labels: documentation Suggested reviewers: Not specified in provided context. 🐰 Docs now point to the newer paths and names, 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/guides/web-ui/evals.md`:
- Around line 64-67: Update the tip to make the fallback behavior of
logfire.url_from_eval(report) explicit: it should mention that this helper
returns None when the project URL or trace/span IDs are missing, rather than
always producing a comparison link. Keep the wording close to the existing
explanation in the web UI evals docs and reference logfire.url_from_eval so the
behavior is clear to readers.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 763ab66c-98bf-4a5d-a8e8-b638e14a5056
📒 Files selected for processing (31)
docs/ai-observability.mddocs/comparisons/arize-phoenix.mddocs/comparisons/braintrust.mddocs/comparisons/datadog.mddocs/comparisons/index.mddocs/comparisons/langfuse.mddocs/comparisons/langsmith.mddocs/comparisons/sentry.mddocs/comparisons/signoz.mddocs/faq.mddocs/gateway-migration.mddocs/guides/onboarding-checklist/add-manual-tracing.mddocs/guides/web-ui/alerts.mddocs/guides/web-ui/dashboards.mddocs/guides/web-ui/evals.mddocs/guides/web-ui/live.mddocs/how-to-guides/client-side-feature-flags.mddocs/how-to-guides/codex-logfire-exporter.mddocs/how-to-guides/otel-collector/host-monitoring.mddocs/how-to-guides/otel-collector/kubernetes-monitoring.mddocs/how-to-guides/query-api.mddocs/how-to-guides/setup-slack-alerts.mddocs/integrations/event-streams/airflow.mddocs/nav.jsondocs/reference/advanced/gateway/index.mddocs/reference/advanced/managed-variables/external.mddocs/reference/advanced/migrate-to-new-project.mddocs/reference/cli.mddocs/reference/configuration.mdlogfire/_internal/config_params.pymkdocs.yml
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
pydantic/pydantic(auto-detected)pydantic/pydantic-ai(auto-detected)
strawgate
force-pushed
the
claude/logfire-docs-audit-yg6c8p
branch
from
011917a to
359a735
Compare
| ### Did anything carry over from PAIG Console? | ||
|
|
||
| Not right now, but if you'd like help, email us at [engineering@pydantic.dev](mailto:engineering@pydantic.dev). | ||
| No. This was a clean start — usage history, project settings, and API keys did not transfer. You configure everything fresh on Logfire. |
There was a problem hiding this comment.
We can probably just delete this reference entirely, it's pretty old at this point and that service has been down for a while..?
There was a problem hiding this comment.
I guess probably the whole migration FAQ can go
There was a problem hiding this comment.
Done — removed the whole migration FAQ. The page now keeps just the pointer to the gateway overview, the shutdown timeline, and the "why we made this change" section, with a contact line for any outstanding refund questions.
Generated by Claude Code
strawgate
force-pushed
the
claude/logfire-docs-audit-yg6c8p
branch
from
cc5b7f3 to
cd97e37
Compare
Add a usage guide for the AI Gateway: enabling it, connecting SDKs, providers, API keys, routing groups, spending controls, and the gateway CLI. Group it with the migration page under an AI Gateway nav entry, and trim the migration page down now that the legacy shutdown date has passed. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012SoYPsGwJvndvahMWV54Gr
Document the delivery channels and schedules flow for alerts, per-panel dashboard variables, `logfire.url_from_eval()`, the remaining CLI subcommands (`whoami`, `auth logout`, `info`, `read-tokens`, `run`, `prompt`), additional configuration environment variables, and the newer `@logfire.instrument` options. Add the v4.35 query client deprecation notes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012SoYPsGwJvndvahMWV54Gr
Bring the overview, FAQ, and comparison pages up to date with the current feature set (evals in the web UI, prompt management, playground, AI gateway) and pricing units, and use the region-specific US/EU endpoints consistently across configuration examples. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012SoYPsGwJvndvahMWV54Gr
strawgate
force-pushed
the
claude/logfire-docs-audit-yg6c8p
branch
from
cd97e37 to
1c4d284
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/comparisons/signoz.md`:
- Line 50: The pricing copy is inconsistent between the summary and the detailed
section, so update the new “10M spans/logs/metrics per month” wording in the
Signoz comparison content to match the existing “10M spans free” phrasing, or
revise both so they use the same free-tier description throughout the page.
Check the pricing paragraph in the comparison doc and keep the terminology
consistent across all mentions of the free plan.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 80fd18c9-6fe6-410f-9efd-a3bbb4769bfc
📒 Files selected for processing (32)
docs/ai-observability.mddocs/comparisons/arize-phoenix.mddocs/comparisons/braintrust.mddocs/comparisons/datadog.mddocs/comparisons/index.mddocs/comparisons/langfuse.mddocs/comparisons/langsmith.mddocs/comparisons/sentry.mddocs/comparisons/signoz.mddocs/faq.mddocs/gateway-migration.mddocs/guides/onboarding-checklist/add-manual-tracing.mddocs/guides/web-ui/alerts.mddocs/guides/web-ui/dashboards.mddocs/guides/web-ui/evals.mddocs/guides/web-ui/live.mddocs/how-to-guides/client-side-feature-flags.mddocs/how-to-guides/codex-logfire-exporter.mddocs/how-to-guides/otel-collector/host-monitoring.mddocs/how-to-guides/otel-collector/kubernetes-monitoring.mddocs/how-to-guides/query-api.mddocs/how-to-guides/setup-slack-alerts.mddocs/integrations/event-streams/airflow.mddocs/nav.jsondocs/reference/advanced/gateway/index.mddocs/reference/advanced/managed-variables/external.mddocs/reference/advanced/migrate-to-new-project.mddocs/reference/cli.mddocs/reference/configuration.mddocs/why.mdlogfire/_internal/config_params.pymkdocs.yml
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
pydantic/logfire(manual)pydantic/pydantic-ai(manual)pydantic/pydantic(auto-detected)
✅ Files skipped from review due to trivial changes (24)
- logfire/_internal/config_params.py
- docs/guides/web-ui/evals.md
- docs/why.md
- docs/reference/advanced/migrate-to-new-project.md
- docs/comparisons/braintrust.md
- docs/reference/configuration.md
- docs/comparisons/sentry.md
- docs/reference/advanced/managed-variables/external.md
- docs/reference/cli.md
- docs/comparisons/arize-phoenix.md
- docs/guides/onboarding-checklist/add-manual-tracing.md
- docs/comparisons/langsmith.md
- docs/comparisons/langfuse.md
- docs/faq.md
- docs/guides/web-ui/dashboards.md
- docs/comparisons/datadog.md
- docs/how-to-guides/codex-logfire-exporter.md
- docs/how-to-guides/otel-collector/host-monitoring.md
- docs/how-to-guides/setup-slack-alerts.md
- docs/ai-observability.md
- docs/comparisons/index.md
- docs/how-to-guides/query-api.md
- docs/integrations/event-streams/airflow.md
- docs/guides/web-ui/alerts.md
🚧 Files skipped from review as they are similar to previous changes (4)
- docs/nav.json
- mkdocs.yml
- docs/how-to-guides/client-side-feature-flags.md
- docs/how-to-guides/otel-collector/kubernetes-monitoring.md
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012SoYPsGwJvndvahMWV54Gr
|
|
||
| !!! note "Migrating from gateway.pydantic.dev?" | ||
| The standalone Pydantic AI Gateway at `gateway.pydantic.dev` has been shut down and replaced by this integrated gateway. See [Migration from gateway.pydantic.dev](../../../gateway-migration.md). |
There was a problem hiding this comment.
I think we don't need to add references to gateway.pydantic.dev, it's long enough dead now.
There was a problem hiding this comment.
Removed in cbe3a60 — dropped the migration note admonition and de-branded the see-also link (kept the link to the migration page itself since it's still in the nav).
Generated by Claude Code
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012SoYPsGwJvndvahMWV54Gr
| --- | ||
|
|
||
| # Pydantic AI Gateway is Moving to Pydantic Logfire | ||
| # Pydantic AI Gateway Has Moved to Pydantic Logfire |
There was a problem hiding this comment.
We can keep this page to not break URLs but I think we should make it as low-visibility as possible to reduce confusion given it's so out of date now, and the original gateway.pydantic.dev wasn't long lived anyway.
There was a problem hiding this comment.
Done in 2b037a0 — the page stays at its URL but is now removed from the nav (the "AI Gateway" nav entry is just the overview page), unlinked from the overview and prompt-management docs, and marked robots: noindex (same treatment as roadmap.md).
Generated by Claude Code
Keep the page so existing URLs continue to work, but remove it from the navigation and inbound links and mark it noindex. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012SoYPsGwJvndvahMWV54Gr
3 participants
Summary
reference/advanced/gateway/index.md) covering setup, connecting SDKs, providers, API keys, routing groups, spending controls, and the gateway CLI; group it with the migration page under an "AI Gateway" nav entry, and update the migration page now that the legacy shutdown date has passed.logfire.url_from_eval(), the remaining CLI subcommands (whoami,auth logout,info,read-tokens,run,prompt), additional configuration environment variables, newer@logfire.instrumentoptions, and the v4.35 query client deprecation notes.All UI labels, SDK signatures, endpoints, plan details, and links were checked against the product and the live site.
🤖 Generated with Claude Code
https://claude.ai/code/session_012SoYPsGwJvndvahMWV54Gr
Generated by Claude Code