Logging Appender Reference

You can create a file appender or JMS appender. For each appender, you specify properties.

File Appender

<LogAppender xsi:type="amxdata:FileLogAppender" attributeList />
Property Required? Editable? Accepts SVars? Description
File Path Y Y Y The fully-qualified path to the log file. The filename component of the path is appended with a number as described in 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.TibcoHostNode. - Successfully finished processing of RDA rda6705267566599374829.zip
In addition to the default format, TIBCO ActiveMatrix 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

When the CBE file appender is chosen, the appender's layout is set to BEF2CBELayout, whose pattern is not configurable.

Max File Size Y Y Y The maximum size of each log file in kilobytes.
Max Backup Index Y Y Y 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: The Max Backup Index field is pre-populated with the following value: 

%%node_log_max_backup_index(,,,25)%%

That is, to specify the Max Backup Index value, you can define a substitution variable at the enterprise level or a node level: 

%%node_log_max_backup_index%%

If a substitution variable is not defined, the default for Max Backup Index is 25.

Note:
  • To enable many TRACE or DEBUG loggers, increase the value of Max Backup Index. The change is effective for all runtime nodes and the SystemNode where the log appender is applied.
  • To enable verbose logging for specific nodes only, consider creating a separate log appender with a high Max Backup Index value and apply the new appender on the specific nodes.

JMS Appender

<LogAppender xsi:type="amxdata:JmsLogAppender" attributeList />
GUI Property Required? Editable? Accepts SVars? Description
JNDI Connection Factory Y Y Y A JMS Connection Factory resource template.
JNDI Connection Y Y Y A JNDI Connection Configuration resource template.
JNDI Destination Y Y Y A JMS Destination resource template.
Log Message Expiration Time (h) N Y Y The length of time before a log entry is marked as expired. Expired log entries are purged from the database according to the cl_logservice_timeinterval property of the log service.
Payload Logging (optional)
Payload Logging N Y

Indicate whether payload logging should be enabled. When checked, the Payload Connection Factory, Payload Connection, Payload Destination, and Shared Disk URL fields display.

Default: unchecked.

Payload Connection Factory Y Y Y A JMS Connection Factory resource template.
Payload Connection Y Y Y A JNDI Connection Configuration resource template.
Payload Destination Y Y Y A JMS Destination resource template.
Shared Disk URL (optional) N Y Y The complete path to the file where the payload data is saved.

If blank, the payload data is saved to the payload service database.