Configuring Logs settings - Platform - BlueCat Gateway - 25.3.0

Gateway Administration Guide
ft:locale
en-US
Product name
BlueCat Gateway
Version
25.3.0

Logs settings (on the General Configuration page) let you configure Gateway log levels, the logging destination (either to a file or STDOUT (standard out)), log retention, and log rotation settings.

Important:

To use Gateway logs, you must map a logs directory to apply log settings to the Gateway container. If you do not map a logging directory, all logs will be written inside the container and deleted when you remove the container.

For more information, see Installing BlueCat Gateway in the BlueCat Gateway Installation Guide.

To configure log settings:

  1. Open the General configuration window, then expand the Logs section. (Click Settings at the bottom of the navigator on the left, expand Configurations, then click General configuration. Click Logs to scroll to the Logs section.)

  2. Configure the Logs settings as desired.

    For more details, see Logs settings list below

  3. When you're done, click Save.

    To cancel your changes, click Cancel.

    Note: Except for Number of logs to retain, you must restart the BlueCat Gateway container to apply changes to log settings.

Logs settings list

The Logs section has the following settings.

Setting Description
Logging level

The Logging level setting specifies the lowest level of error to include in BlueCat Gateway logs. For example, if the Logging level is WARNING, then WARNING, ERROR, and CRITICAL messages are logged, but DEBUG and INFO messages are not.

Attention: By default, the session level is set to ERROR. Before deploying BlueCat Gateway into a production environment, select the logging level that best suits the needs of your environment.

From lowest to highest, available log levels are NOTSET, DEBUG, INFO, WARNING, ERROR, and CRITICAL.

Message log settings

Access log settings

Settings that configure the log retention and output behavior for the indicated type of message.

  • Message log settings configure behavior for general messages.

  • Access log settings configure behavior for security and access-related messages.

Available settings in each section are:

  • Keep all messages/access logs: If ticked, Gateway retains all log messages of the specified type.

    If cleared, Gateway retains only the most recent of certain number of log messages.

    Note: As of Gateway 25.1.1, this option is cleared by default. In previous versions, it is ticked by default.

  • Number of logs to retain: (Appears only if Keep all messages/access logs is cleared) The number of most-recent log messages of that type to retain. The number of logs to retain must be equal to or greater than 0.

    By default, the number of logs to retain is 10.

  • Maximum log file size: The maximum size of the log file for messages of that type. The default size is 10 MB.

  • Log to file: If ticked, Gateway logs all messages of that type to a file in the Gateway logs directory.

  • Log to standard out: If ticked, Gateway logs messages of that type to the standard out channel (stdout).
    Tip: You can log messages to both stdout and a file at the same time. You can also not set any log destination at all.