Versions Compared

Key

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

...

Code Block
languagexml
titleController, Agent log4j2.xml
linenumberstrue
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<configuration status="WARN" shutdownHook="disable">
        <properties>
                <property name="LogLevel">INFO</property>
                <Property name="RetainDays">30d</Property>
                <Property name="MaxSizeOfRolledOverFiles">5GB</Property>
                <Property name="MaxSizePerFile">100MB</Property>
        </properties>
        ...
<Configuration>

...

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="NumOfFilesPerDay">5</Property>
                <Property name="MaxSizePerFile">100MB</Property>

                <!--Configuration for loggers of the web services in joc.log
                        Possibly values are ERROR, WARN, INFO, DEBUG, TRACE
                        Default: INFO
                -->
                <Property name="RootLogLevel">info</Property>

                <!--Configuration for an extra database log file (database-debug.log) if necessary
                        OFF: without extra log
                        ERROR, WARN, INFO, DEBUG, TRACE: creates extra log with corresponding log level
                        SQL statement are included from DEBUG and their binding with TRACE
                -->
                <Property name="DatabaseLogLevel">off</Property>

                <!--Configuration for an extra shiro log file (shiro.log) if necessary
                        OFF: without extra log
                        ERROR, WARN, INFO, DEBUG, TRACE: creates extra log with corresponding log level
                        SQL statement are included from DEBUG and their binding with TRACE
                -->
                <Property name="AuthLogLevel">off</Property>
        </Properties>
        ...
<Configuration>

...

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

Applying Debug Options

...

to Controller and Agent

The below examples make use of the -Djavax.net.debug=ssl Java option that is used to receive detailed information e.g. about certificate handling. However, any Java options can be forwarded like this.

Windows Operating Systems

...

  • Code Block
    languagebash
    titleUnix example to run the Controller start script with debug options
    # Set debug options before running the Controller start script
    export JAVA_OPTIONS="-Djavax.net.debug=ssl"
    ./controller.sh start
    
    # Alternatively set debug options when running the Controller start script
    ./controller.sh start --java-options="-Djavax.net.debug=ssl"
  • Code Block
    languagebash
    titleUnix example to run the Agent start script with debug options
    # Set debug options before running the Agent start script
    export JAVA_OPTIONS="-Djavax.net.debug=ssl"
    ./agent.sh start
    
    # Alternatively set debug options when running the Agent start script
    ./agent.sh start --java-options="-Djavax.net.debug=ssl"

Applying Debug Options

...

to JOC Cockpit

Windows Operating Systems

...

  • Code Block
    languagebash
    titleUnix example to run the Jetty start script with debug options
    # Set debug options before running the Jetty start script
    export JAVA_OPTIONS="-Djavax.net.debug=ssl"
    ./jetty.sh start
  • When running JOC Cockpit as a daemon the following line can be added to the  /etc/default/joc file (requires root permissions):

    Code Block
    languagebash
    titleUnix example to use /etc/default/joc with debug options
    export JAVA_OPTIONS="-Djavax.net.debug=ssl"

Frequently Used Debug Options

Certificate Management 

  • When configuring certificates for secure HTTPS connections with JOC Cockpit, Controller and Agents then SSL debug options will provide detailed information e.g. about handshaking and use of certificates.
  • Use the Java option: -Djavax.net.debug=ssl