188 lines
13 KiB
HTML
188 lines
13 KiB
HTML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<!DOCTYPE html
|
||
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html lang="en-us" xml:lang="en-us">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
<meta name="security" content="public" />
|
||
|
|
<meta name="Robots" content="index,follow" />
|
||
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
||
|
|
<meta name="DC.Type" content="topic" />
|
||
|
|
<meta name="DC.Title" content="Module mod_arm4_ap20" />
|
||
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 2002,2006" />
|
||
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2002,2006" />
|
||
|
|
<meta name="DC.Format" content="XHTML" />
|
||
|
|
<meta name="DC.Identifier" content="rzaiemod_arm4_ap20" />
|
||
|
|
<meta name="DC.Language" content="en-us" />
|
||
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
|
<!-- US Government Users Restricted Rights -->
|
||
|
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
||
|
|
<title>Module mod_arm4_ap20</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzaiemod_arm4_ap20"><a name="rzaiemod_arm4_ap20"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<!--Java sync-link--><h1 class="topictitle1">Module mod_arm4_ap20</h1>
|
||
|
|
<div><div class="important"><span class="importanttitle">Important:</span> 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 <a href="http://www-03.ibm.com/servers/eserver/iseries/software/http/services/service.html" target="_blank">http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm</a> <img src="www.gif" alt="Link outside Information Center" /> for more information. </div>
|
||
|
|
<p><strong>Summary</strong></p>
|
||
|
|
<p>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<sup>®</sup> HTTP Server.</p>
|
||
|
|
<p>To enable ARM on IBM HTTP Server, perform these steps:</p>
|
||
|
|
<ol><li>Ensure that the EWLM managed server is configured and started, and that
|
||
|
|
it is communicating properly with its EWLM domain manager. </li>
|
||
|
|
<li>Ensure that IBM HTTP Server is installed and configured.</li>
|
||
|
|
<li>Ensure you have the latest required PTFs installed for EWLM to monitor
|
||
|
|
the HTTP Server for iSeries™ application.</li>
|
||
|
|
<li>Add the following directives to the configuration file: <pre>LoadModule arm4_module /QSYS.LIB/QHTTPSVR.LIB/QZSRARM.SRVPGM
|
||
|
|
ArmLoadLibrary /QSYS.LIB/QSYS2.LIB/LIBARM4.SRVPGM</pre>
|
||
|
|
To edit the configuration
|
||
|
|
file, follow these steps: <ol type="a"><li>Start the IBM Web Administration for iSeries interface.</li>
|
||
|
|
<li>Click the <span class="uicontrol">Manage</span> tab.</li>
|
||
|
|
<li>Click the <span class="uicontrol">HTTP Servers</span> subtab. </li>
|
||
|
|
<li>Select your HTTP Server (powered by Apache) from the <span class="uicontrol">Server</span> list.</li>
|
||
|
|
<li>Select <span class="uicontrol">System Resources</span>.</li>
|
||
|
|
<li>Change <span class="uicontrol">Activate Application Response Measurment (ARM) instrumentation</span> to <span class="uicontrol">Enabled</span>. </li>
|
||
|
|
<li>Click <span class="uicontrol">OK</span> when you finish editing the configuration
|
||
|
|
file.</li>
|
||
|
|
<li>Stop and restart the HTTP Server.</li>
|
||
|
|
</ol>
|
||
|
|
</li>
|
||
|
|
</ol>
|
||
|
|
<p>For more information on eWLM, see <a href="../icbase/ewlminfo/kickoff.htm">Enterprise Workload Manager</a> in the IBM Systems Software
|
||
|
|
Information Center.</p>
|
||
|
|
<p><strong>Directives</strong></p>
|
||
|
|
<ul><li><a href="#ArmApplicationName">ArmApplicationName</a></li>
|
||
|
|
<li><a href="#ArmInstrumentHandler">ArmInstrumentHandler</a></li>
|
||
|
|
<li><a href="#ArmLoadLibrary">ArmLoadLibrary</a></li>
|
||
|
|
<li><a href="#ArmTransactionName">ArmTransactionName</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="hr" id="ArmApplicationName"><a name="ArmApplicationName"><!-- --></a><h2 class="topictitle2">ArmApplicationName</h2>
|
||
|
|
<div>
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_arm4_ap20</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: ArmApplicationName <em>application_name</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: ArmApplicationName "IBM Webserving Plugin"</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="ArmApplicationName__action_context"><a name="ArmApplicationName__action_context"><!-- --></a>server</span></td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: none</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="ArmApplicationName__action_origin"><a name="ArmApplicationName__action_origin"><!-- --></a>iSeries</span></td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__UsageConsiderations">Usage</a></strong>: 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 </td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: ArmApplicationName "IBM Webserving Plugin"</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p>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. </p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="hr" id="ArmInstrumentHandler"><a name="ArmInstrumentHandler"><!-- --></a><h2 class="topictitle2">ArmInstrumentHandler</h2>
|
||
|
|
<div>
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_arm4_ap20</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: ArmInstrumentHandler <em>on|off</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: ArmInstrumentHandler off</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="ArmInstrumentHandler__action_context"><a name="ArmInstrumentHandler__action_context"><!-- --></a>server</span></td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: none</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="ArmInstrumentHandler__action_origin"><a name="ArmInstrumentHandler__action_origin"><!-- --></a>iSeries</span></td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__UsageConsiderations">Usage</a></strong>: 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 </td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: ArmInstrumentHandler off</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p>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.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="hr" id="ArmLoadLibrary"><a name="ArmLoadLibrary"><!-- --></a><h2 class="topictitle2">ArmLoadLibrary</h2>
|
||
|
|
<div>
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_arm4_ap20</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: ArmLoadLibrary <em>arm4-api-service-program-name</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: ArmLoadLibrary /QSYS.LIB/QSYS2.LIB/LIBARM4.SRVPGM </td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="ArmLoadLibrary__action_context"><a name="ArmLoadLibrary__action_context"><!-- --></a>server</span></td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: none</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="ArmLoadLibrary__action_origin"><a name="ArmLoadLibrary__action_origin"><!-- --></a>iSeries</span></td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__UsageConsiderations">Usage</a></strong>: 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 </td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: ArmLoadLibrary /QSYS.LIB/QSYS2.LIB/LIBARM4.SRVPGM </td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p>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.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="hr" id="ArmTransactionName"><a name="ArmTransactionName"><!-- --></a><h2 class="topictitle2">ArmTransactionName</h2>
|
||
|
|
<div>
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_arm4_ap20</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: ArmTransactionName <em>transaction_name</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: ArmTransactionName WebRequest</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="ArmTransactionName__action_context"><a name="ArmTransactionName__action_context"><!-- --></a>server</span></td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: none</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="ArmTransactionName__action_origin"><a name="ArmTransactionName__action_origin"><!-- --></a>iSeries</span></td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__UsageConsiderations">Usage</a></strong>: 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 </td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: ArmTransactionName WebRequest </td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p>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. </p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|