Skip to content

docs(run): say what apps send and add the telemetry product to the Swift SDK - #691

Merged
aicayzer merged 4 commits into
mainfrom
155/telemetry
Oct 29, 2026
Merged

aicayzer merged 4 commits into
mainfrom
155/telemetry

Conversation

@aicayzer

@aicayzer aicayzer commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

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 MarfaTelemetry product (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: MarfaIcons and MarfaTelemetry rows 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.
  • No changelog entry: the changelog is for Marfa releases, and the docs AGENTS.md does 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:status and pnpm types:check pass.
  • Names and numbers checked against the code in marfa-swift#387 (rate limit and dropped_since_last included, instanceID removed): Telemetry.shared, Telemetry.Destination, Telemetry.Configuration, MarfaError.fixedText, batch of 50 or 30 seconds or flush(), queue of 500, two second flush, endpoints /i/v0/e/ and /i/v1/logs.
  • Not tested: a real send to PostHog. Whether PostHog accepts OTLP JSON on its logs endpoint is not stated in PostHog's documentation, so the page says only that records go "over OTLP".

Notes for reviewers

  • The page describes only what an app built on MarfaTelemetry does, 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.
  • The page and swift-sdk say 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 carries dropped_since_last. All three follow marfa-swift#387.
  • Merge after marfa-swift#387, so the page does not describe a product that is not there.

Checklist

  • The title is a scoped Conventional Commit.
  • New behavior has a test that was seen failing first, or no test was needed and the reason is above.
  • Docs, comments and the contract still say what is true after this change.

@aicayzer
aicayzer marked this pull request as ready for review October 29, 2026 20:30

@aicayzer aicayzer left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@aicayzer
aicayzer merged commit b57ac93 into main Oct 29, 2026
3 checks passed
@aicayzer
aicayzer deleted the 155/telemetry branch October 29, 2026 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant