Skip to main content
← Back to list
01Issue
FeatureOpenSwamp CLI
AssigneesNone

Relationships

#1597 Docs: manual never mentions telemetry, and the serve/scheduling pages imply automated runs are visible when they are not

Opened by keeb · 8/11/2026

Gap

The manual has no telemetry page at all, and three pages describe running workflows under a persistent daemon without ever saying whether that work is reported back to swamp-club:

  • content/manual/reference/swamp-serve.md
  • content/manual/explanation/swamp-serve.md
  • content/manual/how-to/run-workflows-on-a-schedule.md

Until swamp-club#1591 is fixed, those pages are misleading by omission. A swamp serve daemon is telemetry-dark for its entire uptime: scheduled, webhook, and API-triggered workflow runs record nothing, and the daemon never flushes because flushing only happens at process exit. An operator following the scheduling how-to gets automation that works perfectly and is entirely invisible — which is how swamp-club#1590 happened, a 32-day streak reset for someone whose automation was the point of their setup.

The more correctly you run swamp, the less of your work is visible. That is a surprising enough property to deserve documenting explicitly rather than being discovered.

What is needed

  1. A telemetry page (Explanation) covering what swamp reports, when it is sent, the local spool and flush model, how identity and attribution work, and every opt-out (--no-telemetry, SWAMP_NO_TELEMETRY, marker telemetryDisabled, the user-level preference file). No page covers any of this today.
  2. Serve and scheduling pages updated to state that daemon-executed runs report on a flush interval rather than at process exit, and that they carry a trigger source distinguishing them from interactive runs.
  3. If the fix ships before the docs, the scheduling how-to should note the version from which automated runs became visible — operators comparing old and new behaviour will otherwise assume their earlier work was lost rather than unreported.

Filed here rather than on the swamp-club repo because that repo has GitHub issues disabled.

Related: swamp-club#1591 (the CLI fix), swamp-club#1590 (the originating report), swamp-uat#344 (the matching test gap).

02Bog Flow
OPENTRIAGEDIN PROGRESSSHIPPED

Open

8/11/2026, 4:01:02 AM

No activity in this phase yet.

03Sludge Pulse

Sign in to post a ripple.