PHPackages flowpack/neos-debug - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Debugging & Profiling](/categories/debugging) 4. / 5. flowpack/neos-debug ActiveNeos-plugin[Debugging & Profiling](/categories/debugging) flowpack/neos-debug =================== Neos CMS helper package to visualize debug information for page rendering 1.2.1(3mo ago)314.9k↓47%2[6 issues](https://github.com/Flowpack/neos-debug/issues)[2 PRs](https://github.com/Flowpack/neos-debug/pulls)MITPHPPHP ^8.1 Since Mar 21Pushed 2mo agoCompare [ Source](https://github.com/Flowpack/neos-debug)[ Packagist](https://packagist.org/packages/flowpack/neos-debug)[ RSS](/packages/flowpack-neos-debug/feed)WikiDiscussions main Synced 1w ago READMEChangelog (9)Dependencies (4)Versions (14)Used By (0) Flowpack.Neos.Debug =================== [](#flowpackneosdebug) This plugin is a small helper package to add a debug panel to your [Neos CMS](https://www.neoss.io) website. At this point in time you're able to debug your content cache configuration as well as sql queries. Additionally, the Server-Timing http header can be enabled that will add request timings to responses. Those then can be viewed in the browser network tab. *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* This plugin is based on the now unmaintained [t3n/neos-debug](https://github.com/t3n/neos-debug) package and replaces it fully. Screenshots ----------- [](#screenshots) [![Neos CMS Demo Site with debug console showing cache visualization](Documentation/NeosDebugFusionCache.jpg "Neos CMS Demo Site with debug console showing cache visualization")](Documentation/NeosDebugFusionCache.jpg)[![Neos CMS Demo Site with debug console showing database queries](Documentation/NeosDebugDatabaseQueries.jpg "Neos CMS Demo Site with debug console showing database queries")](Documentation/NeosDebugDatabaseQueries.jpg)[![Neos CMS Demo Site with debug console showing other metrics](Documentation/NeosDebugOtherMetrics.jpg "Neos CMS Demo Site with debug console showing other metrics")](Documentation/NeosDebugOtherMetrics.jpg)[![Server-Timing header in the browser network tab](Documentation/NeosDebugServerTiming.jpg "Viewing the timings in the browser network tab")](Documentation/NeosDebugServerTiming.jpg) Installation & configuration -------------------------------- [](#installation--configuration) Install the package via composer ``` composer require flowpack/neos-debug --dev ``` The debug mode is disabled by default. To enable it add this to your Settings.yaml ``` Flowpack: Neos: Debug: enabled: true ``` To bring up the debug panel run this command in your js console: ``` __enable_neos_debug() ``` *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. To get the debugger running you now need to include some javascript and css to acutally render the debug console. This package ships two fusion prototypes to include all resources. If your Document extends `Neos.Neos:Page` you don't need to include anything. We already added the resources to `Neos.Neos:Page` prototype. ### HTTP Server-Timing header [](#http-server-timing-header) The header is disabled by default. To enable it add this to your Settings.yaml ``` Flowpack: Neos: Debug: serverTimingHeader: enabled: true ``` If you only want the header with all timings but not the debug mode, do this: ``` Flowpack: Neos: Debug: enabled: true htmlOutput: enabled: false serverTimingHeader: enabled: true ``` Usage ----- [](#usage) 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. ### 🔦 Inspect [](#-inspect) 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. ### ⚡️ Cache [](#️-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. ### 🗄 SQL [](#-sql) 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: ``` Flowpack: Neos: Debug: sql: # Set when a query should be considered as slow query. In ms slowQueryAfter: 10 ``` Note: this plugin adds its own SQL logger via an aspect during runtime. If you have a custom logger enabled, it will be wrapped and its functionality should remain. If you experience any issues, disable this plugin and check if the problem persists. ### 🚫 Close [](#-close) 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 ``` __enable_neos_debug(true) ``` This will set a cookie and the debug mode will still be active after a page refresh. ### Using it in custom Fusion views (e.g. Neos backend modules) [](#using-it-in-custom-fusion-views-eg-neos-backend-modules) To use the debug widget in custom Fusion views, you can include the necessary resources like this: ``` include: resource://Flowpack.Neos.Debug/Private/Fusion/Fragments/Scripts.fusion My.Package.MyController.index { @process.addLoadDebugScript = afx` {value} ` } ``` With this modification, you can use the `__enable_neos_debug()` function in your browser console to enable the debug widget. ⚠️Make sure to remove this script in production environments or when in a shared plugin as the prototype might not be available in every environment. ### License [](#license) Licensed under MIT, see [LICENSE](LICENSE) ### Health Score 43 — FairBetter than 89% of packages Maintenance61 Regular maintenance activity Popularity32 Limited adoption so far Community16 Small or concentrated contributor base Maturity54 Maturing project, gaining track record Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~38 days Recently: every ~61 days Total 10 Last Release 103d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/25d49a6af82b72d2764774a05c307808375016d7aeaaef3862472a6580ff38a7?d=identicon)[flowpack](/maintainers/flowpack) --- Top Contributors [![Sebobo](https://avatars.githubusercontent.com/u/596967?v=4)](https://github.com/Sebobo "Sebobo (92 commits)")[![johannessteu](https://avatars.githubusercontent.com/u/769789?v=4)](https://github.com/johannessteu "johannessteu (88 commits)")[![dependabot-preview[bot]](https://avatars.githubusercontent.com/in/2141?v=4)](https://github.com/dependabot-preview[bot] "dependabot-preview[bot] (23 commits)")[![dlubitz](https://avatars.githubusercontent.com/u/13046100?v=4)](https://github.com/dlubitz "dlubitz (7 commits)")[![Torsten85](https://avatars.githubusercontent.com/u/531361?v=4)](https://github.com/Torsten85 "Torsten85 (2 commits)")[![dependabot-support](https://avatars.githubusercontent.com/u/112581971?v=4)](https://github.com/dependabot-support "dependabot-support (2 commits)")[![jonnitto](https://avatars.githubusercontent.com/u/4510166?v=4)](https://github.com/jonnitto "jonnitto (2 commits)")[![mwuest](https://avatars.githubusercontent.com/u/3205472?v=4)](https://github.com/mwuest "mwuest (1 commits)")[![mficzel](https://avatars.githubusercontent.com/u/1309380?v=4)](https://github.com/mficzel "mficzel (1 commits)")[![daniellienert](https://avatars.githubusercontent.com/u/642226?v=4)](https://github.com/daniellienert "daniellienert (1 commits)") ### Embed Badge ![Health badge](/badges/flowpack-neos-debug/health.svg) ``` [![Health](https://phpackages.com/badges/flowpack-neos-debug/health.svg)](https://phpackages.com/packages/flowpack-neos-debug) ``` ### Alternatives [neos/neos An open source Content Application Platform based on Flow. A set of core Content Management features is resting within a larger context that allows you to build a perfectly customized experience for your users. 1131.0M734](/packages/neos-neos)[shel/nodetypes-analyzer Graphical analysis & visualizer for the Neos CMS nodetypes as backend module 2163.6k](/packages/shel-nodetypes-analyzer)[neos/form-builder Flow Form Framework integration into Neos CMS 19358.8k19](/packages/neos-form-builder)[neos/media The Media package 101.2M49](/packages/neos-media)[sandstorm/plumber Profiling Toolkit for Neos Flow and Neos 364.9k](/packages/sandstorm-plumber)[medienreaktor/meilisearch Integrates Meilisearch into Neos. 101.0k](/packages/medienreaktor-meilisearch) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)