DebugHelper Class

Debug helping methods.

Inheritance Hierarchy

System.Object
  CMS.Base.DebugHelper

Namespace: CMS.Base
Assembly: CMS.Base (in CMS.Base.dll) Version: 12.0.0

Syntax

public static class DebugHelper

The DebugHelper type exposes the following members.

Properties

	Name	Description
Public property Static member	AnyDebugEnabled	Returns true if any debug is enabled.
Public property Static member	AnyDebugLogToFileEnabled	Returns true if any debug has the logging to file enabled.
Public property Static member	AnyLiveDebugEnabled	Returns true if any LiveDebug is enabled.
Public property Static member	DebugAllForEverything	Debug all pages for everything.
Public property Static member	DebugDisabled	Indicates whether all debugs are disabled.
Public property Static member	DebugEverything	Debug Everything?
Public property Static member	DebugEverythingEverywhere	Debug Everything everywhere?
Public property Static member	DebugEverythingLive	Debug Everything live?
Public property Static member	DebugImportExport	If false, pages with Import/Export are excluded from debugs.
Public property Static member	DebugResources	If false, all the resources (GetResource a GetCSS) requests are ignored in debugging.
Public property Static member	DebugScheduler	If false, scheduler tasks are ignored in debugs.
Public property Static member	DebugStackForEverything	Track stack when debugging everything.
Public property Static member	EverythingLogLength	Maximum length of the Everything log in number of requests.
Public property Static member	LogEverythingToFile	Logs operations for everything?
Public property Static member	LogFolder	File path, to which the debug logs operations
Public property Static member	MaxLogSize	Maximum debug log size
Public property Static member	RegisteredDebugs	Returns the list of registered debugs
Public property Static member	RegisteredDebugsCount	Number of registered debugs
Public property Static member	ShowDebugOnLiveSite	If true, the debug control are allowed in the live site view

Methods

	Name	Description
Public method Static member	CanDebug	Returns true if the given method can be included in debug
Public method Static member	ClearLogs	Clears all logs within all debugs
Public method Static member	CreateLogTable	Creates new debug log table
Public method Static member	DisableDebug	Disables all debugs in the context of current request / thread
Public method Static member	DisableSchedulerDebug	Disables all debugs if DebugHelper.DebugScheduler is false, returns original settings which can be restored afterwards.
Public method Static member	EnsureDiskPath	Checks if all folders of the given path exist and if not, it creates them.
Public method Static member	EnsureDurationColumn	Ensures the Duration column in the datateble of Request log.
Public method Static member	FindRequestLogs	Finds the collection of request logs by the given request GUID
Public method Static member	GetContext	Gets the context for debug operation
Public method Static member	GetDebugBoolSetting(String)	Returns logical or of setting in web.config and setting.
Public method Static member	GetDebugBoolSetting(String, Boolean, Boolean)	Returns logical or of setting in web.config and setting.
Public method Static member	GetDebugCounter	Returns state of the debug counter.
Public method Static member	GetDebugLogLength(String)	Returns log length of given debug (looks first to the settings, if the value is not defined, takes value from web.config, if not defined even in web.config, returns 10 as default value).
Public method Static member	GetDebugLogLength(String, Int32)	Returns log length of given debug (looks first to the settings, if the value is not defined, takes value from web.config, if not defined even in web.config, returns 10 as default value).
Public method Static member	GetRequestUrl	Gets the request URL for the log purposes.
Public method Static member	GetSettings	Gets the settings for a given debug
Public method Static member	GetStack	Gets the current stack.
Public method Static member	GetThreadStack	Gets the current stack.
Public method Static member	IsDebugEnabled	Returns true if the given debug is enabled
Public method Static member	RegisterDebug	Registers the debug to the debug helper
Public method Static member	RegisterLogs	Registers all request logs to the appropriate log lists.
Public method Static member	ReleaseContext	Releases the last context.
Public method Static member	ResetDebugSettings	Sets all the debug settings to null and causes them to be reloaded. This method is synchronized through all web farm servers.
Public method Static member	RestoreDebugSettings	Restores the debug settings from array of values.
Public method Static member	SetApplicationStartDebug	Returns true if the given debug is enabled
Public method Static member	SetContentPageDebug	Sets the debug flags for content page
Public method Static member	SetContext	Sets the debugging context.
Public method Static member	SetInitialDebug	Sets the initial debugging settings.
Public method Static member	SetSystemPageDebug	Sets the debug flags for system page
Public method Static member	WriteRequestLogs	Writes all request logs to the files