Page History
...
The following table describes the registry elements for the connection-params (in the general section).
Table 9- 1 connection-params (in general section)
...
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. |
...
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)
...
The following table describes the registry elements for the server-side .
Table 9- 4 Registry elements for server-side
...
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. |
...
Configuring the server registry affects the Web collector and the instances on the server.
server-side
Table 9- 6 client-side section
Registry elements | Description |
---|---|
use-tomcat-client-collector-as-proxy | If set to true, the instance will sent client-side data to the client collector. Default: true for Apache 1.3 and iPlanet false for the rest. |
Table 9- 7 verify section (inside web-collector)
Registry elements | Description |
---|---|
max-user-agent-length | Maximum allowed user agent (browser type) length. Records exceeding this value will be ignored (not loaded). Units: bytes Default: 256 |
max-user-defined-length | Maximum allowed user defined 1 & 2 length. Records exceeding this value will be ignored (not loaded). Units: bytes Default: 256 |
Table 9- 8 server-side section (inside verify, inside web-collector)
Registry elements | Description |
---|---|
max-server-period | Maximum allowed server period (not including network period). Records exceeding this value will be ignored (not loaded). Units: milliseconds Default: 3600000 (1 hour) |
max-future-time | Maximum allowed difference between current time and future record time. Records that have a later time the allowed will be ignored (not loaded). Units: milliseconds Default: 86400000 (1 day) |
empty-http-status-allowed | If true, records with no HTTP status are not ignored. Default: true |
fallback-http-status | If a record does not contain HTTP status and empty-http-status-allowed is set to true, sets the value to use for the HTTP status of that record. Default: 0 |
min-http-status, max-http-status | If fallback-http-status is not set (or set to 0) HTTP statuses outside this range cause the record to be ignored (not loaded). Default: 0, 599 |
empty-protocol-allowed | If true, records with no HTTP protocol are not ignored. Default: true |
max-protocol-length | If the length of the HTTP protocol of a record exceeds this value, the record will be ignored (not loaded). Units: bytes Default: 5 |
allowed-protocols | If this is set, only HTTP protocols in this list are allowed, other values will cause the record to be ignored (not loaded). Default: none |
empty-http-method-allowed | If true, records with no HTTP method are not ignored. Default: true |
fallback-http-method | If a record does not contain HTTP method and empty-http-method-allowed is set to true, sets the value to use for the HTTP method of that record. Default: GET |
allowed-http-methods | If this is set, only HTTP methods in this list are allowed, other values will cause the record to be ignored (not loaded). Default: none |
Table 9-9 client-side section (inside verify, inside web-collector)
...
The entries below are similar for 4 sections (with one exception*):
Table 9- 10 summed section (inside server-side, inside output, inside web-collector) raw section (inside server-side, inside output, inside web-collector), summed section (inside client-side, inside output, inside web-collector), raw section (inside client -side, inside output, inside web-collector)
Registry elements | Description |
---|---|
max-files | Maximum files allowed in the output directory. After exceeding this value, no more files will not be written. Default: 1440 |
max-recs-in-file | Maximum records allowed in 1 output file. After exceeding this value, a new file will be created. Default: 10000 |
max-time-to-write-file | Maximum time to have 1 file open. Units: milliseconds * Default for summed: 900000 (15 minutes) *Default for raw: 60000 (1 minute) |
max-file-size | Set the maximum for file size. Units: bytes Default: 10485760 (10MB) |
Table 9- 11 server-side section (inside tac, inside smartlink, inside web-collector), client-side section (inside tac, inside smartlink, inside web-collector)
Registry elements | Description |
---|---|
max-files | Maximum files allowed in the output directory. After exceeding this value, no more files will not be written. Default: 1440 |
max-recs-in-file | Maximum records allowed in 1 output file. After exceeding this value, a new file will be created. Default: 10000 |
max-file-size | Set the maximum for file size. Units: bytes Default: 10485760 (10MB) |
Table 9- 12 server-side section (inside input, inside web-collector), client-side section (inside input, inside web-collector)
Registry elements | Description |
---|---|
delete-files | When set to true, input raw files are deleted after being processed. Default: true |
max-error-files | Maximum number of error files to move to the errors directory when errors occur on files. Default: 10 |
Table 9- 13 statistics section (inside ivp, inside web-collector)
Registry elements | Description |
---|---|
enabled | When set to false, validation of the statistics component of the web collector are not performed in the verify action (in AdminPoint). Default: true |
Table 9- 14 processing section (inside ivp, inside web-collector)
Registry elements | Description |
---|---|
Enabled | When set to false, validation of the core web collector are not performed in the verify action (in AdminPoint). Default: true |
server-amount-limit-for-no-client | When client/server correlation is enabled, the web collector warns - in the verify action (in AdminPoint) – that server records were received but no client records did. This number sets the threshold for this warning. Default: 1000 |
client-amount-limit-for-no-server | When client/server correlation is enabled, the web collector warns - in the verify action (in AdminPoint) – that client records were received but no server records did. This number sets the threshold for this warning. Default: 500 |
server-amount-limit-for-no-network | When server/network correlation is enabled, the web collector warns - in the verify action (in AdminPoint) – that server records were received but no network records did. This number sets the threshold for this warning. Default: 1000 |
network-amount-limit-for-no-server | When server/network correlation is enabled, the web collector warns - in the verify action (in AdminPoint) – that network records were received but no server records did. This number sets the threshold for this warning. Default: 1000 |
Table 9- 15 web-collector section
Registry elements | Description |
---|---|
preferred-data-port | Will be used by the web collector for communication with server and network agents. If this port is busy, any available port will be used. Default: 20999 |
Table 9- 16 summary section (inside web-collector)
Registry elements | Description |
---|---|
enabled | When set to false, summary processing is not performed by the web collector. This setting is meaningful only on the monitored server (and not on the FP machine where it is ignored). Setting this to false (along with client-server-correlation) sets the work mode to Basic Mode. Default: true |
Table 9- 17 server-side section
Registry elements | Description |
---|---|
Enabled | When set to false, server-side collection is disabled. Default: true |
client-server-correlation | When set to false, client/server correlation is disabled and in fact the instance will work in Basic Mode (this does not have meaning on the FP machine). Default: true |
server-network-correlation | When set to false, server/network correlation is disabled (this does not have meaning on the FP machine). Default: true |
filter-do-collector-settings | When set to false, collector settings activity (handling of URL parameters) is done in the web collector instead of in the web filter. Default: true (processing done on filter) |
filter-do-data-patterns | When set to false, data patterns processing is done in the web collector instead of in the web filter. Default: true (processing done on filter) |
filter-do-locations | When set to false, data locations processing is done in the web collector, instead of the web filter. Default: true (processing done on filter) |
Table 9- 18 client-side section
Registry elements | Description |
---|---|
enabled | When set to false client-side collection is disabled Default: true |
Table 9- 19 statistics section
Registry elements | Description |
---|---|
enabled | When set to false statistics collection is disabled Default: true |
max-files (in output section) | Maximum files allowed in the output directory. After exceeding this value, no more files will not be written. Default: 2000 |
Table 9- 20 processing section (inside web-collector)
Registry elements | Description |
---|---|
max-data-processor-threads | Maximum number of threads that will be invoked by the web collector to handle data. Default: 50 |
write-dp-period-ms | The initial wait time of the serialization timer that serializes the current data to files. Units: milliseconds Default: 120000 |
write-dp-delay-ms | The cycle time of the serialization timer that serializes the current data to files. Units: milliseconds Default: 120000 |
Table 9- 21 server-side section (inside processing, inside web-collector)
Registry elements | Description |
---|---|
input-queue-max-size | Set the maximum number of records in the input queue. After the queue reaches this size, we start dropping records. May be used to temporarily ease memory consumption. Default: 15000 |
aging-period | Max time for server records to wait in memory for correlation (with both client & network records). Units: milliseconds Default: 90000 (1.5 minutes) |
aging-period-when-using-client-collector | Max time for server records to wait in memory for correlation (with both client & network records) when this instance uses the client collector. Units: milliseconds Default: 30000 (30 seconds) |
Table 9- 22 client-side section (inside processing, inside web-collector)
Registry elements | Description |
---|---|
input-queue-max-size | Set the maximum number of records in the input queue. After the queue reaches this size, we start dropping records. May be used to temporarily ease memory consumption. Default: 10000 |
aging-period | Max time for client records to wait in memory for correlation (with server records). Units: milliseconds Default: 90000 (1.5 minutes) |
aging-period-when-using-client-collector | Max time for client records to wait in memory for correlation (with server records) when this instance uses the client collector. Units: milliseconds Default: 180000 (3 minutes) |
max-text-period-before-fix | Max time in milliseconds for client records first byte time. If the first byte time exceeds the maximum, it will be fixed by taking the server + network time. Default: 900000 milliseconds |
Table 9- 23 network section (inside processing, inside web-collector)
Registry elements | Description |
---|---|
input-queue-max-size | Set the maximum number of records in the input queue. After the queue reaches this size, we start dropping records. May be used to temporarily ease memory consumption. Default: 15000 |
aging-period | Max time for network records to wait in memory for correlation (with server records). Units: milliseconds Default: 90000 (1.5 minutes) |
Table 9- 24 server-side section (inside filtering, inside web-collector)
Registry elements | Description |
---|---|
enabled | When set to false, server-side filtering is disabled Default: true |
reset-identifiers | A list of identifiers that will be reset in the filtering-summary process (when needed). The identifiers will be reset, one by one, in the order they appear here until the top N limit is reached. Valid values:
Default: httpMethod, userAgent, protocol |
Table 9- 25 client-side section (inside filtering, inside web-collector)
...
The following table describes the registry elements for the user-agent in the FocalPoint registry.
Table 9- 26 Registry elements
Registry elements | Description |
---|---|
user-agent | A user agent definition that Precise for Web uses to find and describe user agents. |
user-agent.id | A string identifier for the user agent. This identifier is not the display name. |
user-agent.display-string | The display string that is shown in the user interface for this user agent. You can use the version token which is replaced with the detected user agent version. |
...
The following table lists all parameters that you can add to the Web filters. This mechanism should only be used for the instance name and <i3_root>
. Any other parameter should only be added after consultation with the Precise Enterprise Support Team.
Table 9- 27 Addable Web filter parameters
...
The following table gives a comparison of the parameter and its equivalent registry element.
Table 9- 28 Parameter and Registry element
...
The following table describes the available methods.
Table 9- 29 methods
Method | Description |
---|---|
prefix | Take only the defined prefix. For example: <pattern1>abraham</pattern1> - For URL 'abraham123.html' you will see 'abraham%'. |
suffix | Take only the defined suffix. For example: <pattern1>html</pattern1> - For URL 'abraham123.html' you will see '%html'. |
prefix-by-key | Take text up to the defined key (not including that key). For example: <pattern1>;jsessionid</pattern1> - For URL 'abraham123.html;jsessionid' you will see 'abraham123.html%' (if showReplaceChar="false", you will get 'abraham123.html'). |
regex | Use the given regular expression to change the given URL. For example: <pattern1 replace="$1">service(.*)</pattern1> - For URL 'service123' you will get '123' (for more on regular expressions, consult your support representative). |
...
The following table contains the tags that can be encountered in the Instrument.xml file. "not applicable" means that the tag has no influence on that specifically chosen instance type.
Table 9- 30 Instrument.xml tags
Tag | Description | ||
---|---|---|---|
dynamic-inst | The first tag of the dynamic instrumentation configuration file. J2EE: mandatory ISAPI: mandatory | ||
enable | Enables or disables the instrumentation filter globally. J2EE: optional ISAPI: optional Values: true, false Default value: true | ||
handle-js* | Enables or disables the JavaScript handling by the filter. J2EE: optional ISAPI: optional Values: true, false Default value: true | ||
strict-servlet-api (J2EE) | Forces compatibility with the J2EE servlets specifications. J2EE: optional ISAPI: not applicable Values: true, false Default value: true | ||
js-mime-type | Uses js-mime-type protocol. J2EE: optional ISAPI: optional Values: if possible to use dynamically obtained, otherwise use application/x-javascript Default value: if possible use dynamically obtained, otherwise use application/x-javascript | ||
instance-id* | The filter init process fills this tag:
Default value: empty | ||
prolog-string* | An extra string that is injected during instrumentation (in addition to the regular callout to JavaScript). Usually it is used to add the <!Doctype element (because according to some browsers this tag should come at the beginning of the Web page). J2EE: optional ISAPI: optional | ||
no-recompress | For compressed content. If set to true, insert the instrumentation script without recompression. Apache: applicable for version 2.0 and higher Values: true, false Default value: true | ||
accumulate-on-parsing | If parsing is on, accumulate response buffers till the <html> or <head> tag is found (see also the note after this table). J2EE: optional ISAPI: optional Apache: applicable for version 2.0 and higher Values: true, false Default value: true | ||
max-parsing-bytes | Looks for the <html> tag or the <head> tag only in the first n bytes specified. J2EE: optional ISAPI: optional Apache: applicable for version 2.0 and higher Values: number of bytes, -1 for full parsing Default value: 2048 | ||
private-log | Controls the writing of messages that need to be logged before the user-agent is obtained, to the private log. J2EE: optional ISAPI: optional Values: true, false Default value: false | ||
i3-log | Enables the i3 log globally. J2EE: not applicable ISAPI: not applicable Values: true, false Default value: false | ||
webgarden* | Introduces the Webgarden management section. | ||
enable | Enables or disables “Webgarden” support. Values: true, false Default value: true for IIS and SAP WAS Web servers, false on any other Web server | ||
sampling-interval | Setting the sampling interval (in milliseconds) in which each process in the “Webgarden” updates its status. Value: any number higher than 500 Default value: 2000 | ||
user-agents | Introduces the user-agents section. J2EE: mandatory ISAPI: mandatory | ||
user-agent | Describes the configuration per user-agent. J2EE: mandatory, only for user-agent with name "Default" ISAPI: mandatory, only for user-agent with name "Default" | ||
accumulation | Controls whether to perform accumulation of chunks/parts of the Web content and then preforming instrumentation all together. The default is not to use it and perform instrumentation on-the-fly (and perform accumulation only if necessary). There is an option to force accumulation (true) or to disable instrumentation when accumulation must be done (false). J2EE: mandatory ISAPI: mandatory Values: default, true, false Default value: default | ||
parsing | Controls whether to perform light-parsing to inject the first script after <html> or <head> (what is recognized first). "false" means to inject the script at the beginning of the page, without parsing. J2EE: mandatory ISAPI: mandatory Values: true, false Default value: true | ||
enable | Enables or disables the instrumentation filter per user-agent. J2EE: mandatory ISAPI: mandatory Values: true, false Default value: false | ||
second-script | Controls whether to inject a second-script at the end of the page.
J2EE: mandatory ISAPI: mandatory Values: true, false Default value: false | ||
i3-log | Enables or disables the i3 log per user-agent. J2EE: mandatory ISAPI: mandatory Values: true, false Default value: false | ||
private-log | Enables or disables the private log. J2EE: mandatory ISAPI: mandatory Values: true, false Default value: false | ||
user-agent name | Relates to the browser user-agent that includes this value. The order in the list is important. J2EE: mandatory ISAPI: mandatory Values: Default (mandatory) or free text (such as MSIE or FireFox) that is part of the user-agent string.
Default value: For more information, see the following URL: http://www.zytrax.com/tech/web/browser_ids.htm | ||
include-ip | Introduces the section in which you define the IP addresses that should be included in the dynamic instrumentation process. By default all IPs are included. J2EE: optional ISAPI: optional | ||
range from | Beginning of the IP address range. J2EE: optional ISAPI: optional Value: IP address | ||
range to | End of the IP address range. J2EE: optional ISAPI: optional Value: IP address | ||
url-exclude | Introduces the section in which you define the URLs that should be excluded. By default all URLs are included. J2EE: optional ISAPI: optional | ||
url-include* | Introduces the section in which you define the URLs that should be included. By default all URLs are included. J2EE: optional ISAPI: optional | ||
Prefix | Defines the URL prefix. | ||
suffix* | Defines the URL suffix. | ||
include-char-encoding | Introduces the section for additional character encoding that is supported in the filter (in addition to the built-in character support). J2EE: optional ISAPI: optional | ||
char-enc | Defines additional character encoding that is supported in the filter (in addition to the built-in character support). Use if your pages are written in none Unicode character encoding. J2EE: optional ISAPI: optional | ||
req-header-exclude | Introduces the section that defines the HTTP request headers for which HTTP requests is excluded. J2EE: optional ISAPI: optional | ||
header name | Defines the HTTP header name. | ||
header value | Defines the specific HTTP header value or "*". |
...
- If the filter recognizes a "content-type" that does not contain "text/html", the instrumentation process is skipped for that particular HTTP response.
...