Secure API Manager uses the Access Manager Analytics Server to provide analytics for reports about Secure API Manager. Access Manager provides a Secure API Manager Dashboard Plug-in that contains reports specific to Secure API Manager. For example, you can see how many API authorizations have occurred or have failed. Use the information in the following sections in Access Manager to enable the Analytics Server and install the Dashboard Plug-in for Secure API Manager.
You must have Access Manager installed to install Secure API Manager. However, the Analytics Server is not installed when you installed Access Manager. Ensure that you meet the following prerequisites before installing the Secure API Manager Dashboard Plug-in:
Table 2-2 Secure API Manager Dashboard Plug-in Prerequisites
|
Prerequisites |
Description |
|---|---|
|
Install and configure the Access Manager components |
|
|
Configure Ports |
Supports port 1470 over TCP and UDP. |
|
Localization |
English only. |
|
Secure API Manager Dashboard Plug-in |
It is included in the analytics_dashboard.x.x.x.x.tar file. You must extra the file to access the Plugins directory that contains the Secure API Manager Dashboard Plug-in. |
|
Analytics Server |
Install the Analytics Server on SUSE Linux Enterprise Server 15 SP3. The dashboard plug-in is only certified with this version of a server. |
You can log in to the Administration Console as an administrator user and access the Secure API Manager Dashboard Plug-in or you can add a user to the configuration store of the Administration Consoles. The second type of user only has access to the Analytics Dashboard and nothing else in the Administration Console.
Access Manager Administration Console > Auditing > Secure Logging Server > Audit Message Using
The Analytics Server installs a Syslog server for use with Access Manager. You must configure Access Manager to use this instance of the Syslog server. The Analytics Server uses the Syslog server to gather the information to generate the reports displayed in the Dashboard Plug-in. You must configure the Syslog server so that the reports will have data to display.
To configure the Analytics Server to receive the events from the API Gateway:
Log in to the Administration Console.
On the left side, click Auditing.
Under Secure Logging Server > Audit Message Using, select Syslog.
In Server Listening Address, specify the IP address of the Syslog server and port 1470.
(Optional) Select any of the Management Console Events you want to see through the Identity Server. You can select none or any of the options to see more information.
Click Apply, then click OK to save these changes.
After you have met the prerequisites, you can now install the Secure API Manager Dashboard Plug-in.
Analytics Server
After you have met the prerequisites, you can now install the Secure API Manager Dashboard Plug-in on the Analytics Server to generate reports about the activity that occurs in Secure API Manager. You install the Secure API Manager Dashboard Plug-in on the Analytics Server. You mange the Secure API Manager Dashboard Plug-in through the Access Manager Administration Console.
To install the Secure API Manager Dashboard Plug-in:
Access the directory through the command line where you extract the analytics_dashboard.x.x.x.x.tar file when you installed the Analytics Server Dashboard.
Change into the /Plugins/Sapim directory.
Execute the install script located in this directory using the following command:
./plugin_install.sh
To see the Secure API Manager Dashboards:
Log in to the Administration Console.
Click Devices > Analytics Servers > Analytics Dashboards.
Select any of the Secure API Manager Dashboards to view the analytics of your deployment.
(Optional) You can create custom dashboards if you want additional reports than what the Secure API Manager Dashboard Plug-in provides.
Analytics Server
If you ever need to uninstall the Secure API Manager Dashboard Plug-in, you can find an uninstall script in the same directory that contains the installation script. This script uninstalls only the Secure API Manager Dashboard Plug-in and no other component of Access Manager or Secure API Manager.
Using the command line utility, access the directory /analytics_dashboard.x.x.x.x/Plugins/Sapim.
Enter the following command to uninstall the plug-in:
./plugin_uninstall.sh