Telemetry

Synth collects de-identified usage data to help create a better product and user experience.

You can opt-out of Synth's anonymous data collection at any time by running the command:

$ synth telemetry disable

or deleting the file at ~/.config/synth/config.json.

Synth is completely free and open-source. This means all the code that provide us with telemetry information is accessible by anyone. You can find the telemetry.rs submodule of Synth in our public repository.

The binary file that is downloaded by the installer script is built transparently by GitHub's CI/CD pipeline directly from public releases.

Philosophy#

Below are a set of principles that guide the telemetry decisions made in Synth:

  1. It is made completely transparent that telemetry is going to be installed
  2. It is made completely transparent as to what data we collect
  3. No personally identifiable information is collected. (IP addresses are discarded at the sink)
  4. Nothing is collected unless it is explicitly and clearly documented here.

Enabling / Disabling Telemetry#

Synth uses a configuration file under the user configuration directory ( e.g. ~/.config/synth/config.json on typical unix systems) as a marker for telemetry being enabled. This file also contains a randomly generated identifier. We use this identifier to better understand how we can improve the user experience for Synth.

You can check if telemetry is enabled by running synth telemetry status.

You can opt-out at any time by running synth telemetry disable.

Where does the data go?#

All the telemetry data is collected in a Posthog instance run exclusively by the maintainers of Synth.

If you would like the data associated with your UUID to be deleted, please contact opensource@getsynth.com.

What does Synth collect?#

Synth's telemetry collects 6 fields:

  • distinct_id: A randomly generated UUID stored at ~/.config/synth/config.json
  • command: The command that was issued by the user. This is a text field whose value is one of the following:
    • init
    • import
    • generate
    • telemetry::enabled
    • telemetry::disabled
  • success: If the command completed in success.
  • version: The current semver of Synth. For example v0.4.3.
  • os: The target platform for which the binary was built. This is the value of cargo's CARGO_CFG_TARGET_OS environment variable under which synth was built in CI/CD. Currently, this is one of:
    • linux
    • windows
    • macos
  • timestamp: The time at which the command was issued. For example 2021-05-06T16:13:40.084Z.

Below is the Synth schema of PostHog events posted by synth's activity:

{
"type": "object",
"distinct_id": {
"type": "string",
"uuid": {}
},
"command": {
"type": "string",
"categorical": {
"import": 1,
"generate": 10,
"init": 1,
"telemetry::enabled": 10,
"telemetry::disabled": 1
}
},
"version": {
"type": "string",
"pattern": "v0\\.4\\.3"
},
"os": {
"type": "string",
"categorical": {
"linux": 10,
"macos": 10,
"windows": 10
}
},
"timestamp": {
"type": "string",
"date_time": {
"format": "%Y-%m-%dT%H:%M:%S",
"subtype": "naive_date_time",
"begin": "2015-01-01T00:00:00",
"end": "2020-01-01T12:00:00"
}
}
}