D.1 Logging and Diagnostics

This section describes the logging and diagnostics features of the SGD Gateway.

This section includes the following topics:

D.1.1 About SGD Gateway Logging

SGD Gateway logging uses the Java logging application programming interface (API). For more details about how logging is implemented in Java, see http://docs.oracle.com/javase/8/docs/technotes/guides/logging/overview.html.

D.1.1.1 Changing the Logging Level

A logging properties configuration file, logging.properties, is supplied with the SGD Gateway. This file is in the /opt/SUNWsgdg/proxy/etc directory.

You can edit the logging.properties file to change the default logging level, and to configure logging levels for specific SGD Gateway services. Each SGD Gateway service is represented by an async.channel entry in the logging.properties file.

For example, if you want to increase logging levels for incoming and outgoing TCP connections, set the TCP service logging level to FINEST. Uncomment the following line in the logging.properties file:

# async.channel.tcp.level=FINEST

The FileHandler class documentation describes the logging level parameters that you can use in a logging.properties file.

You must restart the SGD Gateway to enable any changes to logging levels you make by editing the logging.properties file.


You can also use the SGD Gateway reflection service to change logging levels. See Section C.11, “The Reflection Service” for information about configuring and using the reflection service.

D.1.1.2 Log File Locations

If you have problems with the SGD Gateway, consult the following log files:

  • Routing proxy log files. The location and names of these log files are set in the logging.properties file. By default, the SGD Gateway creates routing proxy log files in the /opt/SUNWsgdg/proxy/var/log directory on the SGD Gateway host.

  • Reverse proxy log files. Details of load balancing and proxy server activity for HTTP and HTTPS connections are logged to the Apache log files in the /opt/SUNWsgdg/httpd/apache-version/logs directory on the SGD Gateway host.

  • SGD server log files. Each SGD server in the array writes error messages to log files in the /opt/tarantella/var/log directory on the SGD server host. See “Monitoring and Logging” in Chapter 6 of the Oracle Secure Global Desktop Administration Guide for more details about configuring logging for SGD servers.

D.1.2 Displaying SGD Gateway Process Information

When you start the SGD Gateway, the process ID of the routing proxy is stored to the /opt/SUNWsgdg/proxy/var/run/proxy.pid file on the SGD Gateway host.

The process ID of the reverse proxy is stored to the /opt/SUNWsgdg/httpd/apache-version/logs/httpd.pid file. This file location can be changed using the PidFile directive in the httpd.conf Apache configuration file.

To display the running SGD Gateway processes, use the following command on the SGD Gateway host:

# ps -ef| grep SUNWsgdg

D.1.3 Checking the Configuration From the Command Line

You can use the following commands to check your SGD Gateway configuration.

  • gateway status – Shows status information for the SGD Gateway.

    Run the following command on the SGD Gateway host:

    # /opt/SUNWsgdg/bin/gateway status

    See also Section B.29, “gateway status” for more information about this command.

  • tarantella gateway list – Displays a list of the SGD Gateways that are authorized for use by the SGD array.

    Run the following command on any SGD server in the array:

    $ tarantella gateway list

    See Section B.33, “The tarantella gateway Command” for more details about using the tarantella gateway command.

  • tarantella config list – Displays global settings for the SGD array.

    Run the following command on any SGD server to show the --security-gateway attribute setting. This attribute determines which SGD Clients are allowed to use the SGD Gateway.

    $ tarantella config list --security-gateway

    See Section B.38, “The --security-gateway Attribute” for more details about this attribute.