Skip to content

Telemetry

Rishabh Poddar edited this page Feb 21, 2024 · 15 revisions

To help us improve SuperTokens, we collect the following metrics:

WE DON'T COLLECT ANY END USER DATA

From the core

SuperTokens sends a periodic ping (every 24 hours) to our API with:

  • The SuperTokens core version
  • An anonymous ID stored in your database (only if you are NOT using the in memory db).
  • The MAU count and the total user count.
  • The emails you use to access the user management dashboard login (this is not end user data).

If you have added a license key to the core, we also send any ee feature stats. For example, if you have enabled multi tenancy, we also send the number of tenants and the login methods configured for each tenant (for billing purposes). To see all the info that's sent based on features, see this file.

You can disable it by:

Using Docker

Pass DISABLE_TELEMETRY=true as an env variable in the docker run command. Note that this will not disable the license key stats, if you have added a license key, and will only disable the telemetry info. If you also want to disable sending the license key stats, you can ask us for a stateless license key - email us for more information

Not using Docker

Set disable_telemetry: true in config.yaml.

From the backend SDK

The backend SDK sends your appName, apiDomain, websiteDomain, sdk version, the total number of users, user management dashboard version and the email of the user logged into the user management dashboard. This helps us learn more about how SuperTokens is used, and helps us get in touch with users in case of important security updates.

You can disable it by:

The backend sdk's initialisation function takes a boolean called telemetry. Set it to false.