Module mod_arm4_ap20

Important: Information for this topic supports the latest PTF levels for HTTP Server for i5/OS . It is recommended that you install the latest PTFs to upgrade to the latest level of the HTTP Server for i5/OS. Some of the topics documented here are not available prior to this update. See http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm Link outside Information Center for more information.

Summary

The module mod_arm4_ap20 uses the ARM (Application Response Measurement) 4.0 APIs to classify requests and record the time spent for each one. Configuring these directives enables ARM services for the IBM® HTTP Server.

To enable ARM on IBM HTTP Server, perform these steps:

  1. Ensure that the EWLM managed server is configured and started, and that it is communicating properly with its EWLM domain manager.
  2. Ensure that IBM HTTP Server is installed and configured.
  3. Ensure you have the latest required PTFs installed for EWLM to monitor the HTTP Server for iSeries™ application.
  4. Add the following directives to the configuration file: 
    LoadModule arm4_module /QSYS.LIB/QHTTPSVR.LIB/QZSRARM.SRVPGM
ArmLoadLibrary /QSYS.LIB/QSYS2.LIB/LIBARM4.SRVPGM
    To edit the configuration file, follow these steps:
    1. Start the IBM Web Administration for iSeries interface.
    2. Click the Manage tab.
    3. Click the HTTP Servers subtab.
    4. Select your HTTP Server (powered by Apache) from the Server list.
    5. Select System Resources.
    6. Change Activate Application Response Measurment (ARM) instrumentation to Enabled.
    7. Click OK when you finish editing the configuration file.
    8. Stop and restart the HTTP Server.

For more information on eWLM, see Enterprise Workload Manager in the IBM Systems Software Information Center.

Directives

ArmApplicationName

Module: mod_arm4_ap20
Syntax: ArmApplicationName application_name
Default: ArmApplicationName "IBM Webserving Plugin"
Context: server
Override: none
Origin: iSeries
Usage: A LoadModule is required in the configuration file prior to using the directive. The statement should be as follows: LoadModule arm4_module /QSYS.LIB/QHTTPSVR.LIB/QZSRARM.SRVPGM
Example: ArmApplicationName "IBM Webserving Plugin"

IBM HTTP Server for iSeries™ is an ARM-instrumented application. ARM 4.0 enables the real time measurement of transactions, transaction components, and underlying resource usage associated with the execution of an application. Use this directive to set specific information passed by the ARM API function calls which will be used in the filtering criteria that eWLM uses for transaction classification.

ArmInstrumentHandler

Module: mod_arm4_ap20
Syntax: ArmInstrumentHandler on|off
Default: ArmInstrumentHandler off
Context: server
Override: none
Origin: iSeries
Usage: A LoadModule is required in the configuration file prior to using the directive. The statement should be as follows: LoadModule arm4_module /QSYS.LIB/QHTTPSVR.LIB/QZSRARM.SRVPGM
Example: ArmInstrumentHandler off

When the ArmInstrumentHandler directive is turned on, arm_block|unblock_transaction is called across content handlers to notify the IBM ARM implementation that a blocking condition is finished.

ArmLoadLibrary

Module: mod_arm4_ap20
Syntax: ArmLoadLibrary arm4-api-service-program-name
Default: ArmLoadLibrary /QSYS.LIB/QSYS2.LIB/LIBARM4.SRVPGM
Context: server
Override: none
Origin: iSeries
Usage: A LoadModule is required in the configuration file prior to using the directive. The statement should be as follows: LoadModule arm4_module /QSYS.LIB/QHTTPSVR.LIB/QZSRARM.SRVPGM
Example: ArmLoadLibrary /QSYS.LIB/QSYS2.LIB/LIBARM4.SRVPGM

This directive is needed to activate the eWLM (Enterprise Workload Management) instrumentation module for HTTP Server (powered by Apache). It uses the ARM (Application Response Measurement) 4.0 APIs to classify requests and record the time spent for each one.

ArmTransactionName

Module: mod_arm4_ap20
Syntax: ArmTransactionName transaction_name
Default: ArmTransactionName WebRequest
Context: server
Override: none
Origin: iSeries
Usage: A LoadModule is required in the configuration file prior to using the directive. The statement should be as follows: LoadModule arm4_module /QSYS.LIB/QHTTPSVR.LIB/QZSRARM.SRVPGM
Example: ArmTransactionName WebRequest

IBM HTTP Server for iSeries™ is an ARM-instrumented application. ARM 4.0 enables the real time measurement of transactions, transaction components, and underlying resource usage associated with the execution of an application. Use this directive to set specific information passed by the ARM API function calls, which are used in the filtering criteria that eWLM uses for transaction classification.