Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table 9-30 Instrument.xml tagsTag    Description

TagDescription

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:

  • If the tag exists and is empty, it is filled with the right instance-id.
  • If the tag exists with a value, the value is not changed.
  • If the tag does not exist, it is not created.
  • If the filter is able to read the value of the tag, it inserts it to a cookie on the response.
Info

...

The tag should only have an empty value on load balanced environments with no server side installed.

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.

...

Info

This option is reserved for future use.

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.

...

Info

Default should always be the last user in the list and the values are case-sensitive.

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

...

PrefixDefines 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

...

valueDefines the specific HTTP header value or "*".

The tags that are marked with an asterisk (*) appear in the Frequently Asked Questions document.NOTE    The

Info

The terms “accumulation”, “parsing (without accumulation)”, and “accumulate on parsing” can be described as follows:

  • Accumulation

...

  • . Keep all response buffers till you have all the document and if parsing is on, only then parse the document and instrument if the <html> or <head> tag is found.
  • Parsing (without accumulation)

...

  • . On the fly check each response buffer and find the <html> or <head> tag. Once found - instrument.
  • Accumulate on parsing

...

  • . Keep response buffers only until the on the fly parsing finds the <html> or <head> tag or till the max-parsing-bytes is reached, and then release the buffers with the right content-length.

About include and exclude tags

The following list describes the order in which the include and exclude tags are handled in the instrument.xml file:

...