Install API Gateway Analytics

Contents

Overview
Prerequisites
Install API Gateway Analytics
Start API Gateway Analytics
Enable PDF report generation
Further information

Overview

API Gateway Analytics is a server runtime and web-based console for analyzing and reporting on API use over extended periods of time. For more details on API Gateway components and concepts, see the API Gateway Concepts Guide.

Prerequisites

Ensure that all of the prerequisites detailed in the section called “Prerequisites” are met.

Enable PDF report generation

To enable the automatic generation of PDF reports, you must download the wkhtmltopdf tool, and install it into your API Gateway Analytics installation. For more details, see the section called “Enable PDF report generation”.

Install API Gateway Analytics

To install API Gateway Analytics in GUI mode, perform an installation following the steps described in the section called “GUI installation”, using the following selections:

  • Select to install the API Gateway Analytics component only.

To install API Gateway Analytics in unattended mode, follow the steps described in the section called “Unattended installation”.

The following example shows how to install the API Gateway Analytics component in unattended mode:

Windows 

OAG-11.1.2.3.0-windows-installer.exe --mode unattended 
--setup_type advanced
--enable-components analytics 
--disable-components nodemanager,apigateway,policystudio,
apitester,configurationstudio

Linux 

./OAG-11.1.2.3.0-linux-installer.run --mode unattended 
--setup_type advanced
--enable-components analytics 
--disable-components nodemanager,apigateway,policystudio,
apitester,configurationstudio

[Note] Note

This topic describes how to install the API Gateway Analytics component only. For details on installing other components, see the following topics:

Start API Gateway Analytics

[Important] Important

Before starting API Gateway Analytics, you must perform the following steps:

  1. Create a database instance. For more details, see Configure the database for API Gateway Analytics. Alternatively, if you already have an existing database, skip to the next step.

  2. Configure the database tables using the dbsetup script. For more details, see Configure the database for API Gateway Analytics.

  3. Update your API Gateway Analytics configuration using the configureserver script. For more details, see Configure API Gateway Analytics.

To start 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 host name 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 under the Users and Groups node in the Policy Studio tree view.

[Note] Note

API Gateway Analytics produces reports based on metrics stored by API Gateway when processing messages. To produce a graph showing the number of connections made by API Gateway to a service, you must first configure a policy that routes messages to that service. When this policy is configured, send messages through the policy so they are routed to the target service.

If you change to another database that has a different set of remote hosts/clients configured, you must restart API Gateway and API Gateway Analytics.

Enable PDF report generation

To enable the automatic generation of PDF reports, perform the following steps:

  1. Download the wkhtmltopdf tool from the following location:

    http://code.google.com/p/wkhtmltopdf

  2. Install wkhtmltopdf into the following directory in your API Gateway Analytics installation:

    Windows INSTALL_DIR\oaganalytics\Win32\lib\wkhtmltopdf
    UNIX/Linux INSTALL_DIR/oaganalytics/platform/bin/wkhtmltopdf


Further information

For more details on topics such as using Policy Studio to configure policies, scheduled reports, viewing monitoring data in API Gateway Analytics, or purging the reports database, see the Oracle API Gateway User Guide and the Oracle API Gateway Administrator Guide.

Prev  Up  Next
  Home