Software AG Products 10.7 | Integrating On-Premises and Cloud Applications | Audit logging | Viewing Audit Log Data | View the API Gateway Transaction Logs
 
View the API Gateway Transaction Logs
You cannot view logs for API Gateway transactions using the Integration Server Administrator or Monitor. You can view logs for API Gateway transactions only by manually opening either:
*The log file (the flat file). You can open the log file using a text editor. The log file is located in the Integration Server_directory \instances\instance_name\logs\APIGateway directory.
*The audit table. You can open the audit table using your RDBMS editor. The table name is AGW_EVENT_TXN. For more information, see the documentation for your RDBMS editor.
The following table describes the columns in the API Gateway transaction log.
Flat File Column Name
Database Column Name
Description
API Id
API_ID
Unique identifier of the API that produced the audit record.
API Name
API_NAME
Name of the API that generated the log entry.
API Version
API_VERSION
Version of the API that generated the log entry.
Application Id
APPLICATION_ID
Unique identifier of the application associated with the call.
Application IP
APPLICATION_IP
IP address of the application associated with the call. This is included when the Identify and Authorize Application policy is applied for the API.
Application
APPLICATION_NAME
Name of the application associated with the call. This is included when the Identify and Authorize Application policy is applied for the API.
Native Endpoint
NATIVE_ENDPOINT
Endpoint URL of the API that generated the log entry.
Partner ID
PARTNER_ID
Unique identifier of the partner that produced the audit record.
Provider Roundtrip Time
PROVIDER_TIME
Time in milliseconds required for API Gateway to invoke an API provider and receive a response.
Request Payload
REQUEST
Request payload. This field is written only if you use the API Gateway database component. It cannot be written to the API Gateway log file.
Response Payload
RESPONSE
Response payload. This field is written only if you use the API Gateway database component. It cannot be written to the API Gateway log file.
Service Name
SERVICE_NAME
Name of the API that generated the log entry.
Request Headers
REQUEST_HEADERS
Request header in the incoming request.
Response Headers
RESPONSE_HEADERS
Response header in the outgoing response.
Request Status
STATUS
Current status of the request (Success or Failure).
Target Name
TARGET_NAME
Name of the API Gateway instance reporting the event.
Total Roundtrip Time
TOTAL_TIME
Time in milliseconds required to invoke the API provider. This time includes the overhead incurred by API Gateway. Overhead includes security overhead for encryption, decryption, and load-balance retries.
Query Params
QUERY_PARAMS
Query parameters that are present in the incoming REST request.
Correlation ID
CORRELATIONID
Unique identifier that can be used to query the log.
Error Origin
ERROR_ORIGIN
Origin of the error - API or API Gateway.
Custom Field
CUSTOM_FIELD
Custom field that is specified for a transaction event.