Configuring Application Logging

You can view the Log4j configuration for an application on the Loggers and Appenders tabs. The same configuration is generated in the node-log4j.xml file.

You can add, update, or delete loggers and appenders. Multiple appenders can be assigned to a logger. Any changes made to this configuration are applied to all the nodes at runtime.

Note: You cannot create a logger with the name 'root' (or any variant of this by case sensitivity). If you try to add such a logger, a warning message is displayed. You cannot rename the existing root logger.

Fields on the Logger Tab

Property Required? Editable? Description
Logger Name Y Y The name of the logger.
Appender Y Y The destination to which log events are appended.
Console Appender N Y Select the check box in the Console Appender column to display logs on the console.
Level Y Y

All events of a level equal to or lower (less verbose) than the specified level are logged. For the Info level, Info, Warn, Error and Fatal events are logged.

  • TRACE: All events.
  • DEBUG: Fine-grained informational events used for debugging an application.
  • INFO: Coarse-grained informational messages that highlight the progress of the application.
  • WARN: Potentially harmful events.
  • ERROR: Errors that allow the application to continue running.
  • FATAL: Errors that cause the application to fail.
  • OFF: Blocks passing messages to a parent
Appender Tab
Property Description
Name Name of the logging appender.
Location

The fully-qualified path to the log file.
Max Size(KB)

The maximum size of each log file in kilobytes.

Default: 10240 KB
Max Backup Num

The number of log files to keep.

When a log file reaches the maximum size, a new log file is created. After the number of files matches the number specified, the oldest is deleted when a new file is created. Each file is appended with a number.

Default: 25

That is, to specify the Max Backup value, you can define a substitution variable: %%node_log_max_backup_index%%
Pattern Layout

Controls the format of the log entries for a clear text file appender. Conforms to the log4j pattern layout.

Default:

"%d{dd MMM yyyy HH:mm:ss,SSS} [%t]
[%-5p] %c %X{_cl.correlationId} - %m%n"

This string prints the date, the name of the thread that generated the event, the level of the logged event, the category of the logged event, a correlation ID (an enrichment field), a message, and a line separator. For example: 

17 Dec 2009 16:43:41,250
[Job_Executor2] [INFO ]
com.tibco.amf.hpa.tibcohost.node.TibcoHo
stNode. - Successfully finished
processing of RDA
rda6705267566599374829.zip

In addition to the default format, ActiveMatrix Service Grid - Container Edition also supports the pattern layouts extended with enrichment fields. 

%R{_cl.physicalCompId.matrix.host}
%d'{dd MMM yyyy HH:mm:ss,SSS}' [%t]
[%-5p] %c - %m%n

Note: Pattern layout is not validated in the Application Configurator. Ensure that pattern layout conforms to the Log4j pattern layout.

Note: If the same appender is assigned to the logger with the different level, the one with the highest level is only assigned to the logger.