Page History

...

To configure the Precise for Web Collectors, you can perform one of the following tasks:1.    Add

1. Add and change parameters to the Precise registry file.

...

1. Add parameters to the Web server’s configuration mechanism.

...

1. Add and change parameters to the dynamic instrumentation agent via the instrument.xml file.

Configuring registry settings

This section describes the registry settings configuration process.
Registry structure and inheritance
Some configurations are relevant per instance (e.g. collect-post-parameters) and some are relevant for the Web Collector in general (e.g. preferred-data-port). Others are relevant for the whole product (e.g. user-agents). Instance configuration resides in the instance registry file:
products\i3fp\registry\instances\www\<server-name>\<instance_name>\settings.xml
NOTE    You can set instance configuration in the products\i3fp\registry\instances\www\<server-name>\settings.xml file if you want to set the same setting for all instances on the machine. Consider however that settings in the instance registry will override the settings in the server registry.
Web Collector configuration resides in the registry file:
products\i3fp\registry\instances\www\<server-name>\settings.xml
NOTE    You can set the configuration for all Web Collectors at once by modifying the file products\i3fp\registry\products\indepth-web\focal-point.xml Consider however that settings in the server registry will override the settings in the focal-point.xml file.
Product level configuration resides in the registry file: products\i3fp\registry\products\indepth-web\focal-point.xml Web Collector behavior is set via the registry entry <web-collector>
Cluster configuration resides in the registry file:
products\i3fp\registry\clusters\www\<cluster-name>\settings.xml
Instance registry
Configuring the instance registry only affects the specific instance. Every element in the instance registry can also be specified in the server registry file, in which case it affects all the instances on that server.
How to change instance registry
1.    On the relevant Precise node (proxy), manually change the products\i3fp\registry\instances\www\<server-name>\<instance_name>\settings.xml file.
2.    Save the file.
3.    Run the update-main-registry CLI command on the same Precise node.
UNIX. /infra/bin/psin_cli.sh -action update-main-registry -i3-user admin -i3-clear-password admin -registry-path /registry/clusters/www/<server_name>/<instance_name>
Windows. infra\bin\psin_cli.bat -action update-main-registry -i3-user admin -i3-clear-password admin -registry-path /registry/clusters/www/<server_name>/<instance_name>
This will force a registry sync from the node's FocalPoint to the main FocalPoint.
Cluster registry
Configuring the cluster registry affects all instances of the specific cluster.
NOTE    All instances in the cluster need to be restarted via AdminPoint after changing the cluster registry.
How to change the cluster registry:
1.    On the relevant Precise node (proxy), manually change the products\i3fp\registry\clusters\www\<cluster-name>\settings.xml file.
2.    Save the file.
3.    Run the update-main-registry CLI command on the same Precise node.
UNIX. ./infra/bin/psin_cli.sh -action update-main-registry -i3-user admin -i3-clear-password admin -registry-path /registry/clusters/www/<cluster_name>
Windows. infra\bin\psin_cli.bat -action update-main-registry -i3-user admin -i3-clear-password admin -registry-path /registry/clusters/www/<cluster_name>
This will force a registry sync from the node's FocalPoint to the main FocalPoint.
NOTE    Cluster registry changes override the FocalPoint registry changes.
connection-params (in general section)
The following table describes the registry elements for the connection-params (in the general section).
Table 9-1    connection-params (in general section)
Registry element    Description
site-name    Specifies the name of the Web application (context root). Only relevant for J2EE Web servers and only when the filter is not installed on the root Web application.
filter-connect-ext-cmd-line    Additional miscellaneous command line parameters for the psi_web_filter_connect utility which is used to send management URLs to the filter.
authorized-ips    Comma separated IPs list that specifies the IPs from which the Precise for Web agent management pages can be browsed. Other IPs that will try to access this status will be blocked. (127.0.0.1 is added by default).
ssl (in connection-params, in general section)
The ssl element in the registry is a "container" element that contains the use-client-certificate, cipher-list, and log-file elements. It also contains another "container" element: client-certificate. This "container" element contains the path, password, and key-path elements.
The following table describes the registry elements that can be used for the ssl instance registry.
Table 9-2    ssl elements
Registry element    Child element    Description
use-client-certificate        Specifies the use of a client certificate when Precise for Web tries to connect using
Secure Socket Layer (SSL). Default value: false.
cipher-list        Specifies additional ciphers that OpenSSL uses on top of the default ciphers for SSL
version 2 and 3 and Transport Layer Security (TSL) version 1. For more information, see the following URL: http://www.openssl.org/docs/apps/ciphers.html#cipher_suite_names.
log-file        Specifies the file that OpenSSL logging is written to.
client-certificate        Specifies client certificate details, if the monitored Web server requires it. Container for path, password, and key-path elements.
    path    Specifies the full path of the client certificate.
    password    Specifies the password to be used to decrypt the certificate file. The password itself should be encrypted using the Encrypt command that is part of the Precise CLI Utility.
For more information, see the Precise CLI Utility Reference Guide.
    key-path    Specifies the path to the private key if it is different than the path to the certificate.
user-authentication (in connection-params, in general section)
The following table describes the registry elements for the user-authentication (in connection-params, in general section).
Table 9-3    user-authentication (in connection-params, in general section)
Registry element    Description
user    Specifies the user name for authentication.
password    Specifies the user password for authentication. The password itself should be encrypted using the Encrypt command that is part of the Precise CLI Utility.
For more information, see the Precise CLI Utility Reference Guide.
domain    Specifies the domain name for authentication.
method    The authentication method.
One of the following methods should be used:
basic digest ntlm
Server-side
The following table describes the registry elements for the server-side .
Table 9-4    Registry elements for server-side
Registry element    Description
ext-list    Specifies the extensions used, such as .html, .jsp, and .asp. For example:
<ext-list>html,jsp,asp</ext-list>
Default values: html, swe, asp, aspx, htm, jsp, php, gbl, cfm, pl, php3, do, IScript_PT_NAV_PAGELET, I_Script_AppHP, IScript_UniHeader_Frame, IScript_PT_NAV_INFRAME, iscript_apphp, iscript_timeoutwarning
ext-list-separator    Specifies the separator of the extension list. Default value: , (a comma)
stat-extension    Specifies the URL of the statistics module. Add this registry element only if you know that the statistics URL differs from the default URL for the specific Web server type.
Default values:
Apache: server-status?auto iPlanet: .perf
WebLogic: weblogicstat
WebSphere: websphere_stats
filter-trace    Specifies whether filter logging is used. Default value: false
filter-session-cookie    Specifies the name of the session cookie used by the application. Define this value to improve client-side correlation in the following Web servers: WebLogic, WebSphere, Tomcat, Oracle AS, Sun One, IIS, Apache 2.x.
Default value: JSESSIONID
max-i4w-cookie-size    Specifies the maximum size of a Precise for Web cookie (in bytes). Default value: 2048
filter-ignore-files    A comma-separated list of files that the filter has to ignore. If a file contains any of these patterns, it is ignored. Only relevant for J2EE filters.
filter-use-encoding    Specifies the translation of URLs and URL parameters to unicode format. Set this parameter if
URLs or parameters may contain non-ASCII characters. Default value: false
filter-encoding-name    Specifies the name of the URL encoding mechanism. Set this parameter if the server handles
URLs that use neither UTF-8 nor local encoding, which are the default encoding types.
web-parameter-delimiters    A list of URL parameters delimiters. These delimiters are used to separate the parameters of a
URL from the URL itself. For example, the URL: “index.html?param1=abc” has 1 parameter
‘param1’. The parameters delimiter in this URL is ‘?’. Use this element if your application uses
non-standard delimiters (like ‘;’). To specify more than one delimiter, concatenate all delimiters into one string, for example: <parameter-delimiters>?;.</parameter-delimiters> sets 3 delimiters: ‘?’, ‘;’
& ‘.’ If more than 1 delimiter is used, the first one that is encountered in the URL is used. Default value: ? (question mark)
collect-post-parameters    If this registry element is set to true, the filter collects parameters that are passed in the request body (as opposed to parameters that are passed with the URL). For enabling the post-parameters collection on an IIS Web server, another action is needed (besides changing this flag) - For more information, see the Adding post-parameters collection for IIS6 and Adding post-parameters collection for IIS7 sections in the Installing Web Tier Collectors section of the Precise Installation Guide.
Default value: false (for Siebel this is set to “true” (automatically))
Note: This feature is not supported for Apache 1.3
Note: Only Form post-parameters are supported. This means:
Only submitted page forms of which the POST request contains the header Content-Type: application/x-www-form-urlencoded are supported. The post-parameters are passed as: key1=value1&key2=value2&...
Any other type of post-parameters are not monitored. For example - if the POST data is XML.
Note: In any case no more than 1500 characters of POST data will be collected.
apache-pid-file-path    Sets the path for apache .pid file (commonly: httpd.pid). Should be set only when the .pid file path is not specified in the configuration file or in any other case, when the statistics agent fails to resolve it.
user-defined-transaction-name
By configuring the elements user-defined-transaction-name, you can change the collection method of the transactions. This is valid for Precise for Web and Precise TPM. The collection method can be represented by one of the following tags:
Table 9-5    Elements
Elements    Description
cookie-name    Collects the value of the specified cookie.
req-header-name    Collects the value of the specified request header.
parameter-name    Collects the value of the specified GET parameter (not relevant for POST parameters).
dom-element    Collects the value of the specified dom element. Applicable only if the client.-side agent is installed.
display-mode    The way the transaction name is displayed in Precise for Web and Precise TPM.

...