Repository navigation
docs(run): say what apps send and add the telemetry product to the Swift SDK - #691
Merged
Merged
Conversation
3 tasks done
aicayzer
marked this pull request as ready for review
October 29, 2026 20:30
aicayzer
commented
Oct 29, 2026
aicayzer
left a comment
Contributor
Author
There was a problem hiding this comment.
Review: ready to merge
Summary. Adds "What apps send" to the telemetry page and the MarfaTelemetry product to the Swift SDK page, matching withmarfa/marfa-swift#387 as released in v0.0.42.
First draft: 3/5. Reviewed with marfa-swift#387 in two rounds: the page described app behavior that was not built yet and named fields the log batches did not carry; both fixed in 6cc5d19, with wording fixes in 92283d4 and 3c1434c.
Checked.
- True: every statement about what is sent, never sent, the rate limit and the switch, against the package's code; neighboring pages for any claim that apps send nothing.
Quick fixes. 4 applied by the reviewers.
Reviewed by withmarfa-reviewer on Claude. This review may contain mistakes.
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.
Summary
Says what Marfa's apps send. The telemetry page claimed telemetry came from the instance and the command line only; the Swift SDK is about to gain an optional
MarfaTelemetryproduct (withmarfa/marfa-swift#387) that lets an app report errors and chosen events. The docs now say what is sent, what never is, who chooses the destination, and how it is turned off.Changes
run/telemetry: the description and introduction count three places (instance, command line, apps); new "What apps send" section with "What an app never sends" and "Turn it off"; the PostHog example uses the EU host and notes the US one.swift-sdk:MarfaIconsandMarfaTelemetryrows in the product table, and a new section "Report errors and events from an app" with the configuration, the reporting calls and the rule that only fixed text, numbers and booleans are accepted.AGENTS.mddoes not ask for SDK entries. No other page claimed that apps send nothing (checked the glossary, the build pages and the rest by search).Testing
pnpm install --frozen-lockfile,pnpm test(709 passed),pnpm build,pnpm build:statusandpnpm types:checkpass.dropped_since_lastincluded,instanceIDremoved):Telemetry.shared,Telemetry.Destination,Telemetry.Configuration,MarfaError.fixedText, batch of 50 or 30 seconds orflush(), queue of 500, two second flush, endpoints/i/v0/e/and/i/v1/logs.Notes for reviewers
MarfaTelemetrydoes, and says nothing about WithMarfa's MAPP builds or MAPP's switch. MAPP's own pull request adds them, with the switch's real name and default.swift-sdksay no instance ID is sent, that a repeating failure is reported at most once a minute for each type and operation and 30 an hour in all, and that each exception carriesdropped_since_last. All three follow marfa-swift#387.Checklist