Install API Gateway Analytics

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.

Note   API Gateway Analytics is deprecated and will be removed in a future release.


Ensure that all of the prerequisites detailed in Prerequisites are met.

Axway license file

You must have a valid Axway license file to install API Gateway Analytics. To obtain an evaluation trial license or a full license, contact your Axway Account Manager.

Install API Gateway Analytics

To install API Gateway Analytics in GUI mode, perform an installation following the steps described in Installation options, using the following selections:

  • Select the Custom setup type.
  • Select to install the API Gateway Analytics component.

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

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

./APIGateway_7.5.3_Install_linux-x86-32_BN<n>.run --mode unattended 
--setup_type advanced 
--enable-components analytics 
--disable-components nodemanager,apigateway,qstart,policystudio,
--analyticsLicenseFilePath myanalyticslicense.lic

Configure your API Gateway Analytics database

Note   Before starting API Gateway Analytics, you must perform the following steps:
  1. Create a database instance. For more details, see Configure the metrics database. Alternatively, if you already have an existing database, skip to the next step.
  2. Update your API Gateway Analytics configuration with the database details using the configureserver script. For more details, see Configure API Gateway Analytics.
  3. Configure the database tables using the dbsetup script. For more details, see Configure the metrics database.
  4. Enable writing of metrics from your API Gateway instance to the database using the managedomain tool. For more details, see Configure API Gateway Analytics.

Start API Gateway Analytics

To start API Gateway Analytics, perform the following steps:

  1. Start the API Gateway Analytics server using the analytics script in the bin directory of your API Gateway Analytics installation.
  2. To launch API Gateway Analytics, enter the following address in your browser:
  3. http://HOST:8040/
  4. HOST refers to the host name or IP address of the machine on which API Gateway Analytics is running (for example, https://localhost:8040/).
  5. Enter the API Gateway Analytics user name and password.
Note   This is not the same as the API Gateway Manager user name and password. You can edit the API Gateway Analytics user in Policy Studio under the Environment Configuration > Users and Groups > Users node.

Start as a service

You can also run API Gateway Analytics as a service. For more information, see Set up services.

Note   If you change to another database that has a different set of remote hosts or 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:
  2. Install wkhtmltopdf into the following directory in your API Gateway Analytics installation:
Windows INSTALL_DIR\analytics\Win32\lib\wkhtmltopdf
UNIX/Linux INSTALL_DIR/analytics/platform/bin/wkhtmltopdf
Tip   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.

Further information

For more details on topics such as using Policy Studio to configure policies, set up scheduled reports, view monitoring data in API Gateway Analytics, or purge the metrics database, see the API Gateway Policy Developer Guide and the API Gateway Administrator Guide.

Related Links