Configuring Logging

Edit online

About this task

To configure Journal Logging settings for the Analytic Engine instance

Procedure

  1. Navigate to the Logging configuration type and click Edit.
  2. Define the loggers in the provided XML snippet.
    The following table describes the appender parameters.
    Parameter Description
    threshold Threshold level for the target. Threshold levels indicate the level of information that is logged to the target. If you do not specify the threshold level of a journal logger, the logger inherits the assigned level from the root logger. The threshold levels listed in order of increasing importance are:
    • None, or off
    • Trace
    • Debug
    • Info
    • Warn
    • Error
    • Fatal
    The journal logger logs messages that have the threshold level that you specify, as well as messages that have the threshold level that is of higher importance. For example, if the threshold value is Warn, the logger logs Warn, Error, and Fatal messages.
    target The standard output for the logs.
    • System.Err
    • System.Out
    The parameter is available for the Console appender.
    file Name of the file to which you want to log the data. The parameter is available for the TimeOrSize appender.
    datePattern Date/time characters that are appended to each log file name.
    • yyyy-mm-dd. Create a new log file at midnight.
    • yyyy-mm-dd-hh:mm. Create a new log file every minute.
    • yyyy-mm-dd-hh. Create a new file log every hour. hh uses a 24-hour clock.
    • yyyy-mm-dd-{AM|PM}. Create log files at noon and midnight.
    • yyyy-ww. Create a new log file each Sunday at midnight.
    • yyyy-mm. Create a new log on the last day of each month at midnight.
    The parameter is available for the TimeOrSize appender.
    syncOnQueueFull
    • true. Synchronize logs when the maxFileSize is reached.
    • false. Do not synchronize logs when the maxFileSize is reached.
    The parameter is available for the Async appender.
    queueSize The maximum queue size. The parameter is available for the Async appender.
    maxLogLimit Number of log files that are kept in the rollover destination. When the maximum number of log files is reached, the oldest log file is removed and a new one is allocated. The parameter is available for the TimeOrSize appender.
    maxFileSize Restrict the amount of disk space (in megabytes) that is used for logging. The parameter is available for the TimeOrSize appender.
    type Destination where you want to store the rolled over log files. The possible values are:
    • File
    • Directory
    The parameter is available for the TimeOrSize appender.
    hostName The default value is localhost. The parameter is available for the TimeOrSize appender when the value of the type parameter is Directory.
    logDirectory Name of the directory where the rolled over files are stored. Type . if you want the logs to be stored in the default directory. The parameter is available for the TimeOrSize appender when the value of the type parameter is Directory.
    dateFormatString Date format that is used for the rolled over log files. The parameter is available for the TimeOrSize appender when the value of the type parameter is Directory.
    timeFormatString Time format that is used for the rolled over log files. The parameter is available for the TimeOrSize appender when the value of the type parameter is Directory.
    Note: You can edit the default appender parameters, or add appenders to the xml.
  3. Click Save.