Telemetry lets you see, from one Drupal site, which modules and updates every Drupal site you manage needs. Each site securely reports its modules and available updates, and a central "hub" site collects them.
If you look after several Drupal sites, the usual way to find out what needs updating is to log in to each one and check its Available updates page. Telemetry brings all of that into one place: which sites run which modules and versions, which ones have updates, and which of those are security updates.
Features
The project has two parts. You install Telemetry on every site you want to monitor, and enable the Telemetry Hub submodule on one central site.
Telemetry (on each monitored site)
- Adds a lightweight JSON endpoint (
/telemetry/check), protected by an API key, that reports Drupal core and every installed contributed and custom module: version, enabled status, project, source, and update status from core's Update Status module. - Adds a Current payload tab, so you can see exactly what the site shares.
- Can be told by the hub to check drupal.org for new releases. This works like clicking "Check manually" on the Available updates page, with a 15-minute cooldown.
Telemetry Hub (on your central site)
- Projects: every project in use across all your sites, with installed and recommended versions, how many sites use it, and colour-coded update pills (Security, Unsupported, Revoked, Update). Submodules are grouped under their project.
- Sites: every site's core version, when it last checked for updates, when its report was last pulled, and its module updates, with each row tinted by its most serious update.
- Updates report: an on-demand list of every site's updates, most urgent first. You can print it, copy it as rich text for Teams or email, copy or download it as Markdown, or download it as CSV.
- Remote actions: pull a fresh report, or make a site check drupal.org for updates, for one site or all sites at once. Both run with a progress bar and include a confirmation step.
- Connection status: the Registered sites list pings every site and shows whether it's connected.
- Detail pages for every site and module, report history, and the raw JSON of any report.
- Drush commands to pull reports and trigger update checks from the command line or scheduled jobs.
Typical uses: agencies and in-house teams managing many Drupal sites, security-release days ("which of our sites need this patch?"), and monthly maintenance planning and client reporting.
The hub pulls data from your sites, so monitored sites never need to know the hub exists or store its credentials.
Post-Installation
On each site you want to monitor:
- Enable Telemetry.
- Go to Configuration → System → Telemetry and generate an API key. You can also use
drush telemetry:set-key. - Make sure core's Update Status module is enabled, so the site has update data to report.
On your hub site:
- Enable Telemetry Hub, which also enables Telemetry.
- Go to Configuration → System → Telemetry → Registered sites and click Add site. Enter each site's name, base URL and API key. The Connection column confirms the hub can reach it.
- Reports are pulled on every hub cron run. You can also use Pull reports for all sites, or
drush telemetry-hub:pull. - View everything under Reports → Telemetry hub.
Under Hub settings you can set how many reports to keep per site. Access is controlled by two restricted permissions: Administer Telemetry API key on monitored sites, and Administer Telemetry Hub on the hub.
Security considerations: the endpoint only answers requests that carry the correct API key. Serve your sites over HTTPS so keys aren't sent in the clear. The hub stores every site's API key, so protect its database accordingly.
Additional Requirements
- Drupal 10 or 11, PHP 8.1 or later.
- Drupal core's Update Status module on monitored sites, for update information. Without it, sites still report their modules, but not available updates.
- The hub must be able to reach each monitored site over HTTP(S).
Recommended modules/libraries
- Drush, for the command-line key management, pull and update-check commands.
- A reliable cron on the hub, such as a system cron job, so reports stay current.
Similar projects
- Update Status (Drupal core) shows available updates for one site at a time. Telemetry builds on it and combines the results from all your sites.
- Hosted and SaaS monitoring services give fleet-wide update overviews, but they send your site data to a third party. With Telemetry, everything stays on infrastructure you control.
Community Documentation
See the README included with the module for full documentation: the JSON payload format, the /telemetry/refresh endpoint, every hub page, and the Drush commands.
Ask your assistant about Telemetry
Check compatibility with your Drupal and PHP version, maintenance and security coverage, from current release data. How it works
Depends on
Dependencies of the latest stable release
No dependencies recorded for this project.
Required by
Tracked projects that depend on this one
No tracked projects depend on this one yet.