Oracle® Fusion Middleware
Part 7. Troubleshoot your API Gateway installation

You can use the Logs and Events view in the API Gateway Manager web console to view and search API Gateway log and event files. You can configure API Gateway log and event settings in the Server Settings in Policy Studio. The Settings > Dynamic tab in API Gateway Manager also enable you to configure log settings at runtime.

This section first provides an overview of the different types of logs and events that are displayed in API Gateway Manager. This topic then explains how to configure the different types of logs and events, and shows where to find more detailed information.

The domain audit log captures management changes in the API Gateway domain that are written by the Admin Node Manager and by API Gateway instances. This includes details such as API Gateway configuration changes, log in/log out, deployments, user, or topology changes. For example, user Joe deployed a new configuration, admin user created a new group, or user Jane has read deployment data. The domain audit log is enabled by default. However, you can configure filtering options such as the number of events displayed, time interval, and event type.

For example, the displayed event types include the following:

View in API Gateway Manager

To view domain audit log events in the API Gateway Manager web console, perform the following steps:

1. In the API Gateway Manager, select Logs > Domain Audit.

2. Configure the number of events displayed in the Max results per server field on the left. Defaults to 1000.

3. Configure the Time Interval for events. Defaults to 1 day.

4. Click the Filter button to add more viewing options (Event Type or Groups and Servers).

5. Click Apply when finished.

<install-dir>/apigateway/logs/audit.log

{"timestamp":1397724538713,"message":"User 'admin' connected with 3 defined user roles",
   "eventId":107,"metadata":{"userID":"admin"}}
{"timestamp":1397724539638,"message":"Deployment data read by user 'admin'","eventId":1037,
   "metadata":{}}
{"timestamp":1397726232992,"message":"Performing domain audit lookup for service 
   'Node Manager on cayote.acme.com' over a 24h interval","eventId":9,"metadata":
   {"userID":"admin","serviceID":"nodemanager-1"}}
{"timestamp":1397726235233,"message":"Performing domain audit lookup for service 
   'Node Manager on cayote.acme.com' over a 24h interval","eventId":9,"metadata":
   {"userID":"admin","serviceID":"nodemanager-1"}}

<install-dir>/apigateway/conf/apiaudit.xml

<apiauditrule>
   <method>GET</method>
   <path>^ops/getserviceconfig$</path>
   <pathMatch>MATCHES</pathMatch>
     <queryArgs>*</queryArgs> 
     <outputMessage>Update configuration for service '${serviceName}': 
        ${queryArgs}</outputMessage>
</apiauditrule>

<apiauditrule>
   <method>GET</method>
   <path>api/monitoring/metrics</path>
   <pathMatch>BEGINS_WITH</pathMatch> 
</apiauditrule>

The API Gateway provides detailed transaction audit logging for specific message filters (for example, the request, time of the request, where the request was routed to, and response returned to the client). You can configure transaction logging output to a number of different destinations:

Transaction audit logging is not configured by default. To configure where transaction audit log information is sent, perform the following steps:

When a transaction audit log Text File destination is enabled, a text log file is written and displayed in API Gateway Manager in the Logs -> Transaction Audit view. For details on configuring all available options, see Transaction audit log settings.

You can configure the transaction audit log level and log message for a specific filter as follows:

The transaction event log provides a summary of each API Gateway transaction. These logs are persisted, and when configured, are used to generate metrics on the Monitoring tab in API Gateway Analytics.

Transaction event logging is enabled by default. To configure the transaction event log output, perform the following steps:

For details on configuring all the available options, see Transaction event log settings.

The access log provides summary of the HTTP request and response messages that are written to an access log file in the format used by Apache HTTP Server. For example, this includes details such as the remote hostname, user login name, and authenticated user name.

Access logging is not configured by default. To configure the access log output, perform the following steps:

For details on configuring all the available options, see Transaction access log settings.

The Events view in API Gateway Manager enables you to view and search the contents of the following in-memory API Gateway events and alerts:

The following example shows some Transaction Audit events:

You can click the Settings > Dynamic tab in API Gateway Manager to configure dynamic trace, logging, and monitoring settings on-the-fly at runtime. These settings are dynamic because you do not need to refresh or deploy updates to the API Gateway. You can specify these settings for an API Gateway system, instance, service, interface, or path.

For example, the top-level SYSTEM SETTINGS allow you to configure logging of inbound and outbound transactions, policy paths, and message trace. You can select an HTTP interface in the tree on the left to configure the INTERFACE SETTINGS, TRAFFIC MONITORING SETTINGS, and Trace level. You can select the API Gateway instance in the tree to configure its trace level.

You can also select a relative path or service in the tree, and configure the following options:

When finished, click Apply Changes at the bottom of the page.

The following example shows the dynamic settings available for a service:

For more details on real-time monitoring and traffic monitoring, see Monitor services in API Gateway Manager.