The Directory Sync, User Auth, and Kerberos Auth services each create log files that you can use to troubleshoot problems. If you want to save more logs than are saved by default, you can increase the size of the files as well as the number of files that are created before logs are rotated.

All log files for a service are saved in the INSTALL_DIR\Workspace ONE Access\servicename\logs folder. For example, the log files for the Directory Sync Service are in the INSTALL_DIR\Workspace ONE Access\Directory Sync Service\logs folder.

Typically, the log files for which you might need to increase the size and number are the servicename-service.log and servicename-vertx-access.log files.

The following XML files contain the settings for log files:

  • The INSTALL_DIR\Workspace ONE Access\servicename\servicename.xml file contains the settings for the servicename.err.log and servicename.out.log files.
    Log File Settings File Default Size Default Number of Files Saved
    DirectorySyncService.err.log INSTALL_DIR\Workspace ONE Access\Directory Sync Service\DirectorySyncService.xml 10240 KB 8
    DirectorySyncService.out.log INSTALL_DIR\Workspace ONE Access\Directory Sync Service\DirectorySyncService.xml 10240 KB 8
    UserAuthService.err.log INSTALL_DIR\Workspace ONE Access\User Auth Service\UserAuthService.xml 10240 KB 8
    UserAuthService.out.log INSTALL_DIR\Workspace ONE Access\User Auth Service\UserAuthService.xml 10240 KB 8
    KerberosAuthService.err.log INSTALL_DIR\Workspace ONE Access\Kerberos Auth Service\KerberosAuthService.xml 10240 KB 8
    KerberosAuthService.out.log INSTALL_DIR\Workspace ONE Access\Kerberos Auth Service\KerberosAuthService.xml 10240 KB 8
  • The INSTALL_DIR\Workspace ONE Access\servicename\conf\log4j2-override.xml contains the settings for the servicename-service.log and servicename-vertx-access.log files.
    Log File Settings File Default Size Default Number of Files Saved
    eds-service.log INSTALL_DIR\Workspace ONE Access\Directory Sync Service\conf\log4j2-override.xml 50 MB 5
    eds-vertx-access.log INSTALL_DIR\Workspace ONE Access\Directory Sync Service\conf\log4j2-override.xml 50 MB 5
    eas-service.log INSTALL_DIR\Workspace ONE Access\User Auth Service\conf\log4j2-override.xml 50 MB 5
    eas-vertx-access.log INSTALL_DIR\Workspace ONE Access\User Auth Service\conf\log4j2-override.xml 50 MB 5
    eks-service.log INSTALL_DIR\Workspace ONE Access\Kerberos Auth Service\conf\log4j2-override.xml 50 MB 5
    eks-vertx-access.log INSTALL_DIR\Workspace ONE Access\Kerberos Auth Service\conf\log4j2-override.xml 50 MB 5
Note: For a description of the log files, see Accessing Workspace ONE Access Connector Log Files. That page also provides information on enabling DEBUG mode and tailing log files.

Procedure

  1. Log in to the Workspace ONE Access connector server.
  2. To modify the size or number of a service's servicename.err.log and servicename.out.log files, follow these steps.
    1. Navigate to the INSTALL_DIR\Workspace ONE Access\servicename folder and open the servicename.xml file for editing. For example, for the Directory Sync service, edit the INSTALL_DIR\Workspace ONE Access\Directory Sync Service\DirectorySyncService.xml file.
    2. Locate the following entry: 
         <log mode="roll-by-size">
        <sizeThreshold>10240</sizeThreshold>
        <keepFiles>8</keepFiles>
    </log>
    3. Update the file size in the <sizeThreshold> entry and the number of files to keep in the <keepFiles> entry based on your requirements.
    4. Save the file.
  3. To increase the size and number of a service's servicename-service.log and servicename-vertx-access.log files, follow these steps.
    1. Navigate to the INSTALL_DIR\Workspace ONE Access\servicename\conf folder and edit the log4j2-override.xml file. For example, for the Directory Sync service, edit the INSTALL_DIR\Workspace ONE Access\Directory Sync Service\conf\log4j2-override.xml file.
    2. Add the following lines within the <Configuration …> and </Configuration> lines: 
      <Appenders>
<RollingFile name="fileLogger" fileName="${logFilePathAndNamePrefix}.log"
filePattern="${logFilePathAndNamePrefix}-%i.log">

<PatternLayout pattern="${defaultLayout}" />

<Policies>
<SizeBasedTriggeringPolicy size="50 MB" />
</Policies>
<DefaultRolloverStrategy max="5"/>
</RollingFile>

<!-- Rolling file appender, used by vertx access log -->
<RollingFile name="accessFileLogger" fileName="${accessLogFilePathAndNamePrefix}.log"
filePattern="${accessLogFilePathAndNamePrefix}-%i.log">

<PatternLayout pattern="${accessLogLayout}" />

<Policies>
<SizeBasedTriggeringPolicy size="50 MB" />
</Policies>
<DefaultRolloverStrategy max="5"/>
</RollingFile>
</Appenders>
      Note: The <RollingFile name="fileLogger"… section is for the servicename-service.log file and the <RollingFile name="accessFileLogger"… section is for the servicename-vertx-access.log file.
    3. To specify the size and number for the servicename-service.log file, in the <RollingFile name="fileLogger"… section that you added, edit the following lines:
      • <SizeBasedTriggeringPolicy size="50 MB" /> to specify the size of the file based on your requirements
      • <DefaultRolloverStrategy max="5"/> to specify the number of files to keep based on your requirements
    4. To specify the size and number for the servicename-vertx-access.log file, in the <RollingFile name="accessFileLogger"… section that you added, edit the following lines:
      • <SizeBasedTriggeringPolicy size="50 MB" /> to specify the size of the file based on your requirements
      • <DefaultRolloverStrategy max="5"/> to specify the number of files to keep based on your requirements
    5. Save the file.