Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

As an exception to this rule the watchdog log files for Controller and Agent , which are not subject to log rotation. The watchdog log file captures any output before the respective application is started, e.g. output of the Controller Windows Service, and therefore does not make use of Log4j2 for logging. The watchdog log files therefore should not grow but should report a few lines only in situations when a Controller or Agent could not be started.

...

  • To modify the time zone that is applied to log entries and to the point in time of log rotation modify <Property name="TimeZone">Etc/UTC</Property>. The time zone is specified during the startscript by setting by the start script that sets the environment variable SCHEDULER_TZ.
  • To enable debug mode modify <property name="RootLogLevel">INFO</property> and <property name="LogLevelOfDebugLog">OFF</property> to DEBUG.
  • To change the log retention period modify <Property name="RetainDays">30d</Property> to some other value. Note the use of the suffixes d(ays), w(eeks), m(onths).
  • To limit the max. size of individual log files modify <Property name="MaxSizePerFile">100MB</Property> to some other value. Note the use of the units MB, GB.
  • To limit space consumption of all log files modify <Property name="MaxSizeOfRolledOverFiles">5GB</Property> to some other value. Note the use of the units MB, GB.

...

Code Block
languagexml
titleJOC Cockpit log4j2.xml
linenumberstrue
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
	<Properties>
		<Property name="TimeZone">Etc/UTC</Property>
		<Property name="RetainDays">30d</Property>
		<Property name="MaxSizeOfRolledOverFiles">5 GB</Property>
		<Property name="MaxSizePerFile">100 MB</Property>
		
		<!-- Log level of the Root Logger. -->
		<Property name="RootLogLevel">INFO</Property>
		<!-- Configurations for 2nd debug log files (OFF|DEBUG|TRACE) 
			 If one of these values is set to DEBUG or TRACE then the above 
			 RootLogLevel has to have the same value.
		-->
		<Property name="JocLogLevel">OFF</Property>
		<Property name="ClusterLogLevel">OFF</Property>
		<Property name="HistoryLogLevel">OFF</Property>
		<Property name="DailyPlanLogLevel">OFF</Property>
		<Property name="CleanupLogLevel">OFF</Property>
        <Property name="ServiceMonitorLogLevel">DEBUG</Property>
		<Property name="AuthLogLevel">OFF</Property>
		<Property name="ConnectionPoolLogLevel">OFF</Property>
	</Properties>
    <Appenders>
		<!-- Appender for audit log -->
		<RollingFile name="AuditLogAppender" 
			fileName="${sys:user.dir}/logs/audit.log" 
			filePattern="${sys:user.dir}/logs/audit-%d{yyyy-MM}-%i.log.gz"
			createOnDemand="true">
			<PatternLayout 
				pattern="%d{ISO8601}{${TimeZone}} %-5p %m%throwable{short}%n" 
				charset="UTF-8"/>
			<Policies>
				<TimeBasedTriggeringPolicy/>
				<SizeBasedTriggeringPolicy size="${MaxSizePerFile}"/>
			</Policies>
			<DefaultRolloverStrategy fileIndex="nomax"/>
		</RollingFile>

        <!-- Appender for connection pool log -->
            ...
        </Appender>
    </Appenders>
        ...
<Configuration>

Explanation:

  • To modify change the time zone that is applied to log entries and to the point in time of log rotation modify <Property name="TimeZone">Etc/UTC</Property>. The time zone is specified during installation.
  • To change the log retention period modify <Property name="RetainDays">30d</Property> to some other value. Note the use of the suffixes d(ays), w(eeks), m(onths).
  • To limit space consumption of all log files modify <Property name="MaxSizeOfRolledOverFiles">5 GB</Property> to some other value. Note the use of the units MB, GB.
  • To limit the max. size of individual log files modify <Property name="MaxSizePerFile">100 MB</Property> to some other value. Note the use of the units MB, GB.
  • To enable debug mode modify <property name="RootLogLevel">INFO</property> to DEBUG. In addition modify the value of one or more of the following properties to enable debug output with the respective debug log file: 


    Debug Log FileProperty
    joc-debug.log<Property name="JocLogLevel">DEBUG</Property>
    service-cluster-debug.log<Property name="ClusterLogLevel">DEBUG</Property>
    service-history-debug.log<Property name="HistoryLogLevel">DEBUG</Property>
    service-dailyplan-debug.log<Property name="DailyPlanLogLevel">DEBUG</Property>
    service-cleanup-debug.log<Property name="CleanupLogLevel">DEBUG</Property>
    authentication-debug.log<Property name="AuthLogLevel">DEBUG</Property>
    connection-pool-debug.log<Property name="ConnectionPoolLogLevel">DEBUG</Property>

...