Repository navigation
docs(sdk): document the overrides argument for capturing telemetry in tests - #197
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The second argument of
telemetryDev()in ai-sdk and tanstack-ai replaces span export and metric recording. Both packages' tests capture through it, and #83 asked whether it should stay. It stays, so this documents it as the way to capture telemetry in tests.Each README gets a Testing section with an example. It spells out the two things a caller would otherwise trip on: the integration still needs a non-empty API key or it does nothing, and a function left out keeps exporting to telemetry.dev, so a test needs all three to stay offline. The doc comment on
GenerationEmitterOverridesin@telemetry-dev/otelstates the same contract, and the test comments that called it a test seam are gone.I ran the README examples against a real
generateTextand a realchat()withfetchstubbed: spans and token counts were captured and nothing was posted. With onlysendSpanspassed, metrics still went to/v1/metrics.Refs #83