Web Response Time Analyzer parameters

The following parameters affect Web Response Time Analyzer storage usage and output:
Table 1. Web Response Time Analyzer parameters
Parameter File Description Default
DEBUG
KFC_DEBUG_API KFCMENV Switch to turn on KFC1 API processing trace. Set at either Collector application or Web Response Time Analyzer side to obtain KFC1 API interaction data flow. When set for the Web Response Time Analyzer, this parameter is useful in determining API request processing, or response time output processing and outbound I/O. NO
KFC_DEBUG_CAPTURE KFCMENV Switch to turn on detailed trace of network frame capture interface. Set to output detailed frame capture processing and packet data dump. Generate large amount of output. NO
KFC_DEBUG_FILTER KFCMENV Switch to turn on trace related to API filter definition and processing of reporting data against filter criteria. Useful in debugging what filters are been defined and active. Also show which response time data record pass or failed particular filter. Important in determining no or missing response time output but knowing right data are been captured. NO
KFC_DEBUG_HTTP KFCMENV Switch to turn on detailed trace of HTTP protocol module processing. Useful in general first step in HTTP response time problem determination. Show HTTP transaction details, extracting HTTP header data and basic HTTP merge processing. NO
KFC_DEBUG_HTTPS KFCMENV Switch to turn on detailed trace of HTTPS protocol module processing. Shows HTTPS transaction flow but usually need additional WEB server trace to complement problem determination. NO
KFC_DEBUG_PACKET KFCMENV Switch to turn on detailed trace regarding Web Response Time Analyzer Packet Dispatcher activities. Show packet dispatching data flow and packet content details. Use only for troubleshooting. NO
KFC_DEBUG_SERVICES KFCMENV Switch to turn on detailed trace of TCP/IP service monitoring. NO
KFC_DEBUG_STORAGE KFCMENV Switch to turn on detailed trace of Web Response Time Analyzer storage use. Output storage allocation and deallocation details. Use over a short run to debug new code or changes. NO
KFC_DEBUG_STORAGE_STAT KFCMENV Switch to turn on periodic reporting of Web Response Time Analyzer storage use by executing threads. Output storage usage by thread. Need to have prior knowledge or area of interest. To detect storage leaks, use Rational® Purify®. NO
KFC_DEBUG_SSL KFCMENV Switch to turn on extra SSL-related debug logging, when problems are encountered with Web Response Time and HTTPS transactions. Traces are saved to kfcmserver.log on Windows systems, or kfcm120.log on UNIX systems. NO
KFC_DEBUG_TIMECALC KFCMENV Switch to turn on trace related to response time calculation. Output a subset of KFC_DEBUG_PACKET related to response time calculation. Good for HTTP but for TCP response time easier to just use (UNIT:kfcpccrt DETAIL)
CONFIGURATION

KFC_API_
MEDIASERVER_
LISTEN_PORT

 KFCMENV Use to override the default Web Response Time Analyzer KFC1 API service listen port. Set for both the Transaction Collector and Web Response Time Analyzer. 12121
KFC_DOMAIN_NAME KFCMENV Override or specify internet domain name. Machine Def
KFC_HOST_NAME KFCMENV Override computer defined host name or use it to select which network interface that the program should use for communication

get
hostname()
KFC_HTTP_PORT KFCMENV Specify additional TCP/IP port numbers that the Web Response Time Analyzer should monitor for HTTP application data in addition to the default port number 80. Multiple ports can be specified separated by a comma. 80
KFC_HTTPS_PORT KFCMENV Specify additional TCP/IP port numbers that the Web Response Time Analyzer should monitor for HTTPS application data in addition to the default port number 443. Multiple ports can be specified separated by a comma. 443
KFC_SSL_DECRYPT KFCMENV Enables SSL-related functions such as SSL initialization. This variable is automatically enabled when Web Response Time is set to monitor HTTPS transactions.
KFC_SSL_KEYMAP KFCMENV Sets the SSL servermap. For example, KFC_SSL_KEYMAP=path to servermap.kdb
KFC_SSL_KEYSTORE KFCMENV Sets the SSL keystore. For example, KFC_SSL_KEYSTORE=path to keystore file.kdb
KFC_WORK_PATH KFCMENV The Web Response Time Analyzer runtime work directory Current® Dir
DATA CAPTURE

KFC_CAPTURE_
DEVICE_NAME

 KFCMENV

Allows customers to specify a particular data capture interface name. If not specified or found to be unusable, the Media Service selects an online interface with the lowest device number, for example en0, from the system interface configuration list.

Using the user interface: on UNIX systems, specify a name or IP address; on Windows systems, specify only an IP address.

Using the executable, specify a comma separated list of IP addresses in decimal dot notation, for example, 10.2.1.1,\Device\NPF_{C8CEC568-689C-460C-BFDC-4FFD442D4694}.

 NONE
KFC_RESTRICT_HOST KFCMENV Specifies a comma separated list of IP address and port combinations (in the format ip1:port1,ip2:port2,...) to restrict IP traffic monitoring to only the specified list of web servers. If not specified, then all IP addresses are monitored. Use this parameter to filter out traffic that is not of interest.
Note: If you are using agentless transaction tracking, do not specify any values for this parameter.
 All
KFC_KFC1API_DATA KFCMENV Switch to instruct the Web Response Time Analyzer whether or not to include KFC1 data packets and report their response time data. NO
KFC_BPF_FILTER KFCMENV Specify a kernel filter which filters out TCP traffic that is not of interest. If a filter is specified, only traffic from the specified TCP source or destination port is passed to the Web Response Time Analyzer. For example, add the following line to the kfcmenv file to monitor traffic only from port 9080, then restart the agent:
  • On a Windows system, add KFC_BPF_FILTER=tcp port 9080
  • On a UNIX system, add KFC_BPF_FILTER='tcp port 9080'; export KFC_BPF_FILTER
Restriction: If you are using agentless transaction tracking, do not specify a value for this parameter.
 All
KFC_FAST_CLIENT_MATCH KFCMENV If there are a large number of Client Groups specified in the Application Management Configuration Editor and all Client Groups use only the IP address as the filter, set this parameter to enable IP integer rather than string comparison. This speeds up processing. Set to Y to enable. N
OPERATION

KFC_MAX_
PROTOCOL_POOL_SIZE

 KFCMENV Defines the network protocol processing thread pool size. Set this value to the number of CPUs of the computer on which Web Response Time is installed. 5

KFC_MAX_OUTPUT_
TASK_POOL_SIZE

 KFCMENV Defines the output format thread pool size. No need to increase unless output queue delay is over 10 second or so. 10

KFC_SESSION_HASH_
TABLE_SIZE

 KFCMENV Define session lookup hashing table size. Because the size of the table must be a prime number, the Web Response Time Analyzer uses the prime number closest to the input value. Generally, there is no need to change the default. 9973

KFC_HOUSEKEEPING_
INTERVAL

 KFCMENV Defines the maximum background housekeeping task idle interval in seconds. No need to change. 2
KFC_BASE_INTERVAL KFCMENV Defines the Application Server task periodic cycle frequency in seconds. No need to change. 5

KFC_APPL_
SCHEDULE_WINDOW

 KFCMENV Defines the HTTP merge task schedule frequency in second. Default set to KFC_BASE_INTERVAL.
Note: Do not modify this parameter unless instructed to do so by IBM® Software Support.
 5

KFC_MAX_APPLICATION_
DATA_SIZE

 KFCMENV The maximum size of monitored application request data or the reply data that the Web Response Time Analyzer captures and makes available to the KFC2 API caller for examination (KFC2 Only) Lower to 2000 if storage becomes an issue.
Note: Do not modify this parameter unless instructed to do so by IBM Software Support.
KFC_MAX_TCP_IO_PAUSE KFCMENV Once the Web Response Time Analyzer observes packets sent from the requester to the receiver of a TCP connection, the receiver returns the reply in a timely manner. If the reply is not observed in this pause interval, then the Web Response Time Analyzer considers this TCP session has been abandoned. Perhaps the receiver has hung and is unable to reply, or the network is experiencing transmission problem. In this case, the Web Response Time Analyzer sets this TCP session to the DONE state and generates the corresponding response time report.
Note: No need to change unless special customer transaction scenarios.
180 seconds
KFC_MAX_TCP_REPLY_IDLE KFCMENV Specify the maximum delay in receiving next TCP reply data packets. If no reply data packet is seen within this idle window then the TCP transaction is considered completed and response time calculated.
Note: No need to change unless special customer transaction scenarios.
5
KFC_HEADER_POOL_LIMIT KFCMENV Limits the number of TCP Header buffers allocated, and therefore limits the number of packets. 2 000 000
KFC_DATA_POOL_LIMIT KFCMENV Limits the number of TCP Payload buffers allocated, and therefore limits the payload. 100 000
KFC_MIN_SESSION_COUNT KFCMENV If KFC_HEADER_POOL_LIMIT and KFC_DATA_POOL_LIMIT are set, KFC_MIN_SESSION_COUNT ensures that not all sessions are bypassed. 2

KFC_HTTP_MERGE_QUEUE_
CAPACITY

 KFCMENV Limits the input into the Object Merge Task, including the internal page and embedded object queues within the Object Merge Task. 15 000

KFC_COMPLETED_QUEUE_
DISPOSE_THRESHOLD

 KFCMENV Limits the output queue from the Object Merge Task and discards completed pages before communicating with the Aggregation agent. 1000
HTTP

KFC_HTTP_
CUSTOM_OBJECTS

 KFCMENV Enable customized definition of embedded object types. Multiple types may be specified separated by a comma. This definition is added to the Web Response Time Analyzer default embedded object types. NONE

KFC_HTTP_GROUP_
PAGE_OBJECTS

 KFCMENV Specify embedded HTML page objects should be included in the total response time calculation of the HTML page; otherwise, HTML page and all embedded objects are reported as independent entities YES

KFC_HTTP_
MERGE_REDIRECT

 KFCMENV Specify whether to merge redirected URL requests into the original request. For example, the request, www.cnnfn.com will redirect immediately to Money.cnn.com. The feature will merger Money.cnn.com into www.cnnfn.com and output only www.cnnfn.com as single page object. YES

KFC_HTTP_MERGE_
SESSION_DATA

 KFCMENV Specify embedded HTML page objects should be included in the total response time calculation of the HTML page if the browser uses multiple TCP connections for retrieving these objects concurrently. YES

KFC_HTTP_MERGE_
DUPLICATES

 KFCMENV Specify merging duplicated embedded objects into the same HTML page. NO

KFC_HTTP_SINGLE_
SESSION_PAGE_MODE

 KFCMENV Enforcing merging HTML page and embedded objects must originate of the same TCP connection. In general, page and embedded objects are retrieved via multiple TCP connections. Only found needed for tester where simulation tool use single for all page requests. NO

KFC_HTTP_MERGE_
EXPEDITE_OUTPUT_
THRESHOLD

 KFCMENV Defines the threshold of HTML pages on the queue for entering expedited processing mode where the Web Response Time Analyzer scans only the larger of either one half embedded object queue or the KFC_HTTP_MERGER_OBJ_SCAN_LIMIT. If merge CPU becomes an issue, set this to around 350. No limit

KFC_HTTP_MERGE_
OBJ_SCAN_LIMIT

 KFCMENV Defines the maximum number of embedded object on queue to be examined during each merge scan cycle. This reduces CPU consumption under high workload but at expense of possibility some pages may have incomplete merged objects. Only in effect under expedited mode. If merge CPU becomes an issue set this to around 350. Check run stat matrix Max HTTP Merge Input Queue Size, Max HTTP Merge Page Queue Size, and Max HTTP merge Object Queue Size to find suitable values. No limit

KFC_HTTP_REPLY_
IDLE_THRESHOLD

 KFCMENV The time to wait in seconds to complete an IDLE HTTP transaction so that page object can be formed for processing. This is useful in scenario of long keep alive interval. 5

KFC_HTTP_OUTPUT_
UNMERGED_OBJECTS

 KFCMENV Specify output unmerged embedded objects as page objects. Otherwise, they are discarded. May need to turn on so that some unknown page URL mistakenly identified as objects for them to be output. NO

KFC_HTTP_OUTPUT_
MERGED_OBJECTS

 KFCMENV Specify merged page object response time data details need to be reported. Frequently, only page response time only is of interest to the customer and by not reporting embedded objects save storage and I/O overhead. YES

KFC_HTTP_
REPORT_OBJECTS

 KFCMENV Same as KFC_HTTP_OUTPUT_MERGED_OBJECTS. Specifies whether to output or discard HTTP embedded object response time data for an HTTP filter type (WRM). YES

KFC_HTTP_PROCESS_
DELAY_FACTOR

 KFCMENV This factor multiplies the KFC_APPL_SCHEDULE_WINDOW, and determines the inactivity window of an HTML page. The window is continuously extended as long as there is activity associated with this page, such as an embedded object being merged with the page. The HTML page is considered outstanding as long as this window remains open, and no response time is calculated or reported. Do not edit this parameter except under special circumstances. 3

KFC_HTTP_COMPARE_
IGNORE_CASE

 KFCMENV Switch to indicate whether or not using character case sensitive URL comparison. Windows® Yes else NO

KFC_COMPLETED_QUEUE_
DISPOSE_THRESHOLD

 KFCMENV Overrides the source IP address from the specified HTTP header. Use when Web Response Time is behind a load balancer to set to the client’s IP address. NONE
CPU MANAGEMENT
Note: Use these parameters to specify maximum Web Response Time Analyzer CPU utilization limits. The Web Response Time Analyzer monitors its own CPU usage and adjusts internal processing control by applying heuristic rules and algorithms, maintaining CPU consumption within an 85% to 100% range. The Web Response Time Analyzer produces the best possible monitoring transaction throughput per resource availability and CPU constraints. The default analyzer behavior is no limit.

KFC_CPU_ENFORCE_
MAX_LIMIT

 KFCMENV Switch to turn on CPU management feature. This feature should not be use right away simply because of high CPU utilization. Need to investigate cause of high CPU other than very high network volume. NO

KFC_CPU_
TARGET_THRESHOLD

 KFCMENV

Sets the maximum allowed Web Response Time Analyzer CPU usage limit as a percentage. The minimum is 10% and the maximum is 100% with a default of 40%.  

The default value in kfcmenv is 20%.

 20%
KFC_CPU_MANAGE_PERIOD KFCMENV Defines CPU time calculation period in seconds. Value cannot be less than 30 seconds. Generally, do not change. 60

KFC_CPU_
ACTION_INTERVAL

 KFCMENV Defines the number of consecutive CPU usage management periods needed in order for Web Response Time Analyzer to initiate adjustment actions for maintaining its CPU consumption within the desired target zone. Generally, do not change. 2

KFC_CPU_STAT

 KFCMENV Specifies whether to periodically output CPU usage data. This parameter is effective regardless of the KFC_CPU_ENFORCE_MAX_LIMIT setting. NO
KFC1 APPLICATIONS
KFC_DEBUG_API KFC1 Switch to turn on KFC1 API processing trace. Turn on to debug KFC1 API I/O. NO
KFC_DEBUG_FILTER KFC1 Switch to turn on trace related to API filter definition and processing of reporting data against filter criteria. Limited usefulness here. NO
KFC_DEBUG_TIMESYNC KFC1 Switch to turn on KFC1 and Web Response Time Analyzer time synchronization procedure detail trace. Turn on to debug time sync problem. In almost all cases, bad response timestamp problems are not caused by timestamp adjustment. NO

KFC_API_MEDIASERVER_
LISTEN_PORT

 KFC1 Use to override the default Web Response Time Analyzer KFC1 API service listen port 12121
KFC_DOMAIN_NAME KFC1 Override or specify internet domain name. Machine Def
KFC_HOST_NAME KFC1 Override computer defined host name or use it to select which network interface that the program should use for communication.

get
hostname()

KFC_API_CALLBACK_
TABLE_LIMIT

 KFC1 KFC1 expands response time data callback table as needed up to this limit. After reaching threshold, data discarded and table reused. No need to change unless encountered special storage condition. 12000
KFC_API_NOTIFY_DELAY KFC1 Delay in seconds before KFC1 schedule application callback. Set to 0 in high load condition. High arrival rate scenario, set this to 0. 3

KFC_API_CHECK_
SERVER_REQUIRED

 KFC1 Specify whether it is necessary to periodically check that valid connections exist between KFC1 and the Web Response Time Analyzer. This parameter is only needed in remote connection configuration where abnormal TCP disconnection may not be quickly detected. It is not necessary unless the connection is over internet or there is very little transaction activity. NO

KFC_API_CHECK_
SERVER_INTERVAL

 KFC1 Define the frequency in seconds for checking valid Web Response Time Analyzer connection, if required. Generally, there is no need to change this value. 120
STAT OUTPUT
KFC_CPU_DATA KFCMENV Write periodic CPU usage output to a log. Turn on to check Web Response Time Analyzer CPU use. For example, confirm high CPU use. NO
KFC_BUFFER_POOL_STAT KFCMENV Specifies whether to periodically output buffer pool utilization statistics. YES

KFC_BUFFER_
STAT_INTERVAL

 KFCMENV The buffer pool utilization statistics output interval. 300

KFC_REPORT_TRANS_
ARRIVAL_RATE

 KFC1 Switch to turn on received response time data report rate per minute. Set to document transaction arrival rate. NO

KFC_BUFFER_POOL_
CONTRACTION_PERCENT

KFCMENV The target buffer pool contraction percentage of the free buffer. For example, 80 means releasing 20% of unused buffer.
Note: Do not modify this parameter unless instructed to do so by IBM Software Support.
 90

KFC_HTTP_OUTPUT_
UNMERGED_OBJECTS

KFCMENV Specifies whether to output or discard unmerged HTTP page embedded objects. No