ARM Appender Pattern Layouts for ARM Messages

The ARM appender includes options to create the output message format. The options are in the form of pattern layouts, which consist of a named diagnostic context recognized by the ARM appender. The following tables list the diagnostic context pattern layouts for the ARM appender.
All text is case sensitive in the SAS logging configuration file. Enter elements, names, attribute names, and literal values as they are shown in the ConversionPattern syntax.
Application Level Specifications
Specification
Description
%X{App.Name}
Application name that is specified in the configuration file. A SAS ARM macro initializes the application call or the LOGAPPLNAME= option.
%X{ARM.AppHandle}
A unique ID that is associated with an application instance.
%X{ARM.AppId}
A unique ID that is associated with the application class.
%X{ARM.GroupName}
The group name of the application instances. The value is specified in the configuration file or user ID, if available.
Application Metric Specifications
Specification
Description
%X{ARM.AppStart.Time}
The time-of-day value for the ARM application start event.
%X{ARM.AppStart.System_CPU_Time}
The process system CPU time at the ARM application start event.
%X{ARM.AppStart.User_CPU_Time}
The process user CPU time at the ARM application start event.
%X{ARM.AppStop.Time}
The time-of-day value for the ARM application end event.
%X{ARM.AppStop.System_CPU_Time}
System CPU time for the ARM application end event.
%X{ARM.AppStop.User_CPU_Time}
User CPU time for the ARM application end event.
All text is case sensitive in the SAS logging configuration file. Enter elements, names, attribute names, and literal values as they are shown in the ConversionPattern syntax.
Transaction Level Specifications
Specification
Description
%X{ARM.TranName}
Transaction name, specified in the appropriate ARM start transaction call.
%X{ARM.TranState}
The transaction state: init, start, stop, update, block, unblock, or discard.
%X{ARM.TranId}
A unique ID that is associated with the transaction class.
%X{ARM.TranHandle}
A unique ID that is associated with a transaction instance.
%X{ARM.CurrentCorrelator}
The transaction correlator for the transaction instance returned by the start transaction event.
%X{ARM.ParentCorrelator}
The transaction correlator for the direct ancestor transaction, automatically generated when the ManageCorrelators parameter is enabled.
%X{ARM.TranStatus}
The value specified for the stop transaction event, such as good, aborted, failed, or unknown.
%X{ARM.Userid}
The current user ID that is associated with the transaction.
Transaction Metric Specifications
Specification
Description
%X{ARM.TranBlocked.Time}
The time-of-day value for the current transaction block event. (Reserved for future use.)
%X{ARM.TranStop.Time}
The time-of-day value for the current transaction stop event.
%X{ARM.IO_Count}1
The total number of process disk, tape, or related input and output operations for a transaction. The computed delta between start and stop transaction events.1
%X{ARM.System_CPU_Time}
Process current system CPU time for the ARM event.
%X{ARM.TimeStamp}
Current time-of-day value for the ARM event.
%X{ARM.TranBlocked.System_CPU_Time}
Process system CPU time for the current transaction block event. (Reserved for future use.)
%X{ARM.TranBlocked.User_CPU_Time}
Process user CPU time for the current transaction block event. (Reserved for future use.)
%X{ARM.TranResp.System_CPU_Time}
Calculated system CPU time for the duration of the transaction.
%X{ARM.TranResp.Time}
Calculated elapsed time for the duration of the transaction.
%X{ARM.TranResp.User_CPU_Time}
Calculated user CPU time for the duration of the transaction.
%X{ARM.TranStart.IO_Count}1
The total number of process disk, tape, or related input and output operations for the transaction event.1
%X{ARM.TranStart.Mem_Current}
Current process memory utilization for the transaction event.
%X{ARM.TranStart.Mem_High}
Process the highest amount of memory used for the transaction event.
%X{ARM.TranStart.System_CPU_Time}
Process system CPU time for the current transaction start event.
%X{ARM.TranStart.Thread_Current}
Current process thread count for the transaction event.
%X{ARM.TranStart.Thread_High }
Process the highest thread count for the transaction event.
%X{ARM.TranStart.Time}
The time-of-day value for the current transaction start event.
%X{ARM.TranStart.User_CPU_Time}
Process user CPU time for the current transaction start event.
%X{ARM.TranStop.IO_Count}1
The total number of process disk, tape, or related input and output operations for the transaction event.1
%X{ARM.TranStop.Mem_Current}
Current process memory utilization for the transaction event.
%X{ARM.TranStop.Mem_High}
Process the highest amount of memory used for the transaction event.
%X{ARM.TranStop.System_CPU_Time}
Process system CPU time for the current transaction stop event.
%X{ARM.TranStop.Thread_Current}
Current process thread count for the transaction event.
%X{ARM.TranStop.Thread_High }
Process the highest thread count for the transaction event.
%X{ARM.TranStop.User_CPU_Time}
Process user CPU time for the current transaction stop event.
%X{ARM.User_CPU_Time}
Process current user CPU time for the ARM event.
1%X{ARM.IO_Count} is the computed delta between start and stop transaction events. %X{ARM.TranStart.IO_Count} and %X{ARM.TranStop.IO_Count} are just counts, not computed deltas.
ARM 2.0 Transaction Metric Specifications
Specification
Description
%X{ARM2.Metric.Data}
ARM 2.0 format 1 metric data.
%X{ARM2.F2.Data}
ARM 2.0 format 2 data buffer contents for ARM update records.
%X{ARM2.Metric.MData}
ARM 2.0 format 101 metric metadata data buffer contents.
%X{ARM2.Record}
ARM 2.0 output record format message contents.
%X{ARM2.TranIdentity}
ARM 2.0 transaction detail information.
ARM 2.0 data buffers are changed to ARM 4.0 sub-buffers.
ARM Sub-Buffer Metric Values
Specification
Description
%X{ARM.Metricn.Type}
ARM sub-buffer metric type (n value can be 1 ... 7).
%X{ARM.Metricn.Usage}
ARM sub-buffer metric usage (n value can be 1 ... 7), values are general, transaction, or transaction name.
%X{ARM.Metricn.Value}
ARM sub-buffer metric value (n value can be 1 ... 7).
%X{ARM.Metricn.Unit}
String description of the metric, such as files transferred (n value can be 1 ... 7).
ARM 2.0 data buffers are changed to ARM 4.0 sub-buffers.
ARM Transaction Identity and Context Sub-Buffers
Specification
Description
%X{ARM.TranIdentityn.Name}
Optional transaction class name properties.
%X{ARM.TranIdentityn.Value}
Optional transaction class value properties.
%X{ARM.TranIdentity.URI}
Optional transaction URI.
%X{ARM.TranContextn.Name}
Optional transaction context instance name.
%X{ARM.TranContextn.Value}
Optional transaction context instance value.
%X{ARM.TranContext.URI}
Optional transaction context instance URI.
Copyright © SAS Institute Inc. All rights reserved.