About Siebel ARM Parameters and Variables

The following parameters on the Siebel Server enable and configure the Siebel ARM feature. The Siebel ARM parameters and environment variables are equivalent in function and similar in naming convention.

See Table 14-2 for a listing of each Siebel ARM parameter and its equivalent environment variable. Descriptions of each parameter and environment variable follow the table. For more information about enabling Siebel ARM using these parameters and environment variables, see "Enabling and Configuring Siebel ARM".

Table 14-2 Siebel ARM Parameters and Environment Variables

Parameter Display Name	Parameter Alias	Environment Variable Name
SARM Granularity Level	SARMLevel	SIEBEL_SARMLevel
SARM Buffer Size	SARMBufferSize	SIEBEL_SARMBufferSize
SARM Period	SARMPeriod	SIEBEL_SARMPeriod
SARM Max Number of Files	SARMMaxFiles	SIEBEL_SARMMaxFiles
SARM Data File Size	SARMFileSize	SIEBEL_SARMFileSize

SARM Granularity Level

This parameter or equivalent environment variable specifies the amount of response measurement detail logged to Siebel ARM files, and effectively enables or disables the Siebel ARM feature. SARM Granularity Level has the following settings:

• 0 (OFF). This setting is the default value and disables Siebel ARM.

• 1 (ARM). This setting captures general application performance and is based on the application response measurement (ARM) standard. At this level, Siebel ARM collects information such as process and component boundaries, third-party software calls, database measurements, workflow execution, and script performance. Use this level for general performance monitoring.

• 2 (Detail). This setting captures the information at level 1 as well as detailed information such as steps of workflow execution, construction of large objects, reading of large files, and crossing significant architectural areas. Use this level for problem diagnostics.

SARM Buffer Size

The Siebel ARM framework uses a buffered data generation mechanism. Siebel ARM collects data and stores it in memory. After the in-memory data size reaches a threshold defined by the SARM Buffer Size parameter or equivalent environment variable, Siebel ARM outputs the stored data to file on a physical disk. SARM Buffer Size is specified in bytes. The default value is 5000000 (5,000,000 bytes, approximately 5 MB). Valid settings correspond to values ranging from 100,000 bytes to 50,000,000 bytes.

Note: Siebel ARM also outputs stored data to file based on elapsed time, which is defined by the SARM Period parameter or environment variable. The SARM Period setting can determine the size of the data saved to file rather than the threshold value defined by SARM Buffer Size.

For example, if the setting of SARM Buffer Size is 5 MB and there are five instances (processes) of the component, then the total memory used is 25 MB.

SARM Period

Siebel ARM collects data and stores it in memory. The time period specified by the SARM Period parameter or equivalent environment variable determines when Siebel ARM outputs the stored data to file on a physical disk regardless of the value set for SARM Buffer Size. The value of SARM Period is specified in minutes, and has a default value of 3 minutes. The valid settings range from 1 minute to 60 minutes.

SARM Max Number of Files

This parameter or equivalent environment variable specifies the maximum number of Siebel ARM files created per component instance. The default value is 4, and there is no predefined upper limit to the number of files Siebel ARM creates. (SARM Data File Size configures how large a file becomes before a new file is stored on the physical disk.)

The number of active Siebel ARM files per component process is the value of SARM Max Number of Files plus 1. Siebel ARM removes the oldest file for that process only after the file representing SARM Max Number of Files plus 1 reaches the value of SARM Data File Size. For an example of how to calculate memory usage, see "SARM Data File Size".

SARM Data File Size

This parameter or equivalent environment variable specifies how large a file becomes before Siebel ARM stores data in a new file on the physical disk. The value of SARM Data File Size is specified in bytes. The default value is 15000000 (15,000,000 bytes, approximately 15 MB), and there is no predefined upper limit to file size.

Until the specified size is reached, Siebel ARM continues to append file segments to the current file. When the file limit is reached, Siebel ARM creates a new file. (SARM Max Number of Files configures the number of files maintained by Siebel ARM.)

When Siebel ARM reaches the file number specified by SARM Max Number of Files (that is, the number of files of size SARM Data File Size has reached the value of SARM Max Number of Files), Siebel ARM removes the first file (that is, the oldest file) when the next file reaches the SARM Data File Size limit.

Therefore, the maximum amount of disk space used is approximately SARM Max Number of Files plus 1 times the number of bytes represented by the value of SARM Data File Size. This amount of memory is per-process (per component instance).

For example, if SARM Data File Size is 15 MB, SARM Max Number of Files is 4, and there are 5 instances (processes) of the component, then the maximum amount of disk space consumed is approximately 375 MB; that is, 15 MB per file, times 5 files per process, times 5 processes (instances of the component).