Xray Audit
Xray Audit provides detailed technical reports on your Drupal site's structure and configuration, helping you understand content storage, display, and management. It includes an Insights system that analyzes this data to detect unused configurations, potential issues, and optimization opportunities, which are then integrated into Drupal's Status Report. This module is useful for audits, migrations, refactoring, and ongoing maintenance, and is compatible with multisite environments.
Xray Audit provides detailed technical reports on the structure and configuration of a Drupal site. It helps developers, site builders, and administrators understand how content is stored, displayed, and managed.
The module covers content entities, field definitions, display modes, access control, user roles, views, menus, and more. It is especially useful for audits, migrations, refactoring, and ongoing maintenance.
A key feature of Xray Audit is its Insights system, which analyzes report data to detect unused configurations, potential issues, and optimization opportunities. Insights are integrated with Drupal’s Status Report, making them easy to monitor and act upon.
Xray Audit is compatible with multisite environments. The module is under active development, and new reports and improvements are added regularly.
Key Features
- Analyze content entity types and their usage
- Get display configuration per bundle and entity type
- Report about entity definitions and field configuration
- Inspect roles, permissions, users, and menus
- List of view configurations
- Check cache configuration
- Report on module and theme usage (multisite compatible)
- Group metrics by entity type (nodes, paragraphs, blocks, media)
- View database size and tables
- Integrate with Drupal Status Report via Xray Audit Insights submodule
Available Reports
Content Model
- Content Entity Types – Lists all entity types (core, contrib, custom)
- Content Entity Definitions – Definitions and configuration of entities
- Taxonomy Vocabularies – Vocabulary and field descriptions
Content Display
- Node Displays
- Paragraph Displays
- Media Displays
- Taxonomy Term Displays
- Block Displays
Layout
- Block Placement – Block regions and visibility settings
Content Metrics
- Node Reports
- Paragraph Reports
- Block Reports
- Taxonomy Reports
- Media Reports
Access & Users
- Role Overview – Roles and permissions
- User Overview – User totals and statuses
Site Structure
- Menus – Menu trees and items
- Views – Status and caching configuration
Packages
- Modules – Installed module list
- Themes – Installed and active themes
System
- Database Info – Table sizes and database statistics
Insights
Xray Audit Insights is a Xray Audit submodule that identifies issues and improvement opportunities automatically based on the report data. They are displayed in a unified interface and integrated with Drupal’s Status Report system.
Each insight includes:
- A short description
- A severity level (info, warning, critical)
- A link to the related report for further details
List of Insights
- Entity bundles that are defined but not used
- Enabled modules that are unused across environments
- Cache configuration checks (Drupal cache, reverse proxy, Views)
- High volume of paragraph revisions
- Access to administrative views without proper restrictions
- Oversized database tables
Insights reduce manual auditing work and support proactive maintenance, especially in complex or large-scale projects.
Do you have any new insight in mind? please open a feature request.
Adding new reports
The development of the module has been based on Drupal's plugin system to facilitate the integration of new reports. Developers can find instructions on how to do this in the README.
Resources
Related projects
- Content Model Documentation: offers a documentation entity to document parts of the site and provides a content relationship diagram on entites.