Configuring Logs settings - Platform - BlueCat Gateway - 24.1

Gateway Administration Guide

Product name
BlueCat Gateway

Settings in the Logs section of General Configuration let you configure Gateway log levels, the logging destination (either to a file or STDOUT (Standard Out)), log retention, and log rotation settings.


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 are written inside the container and will be deleted when you restart 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 the Navigator button if necessary, then click Configurations > General configuration. Click Logs at the bottom to expand the Logs settings.)

  2. In Logging level, select one of the following options: DEBUG, INFO, WARNING, ERROR, CRITICAL, or NOTSET.

    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.
  3. In the Message log settings and Access log settings sections, set the logging 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.

    For each type of logs:

    1. Decide how many logs to retain.
      • To retain all logs of that type, select the Keep All Logs checkbox.

      • To retain only a specific number of logs, clear the Keep All Logs checkbox, then enter the number of logs to keep in the Number of logs to retain field. The number of logs to retain must be equal to or greater than 0.

    2. In Maximum log file size (MB), specify the maximum size of the log file. The default size is 10 MB.

    3. To log messages to a file, select the Log to file checkbox.

    4. To log messages to the Standard Out channel (stdout), select the Log to standard out checkbox
      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.
  4. 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.