Repository navigation
docs(sdk): correct the READMEs that no longer match the SDKs - #164
Merged
Merged
Conversation
Since the core SDKs record exception text only when both capture flags are on (#88), the root, Bedrock, opencode, omp, and pi READMEs no longer say that exception messages are recorded regardless of them. The root README names the error messages that TanStack AI records. Values are sent whole by default (#148), so tool definitions in Google GenAI, Bedrock agent traces, and LiteLLM metadata are cut only at a maxAttributeLength that is set, not at 65,536 characters. The Python READMEs keep the old cap for telemetry-dev 0.3.2 and earlier, which their dependency floors still allow. The Python README says that a call in a child forked during a prompt fetch looks at the cache again and starts a new fetch if it must (#159), names the timeout of create_telemetry_span_exporter, and drops the note about integrations that run on a core without record_output_chunk: every integration requires telemetry-dev 0.3.0 or later, which has it. The CLI README describes the trace summary and the suggested next commands (#128). The experiment action README names the failed runs in the comment, the pages it reads to find its comment (#157), and an empty github-token. The root README lists prompts, experiments, and scores, and the CI check of the packed npm exports (#155, #160). The opencode plugin file example depends on ^0.2.2, not ^0.1.9.
This was referenced Oct 31, 2026
Merged
aikins01
added a commit
that referenced
this pull request
Nov 2, 2026
Follows #164 with the README lines that were still stale, or would go stale on the next release. - The opencode plugin-file example no longer pins `^0.2.2`, which release-please does not update. It installs the package with `npm install --prefix .opencode`, which writes the current range to `.opencode/package.json`. Without `--prefix`, npm can add it to the project's own `package.json` when `.opencode/` has none yet. - The Python `timeout` row now says what the exporter's deadline covers: no wait before a retry starts after it, a request whose connection fails is sent again once with the same limit, so an ingest that does not answer can take twice the timeout, and a response that keeps arriving can take longer. The `export_timeout_millis` row and the `create_telemetry_span_exporter` paragraph point to that row. - RELEASING.md describes the packed-exports check from #155 and #160. - The sentences about older cores that cannot report whether a mask is configured, lack the stream capture policy, or record exceptions regardless of capture flags are removed. Every supported range (`@telemetry-dev/sdk ^0.2.2`, `telemetry-dev>=0.3.0`) reaches only cores that have these features. The Python "with an older core, each stream keeps up to 64 KiB" clauses stay, because no released core has `max_stream_bytes` yet. Fixes #166
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.
Several READMEs still described behavior that recent changes replaced.
mask. The root README still listed exception text among the values that capture flags do not gate. The Bedrock READMEs said AWS errors always record the provider's message. The omp, pi, and opencode READMEs said a provider diagnostic becomes the exception message regardless ofcaptureOutputandmask, and thatcaptureOutput: falsegives the fallback message, when it now gives none.maxAttributeLengthis 0; the core now sets no OpenTelemetry attribute limit then, or when the option is not set. The Bedrock agent trace and the LiteLLM metadata are cut only at amaxAttributeLengththat is set. The Python integrations still accepttelemetry-dev0.3.0, so their READMEs keep the 65,536 cap for 0.3.2 and earlier. The TypeScript integrations release with the core that has fix(sdk): send each captured value whole #148, and their peer range follows it.record_output_chunk. Every Python integration requirestelemetry-dev0.3.0 or later, which has it.^0.1.9, which installs a release from before the 0.2 line.Some behavior had no README text: the timeout of
create_telemetry_span_exporter, the CLI's trace summary and suggested next commands (#128), and, in the experiment action, the failed-run count in the comment, the 5 oldest and 5 newest comment pages it searches (#157), and an emptygithub-token. The root README now lists prompts, experiments, and scores, and the CI check that each packed npm package has the targets of itsexportsandbin(#155, #160).The experiment sections of the core READMEs and the stream capture limits of the provider integrations are left as they are, since other changes are rewriting them.