Cloud Discovery & Visibility logging - Adaptive Applications - BlueCat Gateway - 23.1.1

Cloud Discovery & Visibility Administration Guide
Locale
English
Product name
BlueCat Gateway
Version
23.1.1

Activities and events from Cloud Discovery & Visibility (CDV) are logged in log files. These logs include errors and failures, but can also include successful and unsuccessful connections, starting and stopping of visibility and discovery jobs, and more.

By default, CVD logs events at the WARNING level. This includes logs of warnings, errors, and critical events, but not debug or informational events.

CDV stores log files in the logging directory you configured when you installed CDV. You can also download logs from CDV directly.

Note: By default, CDV logs are checked and rotated if each log exceeds 10 MB. CDV retains the last 10 sets of rotated log files.

To view a log of CDV messages and notifications:

  • Click the Notifications bell icon and select Show Logs.

    The Logs window opens overtop the main screen, where you can view a recent history of log messages and notifications.



    Tip: To refresh the list of logs, click the Refresh button.

To change the CDV logging level:

  1. If you haven't already done so, open the Logs window. (Click the Notifications bell button in the top right corner.)

  2. In the top right corner of the Logs window, select the new logging level and click Update.

    You can choose from all standard Python logging levels (NOTSET, DEBUG, INFO, WARNING, ERROR, or CRITICAL).

    Note: NOTSET is a default Python logging level used by some Python-based tools. For CDV logging, NOTSET is equivalent to WARNING. We recommend you use WARNING instead of NOTSET if possible.
    Warning: This setting is not a filter. After you change the logging level, any messages that would have been logged with a higher level will not be logged at all.

To download CDV log files from the CDV UI:

  1. If you haven't already done so, open the Logs window. (Click the Notifications bell button in the top right corner.)

  2. Click the Download Logs button.

    Tip: You can also download logs from the main User menu. From the CDV UI, click the User icon in the top-right corner and select Download log.

  3. Browse to the directory where you want to save the log files. Change the file name (if you want) and click Save.

    CDV downloads its logs to the indicated location.

To configure logging behaviour from API endpoints:

Use GET or POST with the new /config endpoint. 

GET http://<Gateway_url>/cloud-discovery/api/v1/config
This endpoint lets you specify CDV log settings through the API. For example, the following might be returned through a GET request:
{
    "log_level": "WARNING",
    "max_bytes": 1024,
    "backup_count": 10
}

Where each parameter is as follows:

Field/Option Description
log_level

The logging level. You can use all standard logging levels (NOTSET, DEBUG, INFO, WARNING, ERROR, or CRITICAL).

Note: NOTSET is a default Python logging level used by some Python-based tools. For CDV logging, NOTSET is equivalent to WARNING. We recommend you use WARNING instead of NOTSET.
max_bytes

backup_count

The max_bytes setting sets or specifies the maximum size of the log file, in bytes. When new entries would cause this size to be exceeded, CDV renames the existing log file for backup and archival purposes, and starts a new one.

The backup_count setting sets or specifies the maximum number of backup files. When creation of a new file would cause the number of files to exceed backup_count, the oldest one is deleted.

For more details about using CDV's REST API endpoints, see REST API endpoints.