4.1 Monitoring Secure API Manager

You can monitor your Secure API Manager system through the Deployment Manager and the administration console. Each place contains different information about the system. Plus, Secure API Manager provides log files for each component as well as log files for the entire system to help troubleshoot any issues with the system.

4.1.1 Monitoring the Components

The Deployment Manager monitors the deployment process and well as the status of each component in the system when they are functional. The Status tab displays the status of the different components while the Deployment Manager creates and deploys the different components. For more information, see Understanding the Secure API Manager Deployment Manager in the NetIQ Secure API Manager 1.0 Installation Guide.

The Deployment Manager also monitors and displays the status of the different components after a successful deployment. The Overview tab displays an overview of the entire system.

To access the Overview tab in the Deployment Monitor:

  1. Log in to the appliance management Console as the vaadmin user.

    https://mycompany.example.com:9443

  2. Click Deployment Manager, then click the Overview tab.

  3. Click Refresh to refresh the page to see the most current state of the components.

  4. View the status of the components under Components.

4.1.2 Accessing the Logs for the Components

NetIQ uses Docker to create the Secure API Manager components. The Deployment Manager moves the log files from Docker and places the files on the local file system of the appliance. The Deployment Manager then zips the log files into a log bundle. It then periodically truncates the log files to zero bytes to allow the files to start growing again. This ensures that the log files do not use all of the available disk space on the appliances.

The Deployment Manager places the files in the /var/opt/microfocus/sapim/logbundles directory on the local file system of the appliance. To avoid having too many log files, the Deployment Manager limits the maximum number of files to 10 files per component.

The names of the log bundles are:

  • Analytics: ANLogBundle.StartPeriod.EndPeriod.jar

  • API Gateway: GWLogBundle.StartPeriod.EndPeriod.jar

  • Lifecycle Manager: LMLogBundle.StartPeriod.EndPeriod.jar

  • Database Services: SDLogBundle.StartPeriod.EndPeriod.jar

  • Deployment Manager: DMLogBundle.StartPeriod.EndPeriod.jar

To access the files, use the virtual systems tools and then open the files in a text editor.

4.1.3 Monitoring the Secure API Manager System

The management console provides many different tools that allow you to monitor the Secure API Manager system. When you log in to the management console, the Home page displays a lot of information and statistical information about your system, such as system uptime, the version of Java, and the operating system version.

The management console also provides a number of reports for the Secure API Manager system. It has reports about the JVM, system statistics, event tracker, SOAP track, and the message flows. It also provides the ability to view and search the content of the system logs.

To view the reports about the system:

  1. Log in to the Secure API Manager management console as an administrator.

    https://lifecycle-manager-dns-name:9443/carbon

    The dns-name is the fully qualified host name of the appliance running the Lifecycle Manager component.

  2. Click the Monitor tab, then select the appropriate report that you want to view.