Using Oracle API Gateway Analytics

Overview

Oracle API Gateway Analytics monitors, records, and reports on the history of message traffic between API Gateway instances and various services, remote hosts, and clients running in a managed domain. You can use API Gateway Analytics to monitor traffic and perform root cause analysis at the level of the domain, API Gateway instance, service, remote host, and client. You can also filter the display based on any selected time period. For example, this defaults to the last 7 days, but you can specify any date range.

This topic describes how to use the views available in the Oracle API Gateway Analytics web-based interface to monitor your domain. It assumes that you have already performed the steps described in Configuring the API Gateway for API Gateway Analytics.

Launching API Gateway Analytics

To launch API Gateway Analytics, perform the following steps:

  1. Start the API Gateway Analytics server using the oaganalytics script in the /bin directory of your API Gateway Analytics installation.

  2. Using the default port, connect to the API Gateway Analytics interface in a browser at the following URL:

    http://HOST:8040/

    where HOST points to the IP address or hostname of the machine on which API Gateway Analytics is installed.

  3. Log in using the default admin user with password changeme. You can edit this user in Policy Studio using the Users interface from the Policy Studio tree view.

System

In the API Gateway Analytics System view, click a panel in the ALL SYSTEMS section at the top to display graph for the selected system-level metrics below. For example, the available metrics include the following:

  • Successes

  • Failures

  • Exceptions

  • Active

  • Memory Used (Avg)

  • Disk Used (%)

The following example shows messages successfully sent displayed in a simple domain with two API Gateway instances:

Oracle API Gateway Analytics

The table at the bottom shows all the API Gateway instances that are sending monitored traffic to protected services, clients, and remote hosts in your domain. You can click a API Gateway instance in the table to drill down and view graphs for the selected instance (for example, SYSTEM - Test Server). You can click the Back button at the top right to return to the ALL SYSTEMS view.

[Note] Note

Each of the API Gateway instances must already be configured to store message metrics in the same database that API Gateway Analytics is configured to read from. This enables API Gateway Analytics to obtain the API Gateway metrics and logs from the database for display. For more details, see the chapter on configuring the database in the Oracle API Gateway Installation and Configuration Guide.

API Services

The API Services view shows metrics for services that are virtualized by API Gateway instances in your domain. You can virtualize services using the web-based API Service Manager tool and the Oracle Policy Studio. For details, see Managing API Services.

In the API Services view, click a panel in the ALL API SERVICES section at the top to display graph for the selected service-level metric below. For example, the available metrics include the following:

  • Messages

  • Successes

  • Failures

  • Exceptions

  • Processing Time (Min)

  • Processing Time (Max)

  • Processing Time (Avg)

The table at the bottom shows all the services protected by API Gateway instances in your domain. You can click a service in the table to drill down and view graphs for the selected service (for example, API SERVICE - Google Search). You can click the Back button at the top right to return to the ALL API SERVICES view.

[Note] Note

A service must have been sent a message before it is displayed in the API Services view.

Remote Hosts

The Remote Hosts view displays metrics for all the remote hosts that have been configured in your domain. It shows details such as the number of message transactions that have been sent to this remote host, together with the total number of bytes sent to and received from this host.

In the Remote Hosts view, click a panel in the ALL REMOTE HOSTS section at the top to display graph for the selected remote host metric below. For example, the available metrics include the following:

  • Transactions

  • Volume Bytes (In)

  • Volume Bytes (Out)

  • Response Time (Min)

  • Response Time (Max)

  • Response Time (Avg)

The table at the bottom shows all the remote hosts connected to by API Gateway instances in your domain. You can click a remote host in the table to drill down and view graphs for the selected remote host (for example, REMOTE HOST - stockquote.com:80). This also displays which services have been connecting to the remote host. You can click the Back button at the top right to return to the ALL REMOTE HOSTS view.

Clients

This Clients view displays metrics for all clients that have been authenticated for services in your domain. In the Clients view, click a panel in the ALL CLIENTS section at the top to display graph for the selected clients metric below. For example, the available metrics include the following:

  • Messages

  • Successes

  • Failures

  • Exceptions

The table at the bottom shows all clients that have been authenticated for services in your domain. You can click a client in the table to drill down and view graphs for the selected client (for example, CLIENT - test.client). This also displays which services have been connected to by the client. You can click the Back button at the top right to return to the ALL CLIENTS view.

Audit Trail

The Audit Trail view enables you to filter the audit log messages generated by API Gateway instances in your domain. You can filter log messages by clicking the Search button on the right in the toolbar. The Query Editor enables you to create a query to filter log messages by details such as time period, severity level, filter type, filter name, and log message text. When you have added your search criteria, click Search at the bottom to run the query. You can also save the query for later use.

When you click Search, the log messages that match the search criteria specified in the query are displayed in the table. For example, the details displayed in the table include the log message text, API Gateway name, alerts, and time. You can also double-click an item in the list for more details (for example, transaction ID, filter category, and filter name).

Reports

API Gateway Analytics uses message metrics stored in the centralized database by the API Gateway instances running in your domain. The API Gateway stores metrics for the virtualized services that it exposes, and for the services, and client and remote host connections that it protects. API Gateway Analytics can generate usage reports and charts based on this data, and display them in the Reports view.

You can create reports by selecting the appropriate button in the API Gateway Analytics toolbar, and clicking the Schedule Report button. For example, to generate reports on API Services, perform the following steps:

  1. Click the API Services button in the API Gateway Analytics toolbar.

  2. Click the Schedule Report button at the top left.

  3. Complete the following fields:

    Schedule Select when to schedule the report. Defaults to Now.
    Time If you do not select to run the report now, select the time of day to run the report.
    On If you do not select to run the report now or daily, select the day of week on which to run the report.
    From Select the period of time for the report. Defaults to Last 7 days.
    Email Enter the email address to which to send the report.


  4. Click Create.

Similarly, you can follow the same sequence of steps to generate reports in the System, Remote Hosts, and Clients views.

Custom Reporting

Oracle API Gateway Analytics enables you to configure custom reports to provide flexible reporting to suit various requirements. This includes viewing any available metric for each target report type, grouping metrics, and filtering metrics.

Custom Report Types

Custom reporting enables you to produce the following types of reports:

  • API service usage

  • API service usage for selected API service(s)

  • Client usage

  • Client usage for selected API service(s)

  • Client(s) that used an API service

  • API service(s) that a client used

Grouping and Filtering Metrics

Custom reporting enables you to group by or filter by any or all of the following:

  • Client Name

  • Service Name

  • Instance Name

  • Group Name

[Note] Note

The group-by mechanism only applies to the data table below the report chart. The chart remains the same.

These filtering and grouping mechanisms enable you to answer questions such as Client(s) that used an API Service, or API service(s) that a client used. For example, to show clients that used WebService1, you can create a custom report that groups by Client Name and filters where Service Name is WebService1.

Defining Custom Reports

Oracle API Gateway Analytics enables you to define custom report names, the metrics to be displayed and charted, and what to display on drill through. For example, the following screen shows a custom report named OAuth Authorization, which is grouped by Service Name, and filtered by service name beginning with OAuth.

Custom Report