Module: settings/js/widgets/logging-widget

Classes

LoggingWidget

Type Definitions

LogFileConfiguration

Properties:

Name	Type	Description
compression	string	The compression setting for the log file. Can be either NONE, ZIP or GZIP.
enabled	boolean	True if log file logging is enabled; false otherwise
maxHistory	number	The maximum number of files that will be kept
maxSize	number	The maximum size of a log file
rolloverFrequency	string	How often a log file is rotated. Can be DAILY or MONTHLY

Source:

• widgets/logging-widget.js, line 136

LoggingConfiguration

Properties:

Name	Type	Description
logFile	LogFileConfiguration	Log file configuration
syslog	SyslogConfiguration	Syslog server configuration

Source:

• widgets/logging-widget.js, line 150

LoggingWidgetOptions

Extends WidgetOptions

Properties:

Name	Type	Description
testURL	string	Url called to test configuration

Source:

• widgets/logging-widget.js, line 17

LoggingWidgetStrings

Extends WidgetStrings

Properties:

Name	Type	Description
compression	string	Label for the compression dropdown
daily	string	Label for daily rollover option
gzip	string	Label for the gzip compression option
invalidMaxHistory	string	Message displayed when the max history option is invalid
invalidMaxSize	string	Message displayed when the maximum file size option is invalid
invalidSyslogServer	string	Message displayed when the syslog server configuration is invalid
logFile	string	Label for the log file section
logFileToggle	string	Label for the button that enables file logging
maxHistory	string	Label for the max history option
maxSize	string	Label for maximum file size option
monthly	string	Label for monthly rollover option
none	string	Label for the no compression option
rolloverFrequency	string	Label for the rollover frequency options
syslog	string	Label for the syslog section
syslogHostPlaceholder	string	Placeholder for the syslog server host
syslogPortPlaceholder	string	Placeholder for the syslog server port
syslogToggle	string	Label for the button that enables syslog logging
testButton	string	Label for the test syslog settings button
zip	string	Label for the zip compression option

Source:

• widgets/logging-widget.js, line 23

SyslogConfiguration

Properties:

Name	Type	Description
enabled	boolean	True if syslog server logging is enabled; false otherwise
host	string	The host of the syslog server
port	number	The port of the syslog server

Source:

• widgets/logging-widget.js, line 144