Document toolboxDocument toolbox

(12.05.100-en) Where Can I Find the IGEL UMS Log Files?

Owned by Emese Pogany
Aug 30, 2024
4 min read

The following article details where you can find and configure IGEL Universal Management Suite (UMS) log files.   

For enabling the logging of UMS user actions and actions initiated by a device, see (12.05.100-en) Logging in the IGEL UMS .

If you manage IGEL OS 12 devices, see https://igel-jira.atlassian.net/wiki/spaces/HTSWICPB/pages/86868405 .

If you require UMS log files for IGEL Support, see (12.05.100-en) Save Support Information / Send Log Files to Support . 

UMS 12.01 or Higher

To change the logging settings for UMS 12.01 or higher, see the file README.md under [IGEL installation directory]/RemoteManager/rmguiserver/logs.

If you change the logging configuration, the restart of the UMS Server is not required.

UMS Server

rmguiserver/logs
(Read rmguiserver/logs/README.md  for configuring the logs)

stderr.log

Error output of the Apache Tomcat server 

stdout.log

Standard output of the Apache Tomcat server

ums-api.log

Logging of the API service

ums-server.log (= catalina.log before UMS 12)

ums-server-err.log

Central log file for all logging events

device-connector.log

device-connector-err.log

Logging of the device connector

ums-device-service.log

ums-device-service-err.log

Logging of OS 12 device functionality

ums-appproxy.log​

ums-appproxy-err.log​

Logging of the UMS as an Update Proxy



rmguiserver/logs/ums-server
(rmguiserver/conf/logback.xml - for configuring the logs)

ums-server-msg.log

Logging of the Apache ActiveMQ messaging (High Availability and Distributed UMS)

ums-server-communication.log

Logging of communication with UMS Console or devices
Edit at  <!-- Logging of UMS communication -->

ums-server-threaddump.log

Periodic logging of the threads

ums-server-icg-communication.log

Logging of communication with ICG
Edit at  <!-- Logging of UMS communication --> 

ums-server-health.log

Logging of the UMS HA Health Check

ums-server-monitoring.log

Performance logging
Edit at  <!-- Logging of monitoring data -->; change INFO to DEBUG to get detailed information on each method call



This is an example of rmguiserver/conf/logback.xml where you can configure the logs for the UMS Server, i.e. switch the logging on/off, change the scan period or the number of days for the logging history, etc.:

<?xml version="1.0" encoding="UTF-8"?>

-<configuration scanPeriod="60 seconds" scan="true" debug="false">



<!-- The length of logging history in days -->

<property value="30" name="logs.history"/>



<!-- The maximum size of one log file -->

<property value="100MB" name="logs.maxsize"/>



<!-- The maximum size of the history -->

<property value="1GB" name="logs.historysizecap"/>



<!-- Logging of monitoring data -->

<!-- Elevate to 'DEBUG' to see the individual calls -->

<property value="INFO" name="monitoring.level"/>



<!-- Logging of UMS communication -->

<!-- Set to 'ALL' to enable and 'OFF' to disable -->

<property value="OFF" name="server2console.level"/>

<property value="OFF" name="server2tc.level"/>

<property value="OFF" name="server2usg.level"/>

<property value="OFF" name="usg2server.level"/>

<property value="OFF" name="server2server.level"/>



<!-- Logging level of domain service -->

<!-- OFF, INFO, DEBUG, ERROR -->

<property value="WARN" name="domainservicelog.level"/>

<!-- The appenders -->



rmguiserver/logs/unifiedprotocol

communication.log

Logging of communication between the device and UMS (both ingoing and outgoing commands)

Edit rmguiserver/webapps/device-connector/WEB-INF/classes/config/logback.xml  for configuring the logs.

Edit at <!-- Logging of device communication -->; change OFF to INFO for logging command headers or to ALL for logging command headers and payload

domain-service.log

Central log file for all events in the command handling

Edit rmguiserver/conf/logback.xml for configuring the logs.

Edit at <!-- Logging level of domain service -->

device-auth.log

Logging of device onboarding and device authentication issues

UMS Load Balancer

umsbroker/etc/work/logs
(umsbroker/etc/conf/logback.xml - for configuring the logs)

ums-broker.log

Central log file for all logging events

ums-broker-msg.log

Logging of the messages exchanged

ums-broker-health.log

Logging of the UMS HA Health Check

ums-broker-monitoring.log

Performance logging
Edit at  <!-- Logging of monitoring data -->; change INFO to DEBUG to get detailed information on each method call

UMS Watchdog

umswatchdog/etc/work/logs
(umswatchdog/etc/conf/logback.xml - for configuring the logs)

ums-watchdog.log

Central log file for all logging events

ums-watchdog-msg.log

Logging of the messages exchanged

ums-watchdog-health.log

Logging of the UMS HA Health Check

UMS Console

$HOME/.igel

RMClient.exe.log

Startup logging



$HOME/.igel/logs
(rmclient/logback.xml - for configuring the logs)

ums-console.log

Central log file for all logging events

UMS Administrator

$HOME/.igel

RMAdmin.exe.log

Startup logging



rmguiserver/logs
(rmadmin/logback.xml - for configuring the logs)

ums-admin.log

Central log file for all logging events

UMS 6.10.110 or Higher

In UMS version 6.10.110, the outdated logging framework Log4j 1.x was replaced with Logback; see also https://igel-jira.atlassian.net/wiki/spaces/ENLITESECURITYP/pages/74883628/ISN+2022-19%3A+Log4j+1.x+Remainder+in+UMS.

To change the logging settings for UMS 6.10.110 or higher, use logback.xml.

UMS Server

rmguiserver/logs
(rmguiserver/conf/logback.xml - for configuring the logs)

catalina.log

Central log file for all logging events

ums-server-msg.log

Logging of the Apache ActiveMQ messaging

ums-server-communication.log

Logging of communication with UMS Console or devices
Edit at  <!-- Logging of UMS communication -->

localhost.log

Technical logging of the Apache Tomcat server

stderr.log

Error output of the Apache Tomcat server 

stdout.log

Standard output of the Apache Tomcat server

ums-server-threaddump.log

Periodic logging of the threads

ums-server-icg-communication.log

Logging of communication with ICG
Edit at  <!-- Logging of UMS communication --> 

ums-server-health.log

Logging of the UMS HA Health Check

ums-server-monitoring.log

Performance logging
Edit at  <!-- Logging of monitoring data -->; change INFO to DEBUG to get detailed information on each method call (the server restart is then required)



This is an example of rmguiserver/conf/logback.xml where you can configure the logs for the UMS Server, i.e. switch the logging on/off, change the scan period or the number of days for the logging history, etc.:

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false" scan="true" scanPeriod="60 seconds">

<!-- General settings -->


<!-- Logging of monitoring data -->
<!-- Elevate to 'DEBUG' to see the individual calls -->
<property name="monitoring.level" value="INFO" />

<!-- Logging of UMS communication -->
<!-- Set to 'ALL' to enable and 'OFF' to disable -->
<property name="server2console.level" value="OFF" />
<property name="server2tc.level" value="OFF" />
<property name="server2usg.level" value="OFF" />
<property name="usg2server.level" value="OFF" />


<!-- The base folder for log files -->
<property name="base.dir" value="${catalina.home}/logs" />

<!-- The default logging pattern -->
<property name="pattern.format" value="%-5(%d{[yyyy-MM-dd HH:mm:ss.SSS]}) %-5level [%thread] %logger{10}.%M - %msg%n" />

<!-- The length of logging history in days -->
<property name="logs.history" value="30" />



<!-- The appenders -->







rmguiserver/logs
(rmguiserver/conf/logback.xml - for configuring the logs)

ums-api.log

Logging of the API service

UMS Load Balancer

umsbroker/etc/work/logs
(umsbroker/etc/conf/logback.xml - for configuring the logs)

ums-broker.log

Central log file for all logging events

ums-broker-msg.log

Logging of the messages exchanged

ums-broker-health.log

Logging of the UMS HA Health Check

ums-broker-monitoring.log

Performance logging
Edit at  <!-- Logging of monitoring data -->; change INFO to DEBUG to get detailed information on each method call (the server restart is then required)

UMS Watchdog

umswatchdog/etc/work/logs
(umswatchdog/etc/conf/logback.xml - for configuring the logs)

ums-watchdog.log

Central log file for all logging events

ums-watchdog-msg.log

Logging of the messages exchanged

ums-watchdog-health.log

Logging of the UMS HA Health Check

UMS Console

$HOME/.igel

RMClient.exe.log

Startup logging



$HOME/.igel/logs
(rmclient/logback.xml - for configuring the logs)

ums-console.log

Central log file for all logging events

UMS Administrator

$HOME/.igel

RMAdmin.exe.log

Startup logging



rmguiserver/logs
(rmadmin/logback.xml - for configuring the logs)

ums-admin.log

Central log file for all logging events

Before UMS 6.10.110

UMS Server

rmguiserver/logs
(rmguiserver/conf/log4j.properties - for configuring the logs)

catalina.log

Central log file for all logging events

ums-server-msg.log

Logging of the Apache ActiveMQ messaging

communication.log

Logging of communication with UMS Console or devices
Edit at # communication logging - define the log levels; refer to Log4j documentation

license_deployment.log

Logging of licenses
Edit at # license deployment logging; refer to Log4j documentation

localhost.log

Technical logging of the Apache Tomcat server

stderr.log

Error output of the Apache Tomcat server 

stdout.log

Standard output of the Apache Tomcat server

umsthreaddump.log

Periodic logging of the threads
Edit with # threaddump logging; refer to Log4j documentation

usgcommunication.log

Logging of communication with ICG
Edit at # communication logging - define the log levels; refer to Log4j documentation

health.log

Logging of the UMS HA Health Check

monitoring.log

Performance logging
Edit at # execution monitoring; change INFO to DEBUG to get detailed information on each method call (the server restart is then required)



rmguiserver/logs
(rmguiserver/conf/log4japi.properties - for configuring the logs)

api.log

Logging of the API service

UMS Load Balancer

umsbroker/etc/work/logs
(umsbroker/etc/conf/log4j.properties - for configuring the logs)

igel-ums-broker.log

Central log file for all logging events

broker-msg.log

Logging of the messages exchanged

broker-health.log

Logging of the UMS HA Health Check

broker-monitoring.log

Performance logging
Edit at # monitoring logging; change INFO to DEBUG to get detailed information on each method call (the server restart is then required)

UMS Watchdog

umswatchdog/etc/work/logs
(umswatchdog/etc/conf/log4j.properties - for configuring the logs)

igel-ums-watchdog.log

Central log file for all logging events

watchdog-msg.log

Logging of the messages exchanged

watchdog-health.log

Logging of the UMS HA Health Check

UMS Console

$HOME/.igel

RMClient.exe.log

Startup logging



$HOME/.igel/logs
(rmclient/log4j.properties - for configuring the logs)

igel-ums-console.log

Central log file for all logging events

UMS Administrator

$HOME/.igel

RMAdmin.exe.log

Startup logging



rmguiserver/logs
(rmadmin/log4j.properties - for configuring the logs)

igel-ums-admin.log

Central log file for all logging events