View traces and logs

This topic describes how to view API Gateway trace and log files using the Web Administration Interface.

Tip   To view system or Axway Appliance Platform log files, see Work with system log files.

Trace files are used to identify and resolve runtime problems that occur in the API Gateway process running on the appliance. If a runtime error occurs, you should view the trace file for information about the error. Log files are used to provide and audit trail of for each of the key actions that occurs on API Gateway configurations, processes, and users (for example, when a user logs in, or when a process configuration is updated). All items are written to a log file stored on the appliance.

View trace files

Click the Traces and Logs link in the WAI menu, to view all trace files written by the API Gateway running on the appliance. The current trace file is called servername.trc.

Trace files are configured to roll over at the top of each day or when a single trace file reaches 16 MB in size. Furthermore, when a maximum of 500 trace files have been written the oldest trace file is deleted automatically to make way for the new one. As a result of this roll-over process, you typically have several trace files listed.

View trace contents
To view a trace file stored on the appliance, click the View link next to the trace file. Alternatively, to download a trace file, click the Download link. If the API Gateway process has been configured to trace output at DEBUG level, the trace file is very verbose. In this case, it can be useful to use the filters available when viewing a particular trace file.

For example, you can search only for lines containing the word ERROR, which displays only error messages so that you can quickly identify the problem. To do this type the word ERROR into the Only show lines with text field. Similarly, to walk through all trace messages written out by a single thread, you can enter the thread number. This is included in square brackets on each trace output line (for example, [b76766c0]).

View log files

Click the Traces and Logs link in the WAI menu, to view all log files written by the API Gateway running on the appliance. Log files are configured to roll over at the top of each day or when a single log file reaches 1 MB in size. Furthermore, when a maximum of 20 log files have been written the oldest log file is deleted automatically to make way for the new one. As a result of this roll-over process, you typically have several log files listed.

View log contents
To view a log file stored on the appliance, click the View link next to the log file. Alternatively, to download a log file, click the Download link. You can use the filters available when viewing a particular log file. For example, you can search for only lines containing the phrase Login by user, so that you can quickly view who has accessed the appliance. To do this type the phrase into the Only show lines with text field.

View the service log
To view the service.log file, click the View link next to the file. This displays details such as when a service starts up successfully or when a service fails to start up.

Related Links