|
Debug |
|
|
|
|
|
|
Debug |
|
|
|
|
Debug
On this page, you can configure settings of system debugging. Each of the settings in this section has a related web.config key that can be added to the appSettings section of the web.config file in order to achieve the same configuration. The tables below list particular settings along with their related web.config keys and provide explanation of their functionality.
It may happen that you specify different configuration in the settings and in the web.config file. In such cases, boolean settings (true/false) need to be enabled at least in one place (in web.config or in settings) in order to be enabled, while log lengths specified in Site Manager -> Settings have higher priority than log lengths specified in the web.config.
General
Setting |
Web.config key |
Description |
Disable debugging |
CMSDisableDebug |
Globally disables all debugs, regardless of individual debug settings. |
Debug Import/Export |
CMSDebugImportExport |
If disabled, debug information is not logged for the Import/Export user interface. To optimize system performance, it is recommended to have this option disabled unless you really need to debug the Import/Export process. |
Debug resources |
CMSDebugResources |
If false, all resource requests (GetResource and GetCSS) are ignored by all debugs. |
Debug scheduler |
CMSDebugScheduler |
If false, all scheduler operations are excluded from all debugs. |
Cache access
Setting |
Web.config key |
Description |
Enable cache access debug |
CMSDebugCache |
Enables cache access debugging and the Cache access tab in Site Manager -> Administration -> System -> Debug. |
Display cache access debug on live site |
CMSDebugCacheLive |
If enabled, cache access debug information is also displayed at the bottom of each live site page. This option requires cache access debugging to be enabled. |
Debug cache access of UI pages |
CMSDebugAllCaches |
If enabled, access to data cached for pages of the administration interface (CMS Desk and Site Manager) will also be included in the cache access debug. This option requires cache access debugging to be enabled. |
Log cache access to file |
CMSLogCache |
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. |
Cache access debug log length |
CMSDebugCacheLogLength |
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 |
CMSDebugCacheStack |
If enabled, stack is tracked when debugging cache access and is displayed in the Context column. This information is only available in the debugging UI and on the live site, not in the debug log written into the logcache.log file. |
SQL queries
Setting |
Web.config key |
Description |
Enable SQL query debug |
CMSDebugSQLQueries |
Enables SQL query debugging and the SQL queries tab in Site Manager -> Administration -> System -> Debug. |
Display SQL query debug on live site |
CMSDebugSQLQueriesLive |
If enabled, SQL query debug information is also displayed at the bottom of each live site page. This option requires SQL query debugging to be enabled. |
Debug SQL queries of UI pages |
CMSDebugAllSQLQueries |
If enabled, SQL queries called by pages of the administration interface (CMS Desk and Site Manager) will also be included in the SQL query debug. This option requires SQL query debugging to be enabled. |
Log SQL queries to file |
CMSLogSQLQueries |
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. |
SQL query debug log length |
CMSDebugSQLQueriesLogLength |
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 |
CMSDebugSQLConnections |
If enabled, SQL connection operations (new, open, close) are logged in the SQL query debug log. |
Display stack information |
CMSDebugSQLQueriesStack |
If enabled, stack is tracked when debugging SQL queries and is displayed in the Context column. This information is only available in the debugging UI and on the live site, not in the debug log written into the logsql.log file. |
IO
Setting |
Web.config key |
Description |
Enable IO operation debug |
CMSDebugFiles |
Enables IO operation debugging and the IO tab in Site Manager -> Administration -> System -> Debug. |
Display IO operation debug on live site |
CMSDebugFilesLive |
If enabled, IO operation debug information is also displayed at the bottom of each live site page. This option requires IO operation debugging to be enabled. |
Debug IO operations of UI pages |
CMSDebugAllFiles |
If enabled, IO operations called by pages of the administration interface (CMS Desk and Site Manager) will also be included in the IO operation debug. This option requires IO operation debugging to be enabled. |
Log IO operations to file |
CMSLogFiles |
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. |
IO operation debug log length |
CMSDebugFilesLogLength |
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 |
CMSDebugFilesStack |
If enabled, stack is tracked when debugging IO operations and is displayed in the Context column. This information is only available in the debugging UI and on the live site, not in the debug log written into the logfiles.log file. |
Page ViewState
Setting |
Web.config key |
Description |
Enable ViewState debug |
CMSDebugViewState |
Enables ViewState debugging and the Page ViewState tab in Site Manager -> Administration -> System -> Debug. |
Display ViewState debug on live site |
CMSDebugViewStateLive |
If enabled, ViewState debug information is also displayed at the bottom of each live site page. This option requires ViewState debugging to be enabled. |
Debug ViewState of UI pages |
CMSDebugAllViewStates |
If enabled, ViewState of administration interface pages (CMS Desk and Site Manager) will also be included in the ViewState debug. This option requires ViewState debugging to be enabled. |
ViewState debug log length |
CMSDebugViewStateLogLength |
Sets the maximum length of the ViewState debug log on the Debug -> ViewState 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. |
Output
Setting |
Web.config key |
Description |
Enable output debug |
CMSDebugOutput |
Enables page output debugging and the Output tab in Site Manager -> Administration -> System -> Debug. |
Debug output of UI pages |
CMSDebugAllOutputs |
If enabled, output of administration interface pages (CMS Desk and Site Manager) will also be included in the output debug. This option requires output debugging to be enabled. |
Log output to file |
CMSLogOutputToFile |
If enabled, output debug log is saved into the logOutput.log file in the ~\App_Data folder. This option does not require output debugging to be enabled. |
Output debug log length |
CMSDebugOutputToFile |
Sets the maximum length of the output debug log on the Debug -> Output 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. |
Security
Setting |
Web.config key |
Description |
Enable security debug |
CMSDebugSecurity |
Enables security operation debugging and the Security tab in Site Manager -> Administration -> System -> Debug. |
Display security debug on live site |
CMSDebugSecurityLive |
If enabled, security operation debug information is also displayed at the bottom of each live site page. This option requires security debugging to be enabled. |
Debug security operations of UI pages |
CMSDebugAllSecurity |
If enabled, security checks performed by pages of the administration interface (CMS Desk and Site Manager) will also be included in the security debug. This option requires security debugging to be enabled. |
Log security operations to file |
CMSLogSecurity |
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. |
Security debug log length |
CMSDebugSecurityLogLength |
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 |
CMSDebugSecurityStack |
If enabled, stack is tracked when debugging security and is displayed in the Context column. This information is only available in the debugging UI and on the live site, not in the debug log written into the logSecurity.log file. |
Macros
Setting |
Web.config key |
Description |
Enable macro debug |
CMSDebugMacros |
Enables macro debugging and the Macros tab in Site Manager -> Administration -> System -> Debug. |
Display macro debug on live site |
CMSDebugMacrosLive |
If enabled, macro debug information is also displayed at the bottom of each live site page. This option requires macro debugging to be enabled. |
Debug macros resolved on UI pages |
CMSDebugAllMacros |
If enabled, macros resolved on pages of the administration interface (CMS Desk and Site Manager) will also be included in the macro debug. This option requires macro debugging to be enabled. |
Log macros to file |
CMSLogMacros |
If enabled, macro debug log is saved into the logmacros.log file in the ~\App_Data folder. This option does not require macro debugging to be enabled. |
Macro debug log length |
CMSDebugMacrosLogLength |
Sets the maximum length of the macro debug log on the Debug -> Macros 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 |
CMSDebugMacrosStack |
If enabled, stack is tracked when debugging cache macros and is displayed in the Context column. This information is only available in the debugging UI and on the live site, not in the debug log written into the logmacros.log file. |
Analytics
Setting |
Web.config key |
Description |
Enable web analytics debug |
CMSDebugAnalytics |
Enables web analytics debugging and the Analytics tab in Site Manager -> Administration -> System -> Debug. |
Display web analytics debug on live site |
CMSDebugAnalyticsLive |
If enabled, web analytics debug information is also displayed at the bottom of each live site page. This option requires web analytics debugging to be enabled. |
Log web analytics to file |
CMSLogAnalytics |
If enabled, web analytics debug log is saved into the loganalytics.log file in the ~\App_Data folder. This option does not require web analytics debugging to be enabled. |
Web analytics debug log length |
CMSDebugAnalyticsLogLength |
Sets the maximum length of the web analytics debug log on the Debug -> Analytics 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 |
CMSDebugAnalyticsStack |
If enabled, stack is tracked when debugging web analytics and is displayed in the Context column. This information is only available in the debugging UI and on the live site, not in the debug log written into the loganalytics.log file. |
Requests
Setting |
Web.config key |
Description |
Enable request debug |
CMSDebugRequests |
Enables request debugging and the Requests tab in Site Manager -> Administration -> System -> Debug. |
Display request debug on live site |
CMSDebugRequestsLive |
If enabled, request debug information is also displayed at the bottom of each live site page. This option requires request debugging to be enabled. |
Debug UI page requests |
CMSDebugAllRequests |
If enabled, administration interface (CMS Desk and Site Manager) page requests will also be included in the macro debug. This option requires request debugging to be enabled. |
Log requests to file |
CMSLogRequests |
If enabled, request debug log is saved into the logRequests.log and logRequestsUrls.log files in the ~\App_Data folder. The first file contains the full log, while the second one only lists requested URLs. This option does not require request debugging to be enabled. |
Request debug log length |
CMSDebugRequestsLogLength |
Sets the maximum length of the request 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 |
CMSDebugRequestsStack |
If enabled, stack is tracked when debugging requests and is displayed in the Context column. This information is only available in the debugging UI and on the live site, not in the debug log written into the logRequests.log file. |
Web farm
Setting |
Web.config key |
Description |
Enable web farm debug |
CMSDebugWebFarm |
Enables request debugging and the Web farm tab in Site Manager -> Administration -> System -> Debug. |
Debug web farm operations of UI pages |
CMSDebugAllWebFarm |
If enabled, operations performed via the administration interface (CMS Desk and Site Manager) will also be included in the web farm debug. This option requires web farm debugging to be enabled. |
Log web farm operations to file |
CMSLogWebFarm |
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. |
Web farm debug log length |
CMSDebugWebFarmLogLength |
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 |
CMSDebugWebFarmStack |
If enabled, stack is tracked when debugging web farm operations and is displayed in the Context column. This information is only available in the debugging UI and on the live site, not in the debug log written into the logwebfarm.log file. |
All
Setting |
Web.config key |
Description |
Debug everything everywhere |
CMSDebugEverythingEverywhere |
Enables all debugs, includes UI pages in all debugs and ensures that the debugs are displayed both in the Site Manager -> Administration -> System -> Debug interface and on the live site. |
Enable all debugs |
CMSDebugEverything |
Enables all debugs and ensures that the corresponding tabs are displayed in Site Manager -> Administration -> System -> Debug. |
Display all debugs on live site |
CMSDebugEverythingLive |
If enabled, debug information of all debug types is displayed at the bottom of each live site page. This only applies to debugs that are already enabled. |
Include UI pages in all debugs |
CMSDebugAllForEverything |
If enabled, actions performed on UI pages are included in all debugs. This only applies to debugs that are already enabled. |
Log everything to file |
CMSLogEverythingToFile |
Enables logging of all possible operations (including the Event log and E-mail sending log) into .log files stored in the ~/App_Data/ folder. |
Default log length |
CMSDebugEverythingLogLength |
Sets the default maximum length of all debugs on the respective tabs in Site Manager -> Administration ->System -> Debug. This value is used if no log length is configured for the respective type of debug. |
Display stack information in every debug |
CMSDebugStackForEverything |
If enabled, stack is tracked by all debugs and is displayed on the respective tabs in Site Manager -> Administration -> System -> Debug. |
More information can be found in Developer's Guide -> Development -> Debugging and system information.