The t3n.Neos.Debug package is a small helper package to add a debug panel to your Neos CMS website. At this point in time you're able to debug your content cache configuration as well as sql queries.
Note: This is still a very early rough version. Contributions are welcome in any Error. Nevertheless, it's already adding value to your debug experience
Installation & configuration
Install the package via composer
composer require t3n/neos-debug
The debug mode is disabled by default. To enable it add this to your Settings.yaml
t3n: Neos: Debug: enabled: true
To bring up the debug panel run this command in your js console:
Disclaimer: Once the debug mode is enabled you might expose sensitive data. Make sure to not use this in production. At least be warned
In a previous version of this package your current user needed a specific role as well. We dropped this requirement for now as you could not use this package if you don't have a frontend login on your site. Once the package is active it will render some metadata in your html output.
Neos.Neos:Page you don't need to include anything. We already added the resources to
To enable the cache visualization open your browsers developer console and execute
__enable_neos_debug__(). This will bring up the debug console at the bottom of your screen.
Once you enable the inspect mode a visualization will pop up and add overlays on your cached parts. Cached parts are marked green, uncached red and dynamic caches are marked yellow. If you hover the loupe you will also see some meta data regarding the cache.
This module will add a new modal including some statistics regarding cache hits and misses as well as a table of all rendered cache entries.
In addition to the content cache we're also exposing some debug SQL informations and statistics. It will also detect slow queries. You can configure from when a query should be marked as slow:
t3n: Neos: Debug: sql: # Set when a query should be considered as slow query. In ms slowQueryAfter: 10
To shutdown the debug console simply close it. If you'd like to persist the active debug state you can add a
true to the method
This will set a cookie and the debug mode will still be active after a page refresh.