IOMServerAppender

Writes log messages from any IOM server to a volatile runtime cache.

Valid in:

XML configuration

Table of Contents

Syntax

</layout>

</appender>

Syntax Description

name="MaxEntries" value="maximum-number-of-entries"

an integer that specifies the maximum number of messages that are stored in the cache. When the maximum number is reached, the oldest messages are deleted as new messages are added.

Default	10000
Range	0 to 1000000
Requirement	This parameter is not required.

specifies the lowest event level that this appender processes. Events that are below the specified level are ignored. The valid values are listed here from lowest to highest.

Default	None
Requirement	This parameter is not required.
See	Logging Thresholds

name="ConversionPattern" value="conversion-pattern"

specifies how the log message is written to the log.

Default	None. If a conversion pattern is not specified, then the log event produces an empty string.
Requirement	This parameter is not required.
See	Pattern Layouts

Details

IOM Server Appender writes log messages from any IOM server (for example, a SAS Metadata Server, a SAS OLAP Server, or a SAS Stored Process Server) to a volatile runtime cache. The contents of the cache are available for display on the Log tab of SAS Management Console. For more information, see “Use the Log Tab in Server Manager” in the SAS Intelligence Platform: System Administration Guide.

If you perform a planned deployment, then IOMServerAppender definitions are included in the logging configurations for most of your SAS servers. Follow these best practices when modifying these definitions:

You can adjust the MaxEntries value to capture a larger or smaller number of messages for display.
Do not change the message layout. Changing the message layout could cause messages to be captured incorrectly.

Note: A location for temporary files must be defined on the host operating system. If a location has not been defined, then the process that is being logged fails with the following message:

Error creating IOMServerAppender
                     index cache. The location required for storing temporary utility files
                     does not exist.

If a location for temporary files is not already defined, use one of the following procedures to define it:

On Windows systems, define the TEMP environment variable.
On UNIX systems, create the directory /tmp.
On z/OS systems, create the directory /tmp if you are using a UNIX file system (UFS); or submit the following TSO command:
```
ALLOC UNIT(SYSDA) BLOCK(8192) SPACE(1280,1280)
```

Example

The following instance of IOMServerAppender writes a maximum of 10,000 messages to a runtime cache. When the cache contains 10,000 messages, the oldest messages are deleted as new messages are added.

<appender class="IOMServerAppender" name="IOMServer">
   <param name="MaxEntries" value="10000"/>  
   <layout>
      <param name="ConversionPattern" value="%d %-5p [%t] %X{Client.ID}:%u - %m"/>
   </layout>
</appender>