Settings - Debug
You can access these settings in the Settings application under the System -> Debug category. In this section, you can configure settings of the system’s debugging tools. The section is divided into the following subcategories:
General
Setting | Description |
Disable debugging | Globally disables all debugs, regardless of individual debug settings. |
Debug Import/Export | If disabled, the system does not log debug information for the pages of the Import/Export interface. For performance reasons, it is recommended to leave this option disabled unless you need to debug the Import/Export process. |
Debug resources | If disabled, the debug ignores all resource requests (GetResource and GetCSS). |
Debug scheduler | If disabled, the debug ignores all operations executed by the scheduler. |
All
Setting | Description |
Debug everything everywhere | Enables:
|
Enable all debugs | Enables all debugs and the corresponding tabs in the Debug application. |
Include UI pages in all debugs | If checked (true), all enabled debugs include actions performed on the pages of the user interface. |
Default log length | Sets the default maximum length of the debug log in the Debug application. The default log length is used by debug types that do not have their own log length set. |
Display stack information in every debug | If enabled, the system tracks the code stack for all debug types and displays the information in the Context column of the debug interface in the Debug application. |
Log everything to file | Enables logging of all possible operations into .log files in the ~/App_Data/ folder (including the Event log and email sending log). |
Cache access
Setting | Description |
Enable cache access debug | Enables cache access debugging and the Cache access tab in the Debug application. |
Debug cache access of UI pages | If enabled, access to data cached for pages of the administration interface will also be included in the cache access debug. This option requires cache access debugging to be enabled. |
Cache access debug log length | Sets the maximum length of the cache access debug log on the Debug -> Cache access tab, i.e. the number of requests for which debug information is preserved and displayed on the tab. If empty, value of the Default log length setting (or the CMSDebugEverythingLogLength key) is used. |
Display stack information | If enabled, the system tracks the code stack when debugging cache access and displays the information in the Context column. This information is only available in the debugging UI, not in the debug log written into the logcache.log file. |
Log cache access to file | If enabled, cache access debug log is saved into the logcache.log file in the ~\App_Data folder. This option does not require cache access debugging to be enabled. |
SQL queries
Setting | Description |
Enable SQL query debug | Enables SQL query debugging and the SQL queries tab in the Debug application. |
Debug SQL queries of UI pages | If enabled, SQL queries called by pages of the administration interface will also be included in the SQL query debug. This option requires SQL query debugging to be enabled. |
SQL query debug log length | Sets the maximum length of the SQL query debug log on the Debug -> SQL queries tab, i.e. the number of requests for which debug information is preserved and displayed on the tab. If empty, value of the Default log length setting (or the CMSDebugEverythingLogLength key) is used. |
Debug SQL connections | If enabled, SQL connection operations (new, open, close) are logged in the SQL query debug log. |
Display stack information | If enabled, the system tracks the code stack when debugging SQL queries and displays the information in the Context column. This information is only available in the debugging UI, not in the debug log written into the logsql.log file. |
Log SQL queries to file | If enabled, SQL query debug log is saved into the logsql.log file in the ~\App_Data folder. This option does not require SQL query debugging to be enabled. |
IO
Setting | Description |
Enable IO operation debug | Enables IO operation debugging and the IO tab in the Debug application. |
Debug IO operations of UI pages | If enabled, IO operations called by pages of the administration interface will also be included in the IO operation debug. This option requires IO operation debugging to be enabled. |
IO operation debug log length | Sets the maximum length of the IO operation debug log on the Debug -> IO tab, i.e. the number of requests for which debug information is preserved and displayed on the tab. If empty, value of the Default log length setting (or the CMSDebugEverythingLogLength key) is used. |
Display stack information | If enabled, the system tracks the code stack when debugging IO operations and displays the information in the Context column. This information is only available in the debugging UI, not in the debug log written into the logfiles.log file. |
Log IO operations to file | If enabled, IO operation debug log is saved into the logfiles.log file in the ~\App_Data folder. This option does not require IO operation debugging to be enabled. |
Security
Setting | Description |
Enable security debug | Enables security operation debugging and the Security tab in the Debug application. |
Debug security operations of UI pages | If enabled, security checks performed by pages of the administration interface will also be included in the security debug. This option requires security debugging to be enabled. |
Security debug log length | Sets the maximum length of the security debug log on the Debug -> Security tab, i.e. the number of requests for which debug information is preserved and displayed on the tab. If empty, value of the Default log length setting (or the CMSDebugEverythingLogLength key) is used. |
Display stack information | If enabled, the system tracks the code stack when debugging security and displays the information in the Context column. This information is only available in the debugging UI, not in the debug log written into the logSecurity.log file. |
Log security operations to file | If enabled, security debug log is saved into the logSecurity.log file in the ~\App_Data folder. This option does not require security debugging to be enabled. |
Macros
Setting | Description |
Enable macro debug | Enables macro debugging and the Macros tab in the Debug application. |
Enable detailed macro debug | If enabled, the macro debug displays the results of all sub‑elements used within macro expressions. This allows you to check the exact data content of a macro’s components during each step of the resolving process. Detailed macro debugging is highly recommended if you encounter problems with complex expressions. If disabled, the debug only shows the final result of each macro. You can enable the detailed debug only for specific expressions by adding the |(debug) parameter to the given macro. |
Debug macros resolved on UI pages | If enabled, macros resolved on the pages of the administration interface are also included in the macro debug. Macro debugging must also be enabled. |
Macro debug log length | Sets the maximum length of the macro debug log, i.e. the number of requests for which the macro debug stores information. If empty, the value of the Default log length setting (or the CMSDebugEverythingLogLength key) is used. |
Display stack information | If enabled, the system tracks the code stack when debugging macros and displays the information in the Context column. This information is only available in the debugging UI, not in the debug log written into the logmacros.log file. |
Log macros to file | If enabled, the system saves the macro debug log into the logmacros.log file in the ~\App_Data folder. Macro debugging must also be enabled. |
Web farm
Setting | Description |
Enable web farm debug | Enables request debugging and the Web farm tab in the Debug application. |
Debug web farm operations of UI pages | If enabled, operations performed via the administration interface will also be included in the web farm debug. This option requires web farm debugging to be enabled. |
Web farm debug log length | Sets the maximum length of the web farm debug log on the Debug -> Requests tab, i.e. the number of requests for which debug information is preserved and displayed on the tab. If empty, value of the Default log length setting (or the CMSDebugEverythingLogLength key) is used. |
Display stack information | If enabled, the system tracks the code stack when debugging web farm operations and displays the information in the Context column. This information is only available in the debugging UI, not in the debug log written into the logwebfarm.log file. |
Log web farm operations to file | If enabled, web farm debug log is saved into the logwebfarm.log file in the ~\App_Data folder. This option does not require web farm debugging to be enabled. |
Event handlers
Setting | Description |
Enable handlers debug | Enables event handlers debugging and the Event handlers tab in the Debug application. |
Debug handlers in UI pages | If enabled, operations performed via the administration interface will also be included in the event handlers debug. This option requires event handlers debugging to be enabled. |
Handlers debug log length | Sets the maximum length of the event handlers debug log on the Debug -> Event handlers tab, i.e. the number of requests for which debug information is preserved and displayed on the tab. If empty, value of the Default log length setting (or the CMSDebugEverythingLogLength key) is used. |
Display stack information | If enabled, the system tracks the code stack when debugging event handlers and displays the information in the Context column. This information is only available in the debugging UI, not in the debug log written into the logwebfarm.log file. |
Log handlers to file | If enabled, event handlers debug log is saved into the logwHandlers.log file in the ~\App_Data folder. This option does not require event handlers debugging to be enabled. |