fix(weave): restore broken otel docs page + correct OTLP endpoint guidance#2771
Draft
gtarpenning wants to merge 2 commits into
Draft
fix(weave): restore broken otel docs page + correct OTLP endpoint guidance#2771gtarpenning wants to merge 2 commits into
gtarpenning wants to merge 2 commits into
Conversation
The example variable was named `OTEL_EXPORTER_OTLP_ENDPOINT` and set to the full `.../otel/v1/traces` URL. Passed to `endpoint=`/`url=` it works, but lifting that value into the real env var (or using `opentelemetry-instrument`) makes the OTel SDK append `/v1/traces` -> `.../otel/v1/traces/v1/traces`, a 404. Rename the example var to `WEAVE_TRACES_ENDPOINT` and add a callout pointing env-var setups at the signal-specific `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT`. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
📚 Mintlify Preview Links📝 Changed (1 total)📄 Pages (1)
🤖 Generated automatically when Mintlify deployment succeeds |
Contributor
🔗 Link Checker Results✅ All links are valid! No broken links were detected. Checked against: https://wb-21fd5541-griffin-fix-otel-otlp-traces-endpoint-doc.mintlify.app |
PR #2757 enabled twoslash on this page's 10 TypeScript blocks. otel.mdx is the only weave page with twoslash TS blocks, and the build now fails with "Language `console` not found" (Shiki, raised while twoslash renders hover JSDoc), so the live page serves Mintlify's "parsing error" boundary. Revert the twoslash keyword and the `// @noErrors` directives it added, restoring the pre-#2757 content. Verified with `mint dev`: the page compiles and renders. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
gtarpenning
changed the title
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
1 participant
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.
Summary
Two fixes to
weave/guides/tracking/otel.mdx:twoslashhere, and otel.mdx is the only weave page with twoslash TS blocks. The build now throws a Shiki error,Language console not found(raised while twoslash renders hover JSDoc), so the live page serves Mintlify's "🚧 A parsing error occured" boundary instead of content. Reverts thetwoslashkeyword and the// @noErrorslines docs(weave): enable Twoslash on TypeScript code blocks #2757 added, restoring the pre-docs(weave): enable Twoslash on TypeScript code blocks #2757 content. Verified rendering withmint dev.OTEL_EXPORTER_OTLP_ENDPOINTtoWEAVE_TRACES_ENDPOINT: it was named identically to the real env var, so copying the value into the env var (or usingopentelemetry-instrument) makes the OTel SDK append/v1/traces->.../otel/v1/traces/v1/traces404 (~273/day in prod). Adds a callout pointing env-var setups at signal-specificOTEL_EXPORTER_OTLP_TRACES_ENDPOINT.Testing
mint devrenders the page (it serves the parse-error boundary onmain);mint validatepasses. cc #2757 author re: the twoslash revert.