Redirect logs to stdout

Configure the API Gateway logging system to redirect the trace and traffic logs to stdout instead of to separate files, allowing the logs to be read directly from each container by an external logging service (for example, Elastic Stack or Splunk).

2 minute read

Trace logs

The trace log behavior can be modified through the trace.xml file or the system environment variables.

Redirect trace logs using the trace.xml file

Update the INSTALL_DIR/apigateway/system/conf/trace.xml file as follows:

  • Disable the trace file on disk by commenting out the following line:
 <!--<FileRolloverTrace maxfiles="500" filename="%s\_%Y%m%d%H%M%S.trc"/>-->
  • Enable JSON output by changing the jsonOutput property value to true:
<FileTrace filename="@stdout" jsonOutput="true"/>

Redirect trace logs using system environment variables

Ensure the following environment variables are passed to the container:

APIGW_LOG_TRACE_TO_FILE=false

APIGW_LOG_TRACE_JSON_TO_STDOUT=true

Open traffic logs

The open traffic log behavior can be modified through the Policy Studio settings or system environment variables.

Redirect open traffic logs using Policy Studio

Select the Server Settings node in the Policy Studio tree, click Logging > Open Traffic Event Log, and select Use console/traces from the Event Log Output field.

Redirect open traffic logs using system environment variables

Ensure the following environment variable is passed to the container:

APIGW_LOG_OPENTRAFFIC_OUTPUT=stdout

Further information

For more information on trace logging and open traffic logging, see the API Gateway Administrator Guide. This guide also describes the open logging JSON schema.

For more information on the environment variables that you can specify at runtime, see Environment variables reference.


Last modified December 16, 2019: fix links in container guide (45029751)