From fc73926ad87e19f05cb3101823435588d6dc2c60 Mon Sep 17 00:00:00 2001 From: James White Date: Wed, 10 Jun 2026 13:15:23 +0200 Subject: [PATCH 1/3] add telemetry clarifying docs --- content/configuration/1.general.md | 10 +++- content/licensing/2.telemetry.md | 93 ++++++++++++++++++++++++++++++ 2 files changed, 100 insertions(+), 3 deletions(-) create mode 100644 content/licensing/2.telemetry.md diff --git a/content/configuration/1.general.md b/content/configuration/1.general.md index e24da184..730405ba 100644 --- a/content/configuration/1.general.md +++ b/content/configuration/1.general.md @@ -66,10 +66,14 @@ The following commands set details for the first admin user created when the pro ## Telemetry -To more accurately gauge the frequency of installation, version fragmentation, and general size of the user base, Directus collects little and anonymized data about your environment. +To more accurately gauge the frequency of installation, version fragmentation, and general size of the user base, Directus collects a small amount of usage data about your environment. | Variable | Description | Default Value | | ------------------------- | ----------------------------------------------------------------- | -------------------------------- | -| `TELEMETRY` | Allow Directus to collect anonymized data about your environment. | `true` | -| `TELEMETRY_URL` | URL that the usage report is submitted to. | `https://telemetry.directus.com/` | +| `TELEMETRY` | Allow Directus to collect usage data about your environment. | `true` | +| `TELEMETRY_URL` | URL that the usage report is submitted to. | `https://telemetry.directus.io` | | `TELEMETRY_AUTHORIZATION` | Optional authorization header value. | | + +::callout{icon="i-lucide-book-open" color="primary" to="/licensing/telemetry"} +For a full breakdown of exactly what data is collected, when it is sent, and how opt-out is affected by your license, see [Telemetry](/licensing/telemetry). +:: diff --git a/content/licensing/2.telemetry.md b/content/licensing/2.telemetry.md new file mode 100644 index 00000000..29ce6171 --- /dev/null +++ b/content/licensing/2.telemetry.md @@ -0,0 +1,93 @@ +--- +stableId: 99293d1a-80a0-4c5b-a7d8-1b00c2637f69 +title: Telemetry +headline: Licensing +description: Exactly what usage data Directus collects, when it is sent, and how to disable it. +navigation: + title: Telemetry +--- + +Directus collects a small amount of usage data from each installation. This helps the team understand how often Directus is installed, which versions are in use, and the general size and shape of projects so development can be prioritized accordingly. + +Most of the report is aggregate counts and true/false flags. Two fields identify your instance: your public URL (`url`, taken from `PUBLIC_URL`) and a generated project identifier (`project_id`). Beyond those, the report never includes your content, schema names, user details, or secrets. This page documents every value that is collected so you can see precisely what leaves your instance. + +## What Directus Collects + +Each report contains the following fields, and nothing else. + +### Instance and Environment + +| Field | What it is | +| --- | --- | +| `url` | Your project's public URL (the value of `PUBLIC_URL`). On licensed instances, this is the same URL used for [license activation and project binding](/licensing/overview#activations-and-project-bindings). | +| `version` | The Directus version in use. | +| `database` | The database vendor in use (for example `pg` or `mysql`), not its contents or connection details. | +| `project_id` | A random identifier generated for your project. It is not derived from any personal or project data. | +| `database_size` | Total size of the database in bytes. | +| `files_size_total` | Combined size of stored files in bytes. | +| `websockets_enabled` | Whether WebSockets are enabled. | + +### Content and Schema Counts + +| Field | What it is | +| --- | --- | +| `collections` | Number of user-created collections. | +| `items` | Total number of items across all non-system collections. | +| `fields_total` | Total number of fields across all collections. | +| `fields_max` | The largest number of fields in any single collection. | +| `files` | Number of files in the system. | + +### Users and Access + +| Field | What it is | +| --- | --- | +| `admin_users` | Number of users with admin access. | +| `app_users` | Number of users who can access the app but are not admins. | +| `api_users` | Number of users who can only access the API. | +| `roles` | Number of roles. | +| `shares` | Number of shares. | + +### Features in Use + +| Field | What it is | +| --- | --- | +| `flows` | Number of active flows. | +| `dashboards` | Number of dashboards. | +| `extensions` | Number of installed extensions. | +| `visual_editor_urls` | Number of configured Visual Editor URLs. | +| `collaborative_editing_enabled` | Whether collaborative editing is enabled. | +| `mcp_enabled` | Whether the MCP server is enabled. | +| `mcp_allow_deletes` | Whether MCP is permitted to perform deletes. | +| `mcp_system_prompt_enabled` | Whether a custom MCP system prompt is enabled. | +| `ai_openai_api_key` | Whether an OpenAI API key is configured (`true`/`false` only, never the key itself). | +| `ai_anthropic_api_key` | Whether an Anthropic API key is configured (`true`/`false` only, never the key itself). | +| `ai_system_prompt` | Whether a custom AI system prompt is set (`true`/`false` only, never the prompt itself). | + +### API Request Volume + +The report includes API request counts for the current reporting window, broken down by HTTP method (`GET`, `POST`, `PATCH`, and so on) along with the number of requests served from cache. These are aggregate counts only, with no information about the requests themselves, and are reset to zero after each report is sent. + +## What Directus Does Not Collect + +The report is intentionally limited to the fields listed above. It does not include: + +- Item or content data of any kind. +- Collection names, field names, or field values. +- File contents or file names. +- User names, email addresses, passwords, or any other personal data. +- API keys, tokens, secrets, or system prompts. Where a key or prompt is referenced above, only a `true`/`false` value indicating whether it is configured is sent. +- The values of your environment variables. + +## When and Where Reports Are Sent + +Directus generates a report shortly after startup, following a random delay of up to 30 minutes, and then sends one every 6 hours. + +Reports are sent to the URL defined by the `TELEMETRY_URL` variable, which defaults to `https://telemetry.directus.io`. + +## Disabling Telemetry + +To opt out, set the `TELEMETRY` [environment variable](/configuration/general#telemetry) to `false` and restart Directus. + +::callout{icon="i-lucide-info"} +Whether telemetry can be disabled depends on your license. Some plans require telemetry to remain enabled, in which case the `TELEMETRY` setting is ignored. See [Licensing](/licensing/overview) for details on plans and entitlements. +:: From d6e4c75ef8dc5f48bd10c3dde153324976df3399 Mon Sep 17 00:00:00 2001 From: James White Date: Wed, 10 Jun 2026 14:09:36 +0200 Subject: [PATCH 2/3] amends --- content/configuration/1.general.md | 2 +- content/licensing/2.telemetry.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/configuration/1.general.md b/content/configuration/1.general.md index 730405ba..65f2c868 100644 --- a/content/configuration/1.general.md +++ b/content/configuration/1.general.md @@ -66,7 +66,7 @@ The following commands set details for the first admin user created when the pro ## Telemetry -To more accurately gauge the frequency of installation, version fragmentation, and general size of the user base, Directus collects a small amount of usage data about your environment. +To more accurately gauge the frequency of installation, version fragmentation, and general size of the user base, Directus collects usage data about your environment. | Variable | Description | Default Value | | ------------------------- | ----------------------------------------------------------------- | -------------------------------- | diff --git a/content/licensing/2.telemetry.md b/content/licensing/2.telemetry.md index 29ce6171..44ee207f 100644 --- a/content/licensing/2.telemetry.md +++ b/content/licensing/2.telemetry.md @@ -7,7 +7,7 @@ navigation: title: Telemetry --- -Directus collects a small amount of usage data from each installation. This helps the team understand how often Directus is installed, which versions are in use, and the general size and shape of projects so development can be prioritized accordingly. +Directus collects usage data from each installation. This helps the team understand how often Directus is installed, which versions are in use, and the general size and shape of projects so development can be prioritized accordingly. Most of the report is aggregate counts and true/false flags. Two fields identify your instance: your public URL (`url`, taken from `PUBLIC_URL`) and a generated project identifier (`project_id`). Beyond those, the report never includes your content, schema names, user details, or secrets. This page documents every value that is collected so you can see precisely what leaves your instance. From 1b95c61a0359f7af927d1ee4927faaa5a55ba68c Mon Sep 17 00:00:00 2001 From: James White Date: Wed, 10 Jun 2026 14:23:42 +0200 Subject: [PATCH 3/3] references --- content/configuration/1.general.md | 4 ++-- content/licensing/2.telemetry.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/content/configuration/1.general.md b/content/configuration/1.general.md index 65f2c868..33e8f44b 100644 --- a/content/configuration/1.general.md +++ b/content/configuration/1.general.md @@ -70,10 +70,10 @@ To more accurately gauge the frequency of installation, version fragmentation, a | Variable | Description | Default Value | | ------------------------- | ----------------------------------------------------------------- | -------------------------------- | -| `TELEMETRY` | Allow Directus to collect usage data about your environment. | `true` | +| `TELEMETRY` | Allow Directus to collect usage data about your environment. Whether it can be disabled depends on your license. See [Telemetry](/licensing/telemetry) for more information. | `true` | | `TELEMETRY_URL` | URL that the usage report is submitted to. | `https://telemetry.directus.io` | | `TELEMETRY_AUTHORIZATION` | Optional authorization header value. | | ::callout{icon="i-lucide-book-open" color="primary" to="/licensing/telemetry"} -For a full breakdown of exactly what data is collected, when it is sent, and how opt-out is affected by your license, see [Telemetry](/licensing/telemetry). +For a full breakdown of what is collected, when it is sent, and how to opt out, see [Telemetry](/licensing/telemetry). :: diff --git a/content/licensing/2.telemetry.md b/content/licensing/2.telemetry.md index 44ee207f..01b293cb 100644 --- a/content/licensing/2.telemetry.md +++ b/content/licensing/2.telemetry.md @@ -89,5 +89,5 @@ Reports are sent to the URL defined by the `TELEMETRY_URL` variable, which defau To opt out, set the `TELEMETRY` [environment variable](/configuration/general#telemetry) to `false` and restart Directus. ::callout{icon="i-lucide-info"} -Whether telemetry can be disabled depends on your license. Some plans require telemetry to remain enabled, in which case the `TELEMETRY` setting is ignored. See [Licensing](/licensing/overview) for details on plans and entitlements. +Whether you can disable telemetry depends on your license. Some licenses require telemetry to remain enabled, in which case the `TELEMETRY` setting is ignored. To check whether yours allows it, review your entitlements under **Settings → License** in the Studio. ::