Cisco ACI plugin logging - Adaptive Applications - BlueCat Gateway - 23.1

BlueCat Cisco ACI Adaptive Plugin Guide
Locale
English
Product name
BlueCat Gateway
Version
23.1

Activities and events from Cisco ACI are logged in the messages.log file, stored in the Gateway logs folder that was configured during installation. By default, Cisco ACI Plugin logs events at the INFO level. This level includes warning, error, and non-critical information events.

Cisco ACI uses BlueCat Gateway's standard logging features, such as log rotation. New log files are created each time the Apache server is restarted or it exceeds a specified size. If the number of archived log files exceeds a specified value, the oldest log file is deleted. By default, new log files are rotated when a file reaches 10MB, and the last 10 log files are retained, though you can change this in the Logs settings. For more details, see Log rotation in the BlueCat Gateway Administration Guide.

To configure the log level, log rotation logging settings, and other logging behaviour, go to the Logs section of Gateway's General configuration page. (From Gateway, click the Navigator button if necessary, then click Configurations > General configuration. Click Logs at the bottom to expand the Logs settings.)

Downloading Cisco ACI logs

To download Cisco ACI logs:

  • From Cisco ACI, click the System icon in the page header and select Download logs.

    You must have the appropriate permissions to see the System icon or the Download logs command. If you do not see them, this is typically for one of two reasons:

    • The Address Manager BlueCatGateway user was not configured as an admin user during installation and setup. Gateway (and Cisco ACI) signs in as this user when connecting to Address Manager.

      For more details on setting up the BlueCatGateway user as an administrator, see Creating a BlueCat Gateway user in Address Manager

    • The current user logged in to Gateway does not have the Download Logs permission. By default, admin users have access to all permissions, but you can grant non-admin users this permission from the Gateway Permissions page. To do so:

      1. While signed in as an administrator user, open the Permissions page. (Click the Navigator button if necessary, then click Configurations > Permissions.)

      2. In the table of permissions, click the permission you want to assign in the Permission column (in this case, download_logs).

      3. In the details page, click Edit (in the lower right corner).

      4. Edit the list of user groups assigned to the permission as desired. To assign the permission to all users, add the all user group.

      5. When you're done, click Save.

      For more details, see Setting page and REST endpoint permissions in the BlueCat Gateway Administration Guide.

For more details on downloading Gateway (and Cisco ACI) log files, see Downloading BlueCat Gateway log files in the BlueCat Gateway Administration Guide.

Logged events and notifications

Cisco ACI logs events in the standard Gateway messages.log file for the instance of Gateway on which it is hosted. Logged events include the creation of all Address Manager Configurations, Blocks, Networks, and Devices.

Gateway also uses the messages.log file to track its own warnings, errors, and events. All Cisco ACI log messages are preceded with [ACI Plugin].

Tip:

On a Linux system, you can use regular expressions with grep to extract only messages pertaining to Cisco ACI. To do so, use the following command:

$ cat <directory path where message log is located>/<message log file name> | grep "ACI Plugin"

To further filter the list to see only Cisco ACI error messages, use this command instead:

$ cat <directory path where message log is located>/<message log file name> | grep "ACI Plugin" | grep "ERROR"