When you first start Tokaido, you'll be asked if you'd like to opt-in to our anonymous usage reporting tool. This page provides a bit more insight into what this tool collects and why we ask you to share this information with us.
As developers, we are are inherently skeptical of any data collection mechanisms when we encounter them. Most organisations make no assurances that they won't use this data to market to us, and of course when data isn't truly anonymous and is then stolen or leaked, it's us as users who pay the price.
We also see the incredible value that these collection systems offer to a developer. By being able to see how our tools are used in the wild. Tokaido is an open source, self-funded tool that we do not make any money from. This sadly means that we can't work on it full time, and so what limited time we have to contribute to the project needs to be directed into the most valuable new features and fixes.
InfoNote that if you choose not to opt-in to the telemetry service, then no usage data is ever collected
You can still submit surveys using
tok survey, but that survey data will not be linked to any identifiers.
When you explicitly opt-in to the usage reporting system, Tokaido generates a random UUID that identifies your installation of Tokaido and that of any project(s) you use Tokaido for. These IDs are essential to ensure that we can record individual users and projects, without ever recording any sensitive data like your computer name or project path.
In addition, when you use Tokaido we collect the following information:
- Your Tokaido “Sync Strategy”
- How long it took your Tokaido project to startup
- Your system memory and CPU profile (cores and clock speed)
- The number of Tokaido projects configured on your system
- The version of Tokaido that you are using
- Which database engine and version you have enabled
- Which version of PHP you have enabled and non-sensitive PHP configuration settings such as allow_url_open, memorylimit, post_max_size, etc.
- Which Tokaido commands you run (but not their arguments, input, or output)
- Which add-on services you have enabled (such as mailhog, adminer, etc)
- Which Content Management System (“CMS”) frameworks you are using
- Which CMS versions you are using
- Whether or not you are using the PHP XDebug feature
- Your Operating System and version
- The country your submission originated from
InfoBecause Tokaido is an open-source tool, you are free to review this code at any time to verify that we are, indeed, only collecting the data that we say we are.
Tokaido is built and primarily maintained by Ironstar.
Ironstar team members who work on Tokaido have access to review and create reports on this data, but Tokaido contributors who are not part of the Ironstar team do not have access to view this data.
No. We will never sell or license this data. We also will never use this data to market to you (we really can't).
This usage data helps us to identify key trends for Tokaido in the long term. For example with data we can make more intelligent decisions around things like:
- As adoption of PHP 7.3 grows, we can more confidently say when we should roll in PHP 7.4 support.
- How many of our users use XDebug, so we can see if we should devote more time to enhancing our support for it?
- What is the average start
uptime for a Tokaido project? Are we improving it with time?
- What is the minimum system specs (CPU and memory) we see? Can we make Tokaido more powerful?
- What is the average number of developers working on one project? Should we prioritise collaboration tools?
- What are the most popular Tokaido commands? Should we invest in expanding those?
- Which countries are users from? Should we work add a translation to our docs for primary language spoken there?
Being able to see real data to back up our assumptions on what features we should build or improve helps us to make the right choice.