Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Minor changes

...

Code Block
languagexml
titleController, Agent log4j2.xml
linenumberstrue
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<configuration status="WARN" shutdownHook="disable">
    <Properties>
		<Property name="TimeZone">${env:SCHEDULER_TZ:-Etc/UTC}</Property>
		<Property name="LogDir">${env:SCHEDULER_LOGS:-logs}</Property>
		<Property name="LogBasename">${env:SCHEDULER_APPNAME:-controller}</Property>
		
		<Property name="RetainDays">30d</Property>
		<Property name="MaxSizeOfRolledOverFiles">5GB</Property>
		<Property name="MaxSizePerFile">100MB</Property>
		
		<!-- Log level of the Root Logger. -->
		<Property name="RootLogLevel">INFO</Property>
		
		<!-- Configuration for a 2nd debug log file (OFF|DEBUG|TRACE) 
			 If this value is set to DEBUG or TRACE then the above 
			 RootLogLevel has to have the same value.
		-->
		<Property name="LogLevelOfDebugLog">OFF</Property>
		
	</Properties>
        ...
<Configuration>

ExplanationsExplanation:

  • To enable debug mode modify <property name="RootLogLevel">INFO</property> and <property name="LogLevelOfDebugLog">OFF</property> to DEBUG.

...

Code Block
languagexml
titleJOC Cockpit log4j2.xml
linenumberstrue
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
    <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="AuthLogLevel">OFF</Property>
        <Property name="ConnectionPoolLogLevel">OFF</Property>
    </Properties>
    ...
<Configuration>

ExplanationsExplanation:

  • 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 accordingly to enable debug output with the respective debug log file: 


    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>

Log Rotation Settings

When switching to higher log levels such as DEBUG, TRACE then consider increased disc space consumption.

By default JS7 components are configured to limit disk space consumption and to limit the retention period for log files. Consider Refer to the instructions from in the JS7 - Log Rotation article to adjust settings for the max. log file size and retention period.

...

Applying debug options requires the respective JS7 component in question to be restarted.

Applying Debug Options to Controller and Agent

...

Windows Operating Systems

For Windows, the JAVA_OPTIONS environment variable can be set before running the Controller or Agent start script like this: 

  • Code Block
    languagebash
    titleWindows example to run the Controller start script with debug options
    @rem Set debug options before running the Controller start script
    set JAVA_OPTIONS="-Djavax.net.debug=ssl"
    .\controller.cmd start
    
    @rem Alternatively set debug options when running the Controller start script
    .\controller.cmd start --java-options="-Djavax.net.debug=ssl"
  • Code Block
    languagebash
    titleWindows example to run the Agent start script with debug options
    @rem Set debug options before running the Agent start script
    set JAVA_OPTIONS="-Djavax.net.debug=ssl"
    .\agent.cmd start
    
    @rem Alternatively set debug options when running the Agent start script
    .\agent.cmd start --java-options="-Djavax.net.debug=ssl"
  • When operating the Controller or Agent as a Windows Service then from the .\service directory of the installation run
    • for a Controller: sos_jobscheduler_controller_<port>w.exe
    • for an Agent: sos_jobscheduler_agent_<port>w.exe
      • where <port> corresponds to the port that the Controller or Agent has been installed for.
      • Example: C:\Program Files\sos-berlin.com\js7\agent_4445\service\sos_jobscheduler_agent_4445w.exe
    • This brings up a utility that allows to specify Java options to be specified:
    • Consider Note that the Controller or Agent Windows Service has to be restarted to apply changes to Java options.

Unix Operating Systems

For Unix, the JAVA_OPTIONS environment variable can be set before running the Controller or Agent start script like this:

...

Windows Operating Systems

For Windows, the JAVA_OPTIONS environment variable can be set before running the JOC Cockpit start script like this: 

  • Code Block
    languagebash
    titleWindows example to run the Controller start script with debug options
    @rem Set debug options before running the Controller start script
    set JAVA_OPTIONS="-Djavax.net.debug=ssl"
    .\jetty.cmd start
  • When operating the JOC Cockpit as a Windows Service then from the .\service directory of the installation run
    • for JOC Cockpit: sos_joc_<port>w.exe
      • where <port> corresponds to the port that the JOC Cockpit has been installed for.
      • Example: C:\Program Files\sos-berlin.com\js7\joc\service\sos_joc_4446w.exe
    • This brings up a utility that allows to specify Java options to be specified:
    • Consider Note that the JOC Cockpit Windows Service has to be restarted to apply changes to Java options.

...