Configuring log settings - Platform - BlueCat Gateway - 21.11.2

Gateway Administration Guide

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

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 menu, 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. Under the Message Log Settings section, set the following parameters:
    1. Select the Keep All Logs checkbox to retain all the message logs.
    2. Specify the number of message logs to retain on the Number of Logs to Retain field. This field is disabled if Keep All Logs is selected. The number of logs to retain should be equal to or greater than 0.
    3. Specify the maximum size of the message log file on the Maximum Log File Size (MB) field. The default value is 10 MB.
    4. Click the Log to File checkbox to set the message log destination to a file.
    5. Click the Log to Standard Out checkbox to set the message log destination to Standard Out (stdout).
      Note: You can choose to do the following as per your needs:
      • Either to set the message log destination to a file or Standard Out
      • Log to both file or Standard Out
      • Not set any log destination altogether.
  6. Under the Access Log Settings section, set the following parameters:
    1. Select the Keep All Logs checkbox to retain all the access logs.
    2. Specify the number of access logs to retain on the Number of Logs to Retain field. This field is disabled if Keep All Logs is selected. The number of logs to retain should be equal to or greater than 0.
    3. Specify the maximum size of the log file on the Maximum Log File Size (MB) field. The default value is 10 MB.
    4. Click the Log to File checkbox to set the access log destination to a file.
    5. Click the Log to Standard Out checkbox to set the access log destination to Standard Out (stdout).
      Note: You can choose to do the following as per your needs:
      • Either to set the access log destination to a file or Standard Out
      • Log to both file or Standard Out
      • Not set any log destination altogether.
  7. Click Save.
    Note:
    • Restart the BlueCat Gateway container for changes to the log settings configurations to take effect, except for the changes to the Number of Logs to Retain field.