Skip to main content

Module diagnostics

Module diagnostics 

Source
Expand description

JSON snapshots for investigating rooms, participants and workers.

Each route in diagnostics::route accepts GET and returns 200 OK JSON on success. The response types document their fields.

RequestResponse
/internal/diagnostics/summarydiagnostics::DiagnosticsSummaryResponse
/internal/diagnostics/roomsArray of diagnostics::DiagnosticsRoomSummary
/internal/diagnostics/workersArray of diagnostics::DiagnosticsWorkerSummary
/internal/diagnostics/rooms/{uuid}diagnostics::DiagnosticsRoomDetail
/internal/diagnostics/rooms/{uuid}/usersArray of diagnostics::DiagnosticsUserSummary
/internal/diagnostics/rooms/{uuid}/users/{id}diagnostics::DiagnosticsUserDetail

Use uuid from the rooms response and userKey from the room users response. userId may be a number or string, while userKey is always the string for {id}. URL-encode both path values.

GET /internal/diagnostics/summary HTTP/1.1
Host: o-sfu-observability.internal
Authorization: Bearer <diagnostics-token>
Accept: application/json

Wire names use camelCase unless a field documents an exception. User detail is room-scoped because the same user key can be active in several rooms.

Modules§

route
Diagnostics GET routes.

Structs§

DiagnosticsRoomDetail
DiagnosticsRoomSummary
DiagnosticsSummaryResponse
DiagnosticsUserDetail
DiagnosticsUserSummary
DiagnosticsWorkerSummary