Versions Compared

Key

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

Table of Contents

Scope

  • By default JS7 components products are configured to use log level INFO to limit disk space consumption.
  • Higher log levels such as DEBUG and TRACE can be used to troubleshoot unexplained behavior.
  • For the location of Log4j2 configuration files see the JS7 - Log Files and Locations article.

...

Changes to the Log4j2 configuration are applied within 60s and do not require the JS7 component product to be restarted.

Anchor
log_level_controller
log_level_controller
Anchor
log_level_agent
log_level_agent
Controller and Agent Log4J2 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="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="ServiceClusterLogLevel">OFF</Property>
        <Property name="ServiceHistoryLogLevel">OFF</Property>
        <Property name="ServiceDailyPlanLogLevel">OFF</Property>
        <Property name="ServiceCleanupLogLevel">OFF</Property>
        <Property name="ServiceMonitorLogLevel">OFF</Property>
        <Property name="ServiceReportsLogLevel">OFF</Property> 
        <Property name="AuthLogLevel">OFF</Property>
        <Property name="ConnectionPoolLogLevel">OFF</Property>
    </Properties>
    ...
<Configuration>

...

  • To enable the debug mode, change the <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="ServiceClusterLogLevel">DEBUG</Property>
    service-history-debug.log<Property name="ServiceHistoryLogLevel">DEBUG</Property>
    service-dailyplan-debug.log<Property name="ServiceDailyPlanLogLevel">DEBUG</Property>
    service-cleanup-debug.log<Property name="ServiceCleanupLogLevel">DEBUG</Property>
    service-monitor-debug.log<Property name="ServiceMonitorLogLevel">DEBUG</Property>
    service-reports-debug.log<Property name="ServiceReportsLogLevel">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 the increased storage consumption.

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

...

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

...