Observability for LiveKit Inference TTS fallback (which model served the request), especially in expressive mode
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 38/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- python
- Domain
- backend-api-design, observability
Research direction
Start by reading inference/tts.py and tracing how it handles the session.created payload and populates tts_node spans, TTSModelUsage, and TTSMetrics; compare this with _record_fallback_served in tts.FallbackAdapter. The issue is done when per-request observability identifies whether a fallback served audio and which model served it, with corresponding usage attribution; the payload also identifies analogous STT fallback behavior and expressive-mode markup as related concerns.
Written by the indexing model from the issue text.
Description
Feature Type
Would make my life easier
Feature Description
We use expressive mode with an inference.TTS primary and server-side fallbacks:
tts = inference.TTS(
model="xai/tts-1",
voice="ursa",
language="ja",
fallback=[
{"model": "inworld/inworld-tts-2", "voice": "Asuka"},
{"model": "cartesia/sonic-3.6", "voice": "<voice id>"},
{"model": "google/gemini-3.8-flash-tts", "voice": "Achernar"},
],
)
session = AgentSession(tts=tts, expressive=True, ...)
Server-side fallback is the only option that keeps expressive mode on. Expressive mode requires the session TTS to be an inference.TTS, so wrapping providers in tts.FallbackAdapter disables it.
It is currently unclear to me how we would know that a failure and fallback has happened at all. As far as I can tell, nothing on the agent side reveals it, As far as I am aware:
- The gateway only sends
session.created,output_audio,output_alignment,doneanderror. None of these says which model produced the audio.erroronly arrives when every model has failed. - No
AgentSessionerror event fires when Inference falls back successfully. The Fallback strategies page says "When a fallback is triggered, AgentSession emits an error event", but that does not seem to apply to the Inference Fallback Adapter. - The
tts_nodespan'sgen_ai.request.model,TTSModelUsage.modeland metrics all report the primary model, because they come frominference.TTS._opts.model.
We reproduced this by giving xai/tts-1 a voice xAI rejects. With no fallback configured the request fails (xAI TTS error: ... Voice '...' not found). With an Inworld fallback configured, the session plays audio normally, logs zero TTS errors, and the trace and usage still say xai/tts-1.
We'd like to be able to tell, per request, that a fallback happened and which model served it. That would let us alert on provider outages, attribute cost correctly, and debug voice or quality differences users report. Possible shapes:
- The gateway reports the serving model and voice (for example in
session.createdordone, or as a newfallbackmessage with the failed model and error).inference.TTSthen exposes it. - The
tts_node/tts_requestspans getgen_ai.response.model,lk.fallback.labelandlk.fallback.index, matching whattts.FallbackAdapteralready records via_record_fallback_served. - Usage and metrics (
TTSModelUsage,TTSMetrics) are attributed to the model that served, so per-provider usage is correct. - An
AgentSessionevent (or a non-fatal error event withrecoverable=True) fires when Inference falls back, as the docs describe.
The same would be useful for inference.STT fallbacks.
Related Concern
- Related expressive-mode concern: is ti the case that markup is converted to the primary model's dialect on the client (
markup.convert, keyed on_provider_key()of the primary model) before Inference falls back? A fallback provider therefore receives the primary's native tags, for example[pause]and<soft>…</soft>from xAI sent to Inworld. Without knowing a fallback happened, we can't detect or correct for this either. If Inference reported the serving model, or converted the markup server-side for the provider that actually serves, both problems would be solved.
Workarounds / Alternatives
tts.FallbackAdaptergives this visibility, but it disables expressive mode, so it isn't an option for us.- Checking per-model usage in LiveKit Cloud after the fact, if the dashboard breaks usage down by provider. This doesn't work per session and can't be used for alerting.
Additional Context
- livekit-agents 1.8.2 (Python). The code paths above look the same on current
main(inference/tts.pystill ignores thesession.createdpayload).
- Dominant language
- Python
- Stars
- 14.6k
- Forks
- 3.9k
- Avg merge
- 3d 19h
- Merged PRs (30d)
- 204
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from livekit/agents
-
Assistant markup is stripped from chat history when expressive mode is offPossibly taken @ShivamSharma43 claimed this 16 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
docs: openai.LLM vs openai.responses.LLM for HTTP OpenAI-compat hostsMay be free again @AbarnaaSree claimed this 56 days ago, and no pull request is open. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
livekit/agents#7022 · 1 comment ·
Maintainers usually reply within 1 day
-
Python AgentServer health check (GET /) returns 200 before the worker has registered with LiveKitPossibly taken @ninglinLiu claimed this 1 day ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 35/100
Maintainers usually reply within 1 day
-
OpenAI Realtime engine: expose the WebSocket close code and reason to subclassesPossibly taken @ninglinLiu claimed this 2 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 35/100
Maintainers usually reply within 1 day
-
Soniox and simplismart STT detect a dead websocket and reconnect into it forever instead of failing overPossibly taken @ninglinLiu claimed this 2 days ago. Open
Difficulty 4/5 3-5 days Newbie friendliness 35/100
livekit/agents#8031 · 3 comments ·
Maintainers usually reply within 1 day
Similar issues
-
Project submission:Open
Difficulty 1/5 Under an hour Newbie friendliness 72/100
slavakurilyak/awesome-ai-agents#845 ·
Maintainers usually reply within 1 day
-
tests: pin that the atomic writers in utils/paths.py stage the temporary file in the target's directoryPossibly taken A pull request linked to this issue is open or already merged. Opendifficulty:2 enhancement good first issue
Difficulty 1/5 1-3 hours Newbie friendliness 92/100
MakazhanAlpamys/Soup#2178 ·
Maintainers usually reply within 1 day
-
[BUG] dcg.waggr permutation p-values are folded twice, so near-zero scores get the smallest p-valuesOpen
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
scverse/rapids-singlecell#854 ·
Maintainers usually reply within 1 day
-
Slang input: int8_t4_packed and uint8_t4_packed are copied into CrossGLPossibly taken @ninglinLiu claimed this today. Openarea:frontend backend:slang bug direction:input
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Maintainers usually reply within 1 day
-
random_elements(unique=True) on an OrderedDict: ZeroDivisionError once only zero weights remain, AssertionError with use_weighting=FalsePossibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 13 days