Contents
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. This topic describes how to install API Gateway Analytics on the following platforms:
-
Windows
-
Linux
-
Solaris
You must ensure the following:
System Requirements
See the System Requirements to ensure that the target machine is of a suitable specification.
Executable Permission
On Linux/UNIX, you must ensure that the installation executable has the appropriate
permissions in your environment. For example, you can use the chmod command
to update the file permissions.
PDF Report Generation
If you wish to enable the automatic generation of PDF reports, you must download the
wkhtmltopdf tool, and install it into your API Gateway Analytics installation
when installed. For more details, see the section called “Next Steps”.
To patch your existing API Gateway Analytics 11.1.2.2.0 installation, perform the following steps:
-
Back up your existing API Gateway 11.1.2.2.0 installation.
-
Ensure that your existing API Gateway Analytics instance and Node Manager have been stopped. For more details, see the API Gateway User Guide.
-
Unzip API Gateway 11.1.2.2.0 SP1 Analytics over your existing API Gateway 7.2.0 installation directory (for example,
C:\OAG-11.1.2.2.0).
![[Note]](../common_oracle/images/admon/note.png) |
Note |
|---|---|
|
You must also patch your existing 7.2.0 Core Server. For more details, see the section called “Patching API Gateway 11.1.2.2.0 Core Server”. |
Use the API Gateway 11.1.2.2.0 installation executable to install a new API Gateway Analytics installation from scratch without an existing version. When you run the executable in default GUI mode, you are presented with an introductory welcome screen. Click Next to continue with the installation.
For details on installing on the command line, see the section called “Unattended Installation”.
Enter or click Browse to specify the directory where you wish to install API Gateway components, for example:
Click Next to continue.
Ensure that the API Gateway Analytics component is selected in the list, and click Next to continue.
|
Note |
|---|---|
|
This topic describes how to install the API Gateway Analytics component only. For details on installing other components, see the following topics:
|
![[Important]](../common_oracle/images/admon/important.png) |
Important |
|---|---|
|
Before starting API Gateway Analytics, you must perform the following steps:
|
API Gateway Analytics is about to be installed.
The installer is ready to start installing the selected components and settings on your system.
Click Next to continue.
A screen is displayed showing the progress of the installation of files. Please wait for the installation to complete.
Click Next to continue.
After the installer has finished, click Finish to complete the installation.
You can run the API Gateway installer in unattended mode on the command line. The following command shows an example of installing the API Gateway Analytics component only:
Windows
OAG-11.1.2.2.0-windows-installer.exe --mode unattended --enable-components analytics --disable-components nodemanager,policystudio,apitester,,configurationstudio
Linux
./OAG-11.1.2.2.0-linux-installer.run --mode unattended --enable-components analytics --disable-components nodemanager,policystudio,apitester,configurationstudio
The specified components are installed in the background.
Further Information
For a description of all available command options and default settings, enter the
--help option. This outputs the help text in a separate console.
When you have installed API Gateway Analytics, the next step is Configuring the Database for API Gateway Analytics.
PDF Report Generation
If you wish to enable the automatic generation of PDF reports, perform the following steps:
