Secure Global Desktop 4.31 Administration Guide > Arrays, servers and load balancing > Using log filters to troubleshoot problems with the Secure Global Desktop server

Using log filters to troubleshoot problems with the Secure Global Desktop server

When you first install Secure Global Desktop, the default log filters log all errors on the Secure Global Desktop server. If you want to obtain more detailed information, for example to troubleshoot a problem, you can set additional log filters. You set additional log filters by:

• typing the filter directly into the Log Filter field on the Array properties panel of Array Manager.
  Each filter must be separated by a RETURN.
• using the tarantella config edit --array-logfilter command.
  Each filter must be separated by a space.

Each filter has the form:
component/sub-component/severity:destination.

The options for each part of the filter and how you view the log output are described below.

Note Log filters can create large amounts of data. It is good practice to set as specific a filter as possible and then remove the filter when you have finished with it.

Selecting a component and sub-component

Selecting a component and sub-component allows you to choose the area of information you want to log from the Secure Global Desktop server. The table below shows the available component/sub-component combinations and an explanation of the kind of information this will produce.

Selecting the severity

You can select one of the following levels of severity for each log filter:

The fatalerror severity produces the least amount of information and the moreinfo severity produces the most.

Selecting a severity level is not cumulative. For example, selecting info does not mean you also see warning, error or fatalerror log messages. To log more than one level of severity, use a wild card (see below).

Using wildcards

You can use a wildcard (*) to match multiple components, sub-components and severities. For example, to log all warning, error and fatal error messages for printing, you could use server/printing/*error.

Note If you use a wildcard on the command line, you must enclose the filter in quotes to stop your shell from expanding them.

Selecting a destination

When selecting a destination for the logs, you can specify that the output goes to:

• a log file; or
• a log handler.

Using log files

If you are outputting to a file, you can output to two types of file:

• filename.log - Secure Global Desktop formats this log output so that it is easy to read.
  This format is required by the tarantella query errlog command.

  Note This command only searches log files that have names that end error.log.

• filename.jsl - Secure Global Desktop formats this log output for automated parsing and searching.
  This format is required by the tarantella query audit command.

The file extension of the destination file controls the format of the file.

You can also create a separate log file for each process ID by including the %%PID%% placeholder in the file name.

The log files are output in the log directory specified on the General Properties pane for each array member. The directory is usually /opt/tarantella/var/log. You cannot change the location of the log files, but you can use a symlink to redirect the logs to a different location. Alternatively, you can use the syslog log handler described below.

Using log handlers

A log handler is a JavaBeans component used as the destination for the log messages. When specifying a log handler, you must use its Secure Global Desktop Federated Name (TFN). Secure Global Desktop provides two standard log handlers:

• ConsoleSink; and
• SyslogSink.

The ConsoleSink writes log messages in a easy to read format to standard error. This log handler is enabled by default and logs all errors. The TFN of this log handler is:
.../_beans/com.sco.tta.server.log.ConsoleSink

The SyslogSink writes log messages to the UNIX/Linux syslog facility. The TFN of this log handler is:
.../_beans/com.sco.tta.server.log.SyslogSink

Example log filters

Here are some examples of commonly used log filters:

• to debug user logins:

  server/login/*:login%%PID%%.log
  server/login/*:login%%PID%%.jsl

• to troubleshoot client drive mapping:

  cdm/*/*:cdm%%PID%%.log
  cdm/*/*:cdm%%PID%%.jsl
  server/deviceservice/*:cdm%%PID%%.log
  server/deviceservice/*:cdm%%PID%%.jsl

• to troubleshoot printing problems:

  server/printing/*:print%%PID%%.log
  server/printing/*:print%%PID%%.jsl

• to get timing measurements for server performance:

  metrics/*/*info:metrics.log
  metrics/*/*info:metrics.jsl

• to send all warnings, errors and fatalerrors to syslog:

  */*/*error:.../_beans/com.sco.tta.server.log.SyslogSink

Viewing log output

To view the log output, you can either:

• open the .log files in an editor; or
• use tarantella query command.

If you use the tarantella query command, use:

• tarantella query errlog to see only the errors and fatalerrors for specific Secure Global Desktop server components; and
• tarantella query audit searches the logs for any messages relating to a person, an application or an application server.

Note You can only use these commands to view the log output until the logs are archived. You configure archiving when you install Secure Global Desktop but you can change the settings at any time by running the tarantella setup command.

Copyright © 1997-2007 Sun Microsystems, Inc. All rights reserved.