TURN OFF USAGE TELEMETRY
This guide shows you how to stop Swamp recording and sending usage telemetry. Any one of these opt-outs is enough on its own, and none of them can be undone by another setting. For the full rules, see the Usage Telemetry reference.
Turn off telemetry everywhere
$ swamp config set telemetry.collection disabledconfig·set: Telemetry disabled for every run, in any repository
config·set: Restart any running swamp serve daemon to apply itThis applies to every run under your user account, inside and outside every repository. The command that turns telemetry off is not recorded.
To check the setting:
$ swamp config get telemetry.collectionconfig·get: "disabled"Restart swamp serve
A running swamp serve reads the setting only when it starts. Restart it. For a
daemon installed with swamp serve daemon enable:
- macOS:
launchctl kickstart -k gui/$(id -u)/club.swamp.serve - Linux (system):
sudo systemctl restart swamp-serve - Linux (
--user):systemctl --user restart swamp-serve
The daemon reads the setting of the user who ran swamp serve daemon enable, so
run swamp config set as that user.
Turn off telemetry for everyone in a repository
Add telemetryDisabled to the repository's .swamp.yaml and commit it:
telemetryDisabled: trueNothing is recorded for commands run in that repository, by anyone.
Turn off telemetry in CI and containers
Set either environment variable in the job or image:
export SWAMP_NO_TELEMETRY=1export DO_NOT_TRACK=1Any value other than 0, false, or empty turns telemetry off.
Skip telemetry for one command
Add --no-telemetry to the command:
$ swamp workflow run my-workflow --no-telemetryRemove events already recorded
Events recorded before you opted out stay in the spool and are no longer sent. To delete them, remove the spool directory:
$ rm -rf ~/.config/swamp/telemetryIf you set SWAMP_CONFIG_DIR, SWAMP_HOME, or XDG_CONFIG_HOME, the spool is
elsewhere — see
Config directory.
Turn telemetry back on
$ swamp config set telemetry.collection enabledconfig·set: User-level telemetry opt-out removed; --no-telemetry, SWAMP_NO_TELEMETRY, DO_NOT_TRACK and a repository's telemetryDisabled still apply
config·set: Restart any running swamp serve daemon to apply itTelemetry stays off wherever another opt-out still applies.