Skip to content

docs(observability): extract multi-tenant tracing into its own page#487

Open
yucheng-berri wants to merge 1 commit into
mainfrom
litellm_multi_tenant_tracing_docs
Open

docs(observability): extract multi-tenant tracing into its own page#487
yucheng-berri wants to merge 1 commit into
mainfrom
litellm_multi_tenant_tracing_docs

Conversation

@yucheng-berri

Copy link
Copy Markdown
Contributor

Summary

Extracts the multi-tenant trace destinations material out of the OpenTelemetry v2 guide onto a dedicated page: Observability, OpenTelemetry, Multi-Tenant Tracing. Reworks the story around a proxy admin who provisions destinations and a team admin who assigns them, with richer screenshots of the actual UI flow.

The OpenTelemetry v2 guide keeps a short pointer to the new page.

What changed

docs/observability/multi_tenant_tracing.md is new. It covers:

  • The two roles (proxy admin, team admin) and how a request resolves at fan-out time
  • Step 1: proxy admin creates a destination (UI screenshot of the Add Logging Callback modal with Global, Teams, Organizations, and Auto-enable controls). API equivalent in a collapsed section.
  • Step 2: team admin assigns the destination (UI screenshot of the scoped Logging Exporters picker; note that destinations scoped to other teams are absent server-side)
  • Step 3: traces fan out automatically once the assignment is in place
  • Role reference tab-set: proxy admin (sees everything, with Mode and Scope columns), team admin (scoped view), org admin (org-level scope), internal user (403)
  • auto_enable vs manual assignment matrix, since these two independent controls are the biggest source of confusion. Includes the tooltip screenshot that appears in the destinations table
  • Supported backends and the credential_info.description values that map to each
  • store_model_in_db requirement under general_settings so destinations survive a restart, with a caveat that placing it under litellm_settings is silently ignored

On docs/observability/opentelemetry_v2.md, the old 126-line multi-tenant section shrinks to a two-line pointer. The two otel_v2_destination_* screenshots that used to live under it are removed (superseded by the new ones on the extracted page).

Screenshots

Six screenshots on the new page, all cropped and secret-free:

  • Add Logging Callback modal with Access controls
  • Admin's list of all destinations (Mode and Scope columns)
  • Auto-enabled tooltip that appears in the destinations table
  • Team admin's scoped view of the destinations table
  • Team admin's Logging Exporters picker on team Settings
  • Org admin's scoped view

Verification

Rendered locally with the Docusaurus dev server. Both the new page and the trimmed OpenTelemetry v2 guide compile clean, return 200, and every image reference resolves to a real file. The sidebar now shows Multi-Tenant Tracing under Observability, OpenTelemetry, sitting after the migration guide and the v2 and v1 pages.

Move the multi-tenant destinations material off the OpenTelemetry v2 guide
onto a dedicated page under Observability > OpenTelemetry > Multi-Tenant
Tracing, with richer screenshots of the admin destination modal, the team
admin picker, and the scoped views for team and org admins. Add the auto_enable
vs manual-assignment matrix and the store_model_in_db config requirement.

The main OTel v2 guide keeps a short pointer to the new page. Drop the two
otel_v2_destination_* screenshots that are superseded by the new ones.
@vercel

vercel Bot commented Jul 5, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
litellm Ready Ready Preview, Comment Jul 5, 2026 12:24am

Request Review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant