Debug Parameters
- Last UpdatedFeb 02, 2024
- 3 minute read
The Citect.ini file contains the following debug parameters:
-
[Debug]ArchiveFiles - Archives log files once maximum size is reached.
-
[Debug]CategoryFilter - Enables log message filtering by component category.
-
[Debug]CategoryFilterMode - Enables or disables logging of categories declared by the [Debug]CategoryFilter value.
-
[Debug]ChromiumDevToolsPort - Enables debugging for a Web Content object located on a Plant SCADA graphics page.
-
[Debug]CodeDebug - Enables Cicode debugging for the process containing a specified component.
-
[Debug]CrashOnError - Determines whether Plant SCADA generates a protection violation whenever it detects a software error, for example, a memory corruption error such as "Invalid Heap" , "Already Free", 'try to free bad or unknown memory" or "local free no heap".
-
[Debug]CrashReserveManagedMB - Specifies how much memory is reserved at startup to allow crash handling to occur for managed code.
-
[Debug]CrashReserveNativeMB - Specifies how much memory is reserved at startup to allow crash handling to occur for native code.
-
[Debug]DBLogEnable - Controls whether alarm database logs are enabled.
-
[Debug]DBLogMaxFiles - Controls the maximum number of alarm database log files to keep for the current run of the server.
-
[Debug]DBLogMaxSize - Controls the maximum size of an individual alarm database log file.
-
[Debug]DBLogOldFiles - Controls the maximum number of runs to keep for alarm database log files.
-
[Debug]DebugAllTrans - Allows TRAN session logging to be turned on or off.
-
[Debug]DebugLogHistoryFiles - Determines how many "debug.<process name>.log" files are kept when rolled over.
-
[Debug]DebugLogSize - Sets the maximum size of the "debug.<process name>.log" file.
-
[Debug]DriverTrace -An extension of the Kernel that can be used to display the commands and information being issued to a driver.
-
[Debug]DriverTracePort - Allows a driver trace to be limited to a particular driver port.
-
[Debug]DriverTraceMask - Defines a bit mask that can be used to either include or exclude driver commands from a driver trace.
-
[Debug]DriverCheck - Defines the maximum number of data buffer elements to be displayed in a driver trace.
-
[Debug]DebugAllTrans - Allows TRAN sessions to be logged to the Kernel window for debugging purposes.
-
[Debug]DisableWinTop - Allows you to minimize the likelihood of windows or popups from being forced to the top of the screen.
-
[Debug]DriverCheck - Monitors the structure used to talk to drivers.
-
[Debug]DrWatson - Starts DrWatson when Plant SCADA starts running (if DrWatson is not already running).
-
[Debug]EnableHardwareAlarmLogging - Enables or disables logging of stack traces for hardware alarms to syslog.
-
[Debug]EnableLogging - Enables or disables the logging mechanism.
-
[Debug]EnablePSICounters - Enables or disables the Citect.Platform.PSI.Client and Citect.Platform.PSI.Server performance counters.
-
[Debug]EnableTaskFrameworkCounters - Enables or disables Citect.Platform.Tasks.TaskManager, Citect.Platform.Tasks.TaskQueue and Citect.Platform.Tasks.TaskThread performance counters.
-
[Debug]EnableTransportCounters - Enables or disables Citect.Platform.Transport.SessionTransport and Citect.Platform.Transport.TransportHost performance counters.
-
[Debug]EnableReloadLogging - Enables additional debugging output for server reloads.
-
[Debug]FlushPeriod - Sets the period at which Tracelog file entries are to be flushed to the file system.
-
[Debug]LogDirect - Indicates whether to log directly to a log file or via the Kernel logging system.
-
[Debug]LogsDriveMinimumFreeSpace - Specifies the minimum amount of free space required on the drive that hosts the log directory.
-
[Debug]LogShutDown - Only required if ShutdownProtect is set to log the shutdown sequence.
-
[Debug]MaximumFileSize - Sets the maximum size of an archive file.
-
[Debug]MaxMiniDumps - Sets the maximum number of mini-dump files that are stored in the log directory.
-
[Debug]MaxTableOutputLength - When set will limit the length of tables when they are output to a kernel.dat file.
-
[Debug]Memory - Obsolete in v7.30.
-
[Debug]Menu - Determines whether the Kernel option is displayed on the control menu of the Plant SCADA runtime system.
-
[Debug]MiniDumpType - Defines the type of mini-dump that is performed.
-
[Debug]Priority - Allows you to filter logging messages by priority.
-
[Debug]SeverityFilter - Enables log message filtering by severity.
-
[Debug]SeverityFilterMode - Enables or disables logging of severities declared by the [Debug]SeverityFilter value.
-
[Debug]Shutdown - Determines whether the Shutdown option is displayed on the control menu of the Plant SCADA runtime system.
-
[Debug]ShutDownProtect - Enables shutdown protection.
-
[Debug]SnapshotEnable - Controls whether periodic diagnostic snapshots are enabled for the alarm database.
-
[Debug]SnapshotInterval - Sets the number of minutes between periodic alarm database snapshots.
-
[Debug]SnapshotMaxFiles - Controls the maximum number of alarm database snapshots to keep for the current run of the server.
-
[Debug]SnapshotMaxSize - Controls the maximum size of an alarm database snapshot.
-
[Debug]SnapshotOldFiles - Controls the maximum number of runs to keep for alarm database snapshot files.
-
[Debug]SysErrDsp - Disables many system error logs and popup boxes.
-
[Debug]SysLogArchive - Causes the syslog to automatically timestamp files as they are rolled over.
-
[Debug]SysLogSize - Sets the size of the SYSLOG.DAT file.
-
[Debug]UserTraceMode - Allows you to filter messages logged to the syslog.dat.
See Also
Related Links
- [Debug]ArchiveFiles
- [Debug]CategoryFilter
- [Debug]CategoryFilterMode
- [Debug]ChromiumDevToolsPort
- [Debug]CodeDebug
- [Debug]CrashOnError
- [Debug]CrashReserveManagedMB
- [Debug]CrashReserveNativeMB
- [Debug]DBLogEnable
- [Debug]DBLogMaxFiles
- [Debug]DBLogMaxSize
- [Debug]DBLogOldFiles
- [Debug]DebugAllTrans
- [Debug]DebugLogHistoryFiles
- [Debug]DebugLogSize
- [Debug]DisableWinTop
- [Debug]DriverCheck
- [Debug]DriverTrace
- [Debug]DriverTracePort
- [Debug]DriverTraceMask
- [Debug]DriverTraceElements
- [Debug]DrWatson
- [Debug]EnableHardwareAlarmLogging
- [Debug]EnableLogging
- [Debug]EnablePSICounters
- [Debug]EnableReloadLogging
- [Debug]EnableTaskFrameworkCounters
- [Debug]EnableTransportCounters
- [Debug]FlushPeriod
- [Debug]LogDirect
- [Debug]LogsDriveMinimumFreeSpace
- [Debug]LogShutDown
- [Debug]MaximumFileSize
- [Debug]MaxMiniDumps
- [Debug]MaxTableOutputLength
- [Debug]Menu
- [Debug]MiniDumpType
- [Debug]Priority
- [Debug]SeverityFilter
- [Debug]SeverityFilterMode
- [Debug]Shutdown
- [Debug]ShutDownProtect
- [Debug]SnapshotEnable
- [Debug]SnapshotInterval
- [Debug]SnapshotMaxFiles
- [Debug]SnapshotMaxSize
- [Debug]SnapshotOldFiles
- [Debug]SysErrDsp
- [Debug]SysLogArchive
- [Debug]SysLogSize
- [Debug]UserTraceMode