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, see the API Gateway Analytics User Guide.

Prerequisites

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.6.2_Install_linux-x86-32_BN<n>.run --mode unattended 
--setup_type advanced 
--enable-components analytics 
--disable-components nodemanager,apigateway,qstart,policystudio,
apitester,configurationstudio,apimgmt,cassandra,packagedeploytools
--analyticsLicenseFilePath myanalyticslicense.lic

Configure your metrics database for API Gateway Analytics

Note   Before starting API Gateway Analytics, you must perform the following steps:
  1. Create a database instance to store metrics for API Gateway Analytics. 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.
  3. Configure the database tables using the dbsetup script.
  4. Enable writing of metrics from your API Gateway instance to the database using the managedomain tool.

For more details on how to perform these steps, see the API Gateway Analytics User Guide.

Start API Gateway Analytics

When you have configured your metrics database and API Gateway Analytics, you can start up API Gateway Analytics. For more details, see the API Gateway Analytics User Guide.

Start as a service

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

Further information

For details on how to set up scheduled reports, view monitoring data in API Gateway Analytics, or purge the metrics database, see the API Gateway Analytics User Guide.

For details on using Policy Studio to configure policies, see the API Gateway Policy Developer Guide.

Related Links