Configuring log settings - Platform - BlueCat Gateway - 22.4.1

Gateway Administration Guide

Locale
English (United States)
Product name
BlueCat Gateway
Version
22.4.1

Set Gateway log levels, the logging destination — either to a file or STDOUT (Standard Out) — log retention, and log rotation.

Note: You must map a logging 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 the Installing BlueCat Gateway section of the BlueCat Gateway Installation Guide.
Follow the steps below to configure log settings for BlueCat Gateway:
  1. Log in to BlueCat Gateway.

  2. Select Administration > General Configuration.

  3. Click Log Settings.

  4. In the Session Logging Level drop-down list, select one of the following options: DEBUG, INFO, WARNING, ERROR, CRITICAL, or NOTSET.

    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.
  5. 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 of security and access-related messages.

    1. Decide how many message logs to retain.
      • To retain all message logs, select the Keep All Logs checkbox.
      • To retain only a specific number of message logs, clear the Keep All Logs checkbox, then enter the number of message logs to keep in the Number of Logs to Retain field. The number of logs to retain should be equal to or greater than 0.
    2. In Maximum Log File Size (MB), specify the maximum size of the message 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 message log destination at all.
  6. Click Save.

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