Browser Agent Properties

The bundle.properties file includes the Browser Agent auto-snippet injection and response decoration properties for sending business transaction match information. Use the bundle.properties file when you installed the Browser Agent by:
apmdevops106
The bundle.properties file includes the Browser Agent auto-snippet injection and response decoration properties for sending business transaction match information. Use the bundle.properties file when you installed the Browser Agent by:
  • Downloading an agent from CA Digital Experience Insights Application Performance Management
  • Deploying the Browser Agent from APM Command Center
The Browser Agent bundle.properties file is located in the <
Agent_Home
>\extensions\<
browser-agent-ext-version
> directory.
introscope.agent.browseragent.autoInjection.<key1>.includeURLsRegex
This property specifies the (Java-based) regular expression patterns. These patterns are used to match against the request URLs for Browser Agent automatic JavaScript snippet injection. This property works with
introscope.agent.browseragent.autoInjection.<key1>.snippetLocation
and
introscope.agent.browseragent.autoInjection.appID
.
Values: Java regular expression
Default: Blank
Visibility: bundle.properties file
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.autoInjection.<key1>.snippetLocation
This property specifies the full file path for the snippet file. The snippet file name extension must be a snippet, for example:
app1.basnippet
. This property works with
introscope.agent.browseragent.autoInjection.<key1>.includeURLsRegex
and
introscope.agent.browseragent.autoInjection.appID
. In runtime, the agent does not automatically recognize an update to the content of the snippet file. However, when you update the Browser Agent
appID
property or snippet location property, the snippet content is loaded to the agent. Use a new
appID
or update the snippet file name.
Values: String
Default: Blank
Visibility: bundle.properties file
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.autoInjection.appID
This property specifies the group keys for Browser Agent automatic JavaScript snippet injection. Letters and numbers are only allowed for
appID
. Separate the
appID
with a comma. This property works with
introscope.agent.browseragent.autoInjection.<key1>.snippetLocation
and
introscope.agent.browseragent.autoInjection.<key1>.includeURLsRegex
.
Values: List
Default: Blank
Visibility: bundle.properties file
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.autoInjection.snippet.maxSearchingLength
This property checks for the end of the first
<head>
tag to insert the snippet file in the page dynamically from the Java agent. If no head tag exists in the page, the agent checks for the <body> tag (starting body tag) instead. After the agent finds the
<head>
tag or
<body>
tag, the agent stops searching. If the
<head>
tag is found, snippet code is inserted after the
<head>
tag. If the
<body>
tag is found, the agent inserts snippet code and
<head>
tag before
<body>
tag.
This property also determines the number of bytes from the start to the end of the browser page. When you set the value to larger number, then for every request the Java agent loads that number of bytes into memory to perform the search for the
<head>
 or
<body>
tag.
Values: Integer
Range: Equal to or greater than 0 bytes
Default: 32768
Note:
An increase in this value can degrade performance.
Visibility: bundle.properties file
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.autoInjection.throttleResponseLimit
Throttles the number of requests that the Browser Agent can handle within the Java agent 15-second metric interval. The throttle is placed only on the application-specific requests that the Browser Agent handles.
Values: Integer
Range: 0 - 5000
Default: 1000
Visibility: bundle.properties file
Configuration Type: This agent-specific property requires you to restart the application or application server.
introscope.agent.browseragent.autoInjectionEnabled
This property enables and disables automatic snippet injection into a web page using the Java Agent. When FALSE, the Java agent does not dynamically insert the snippet code into the response back to the browser. Manually insert the snippet code into the <head> tags of the HTML page.
Values: TRUE/FALSE
Default: FALSE
Visibility: bundle.properties file
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.checkHeadFilterPresence.enabled
Sets a flag back to the browser to send browser transaction traces where the correlation ID is set correctly. This action occurs when the Java agent is executing a transaction trace session by opening the Transaction Trace Session window.
Values: TRUE/FALSE
Default: TRUE
Visibility: bundle.properties file
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.checkTailFilterPresence.enabled
Sets a flag back to the browser to send browser transaction traces where the correlation ID is set correctly. This action occurs when the Java agent is executing a transaction trace session and using a timing threshold session.
Values: TRUE/FALSE
Default: TRUE
Visibility: bundle.properties file
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.contentencoding.enabled
Toggles content encoding support for Browser Agent automatic JavaScript snippet injection.
Values: TRUE/FALSE
Default: FALSE
Visibility: bundle.properties file
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.instrumentclass.autoskip.depth
This property specifies the skip level to instrument the class for the browser agent. This property works when the
introscope.agent.browseragent.contentencoding.enabled
property is set to
true
. For example: if
introscope.agent.browseragent.contentencoding.enabled=
true
and i
ntroscope.agent.browseragent.instrumentclass.autoskip.depth=2
, the agent skips two times to run the browser agent for instrumented class. This behavior occurs if the current instrumentation is not at a servlet level. If the current instrumentation is in the servlet level, the Browser Agent continues to run.
Values: Integer
Range: 1 - 3
Default: 1
Visibility: bundle.properties file
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.response.decoration.cookie.expirationTime
This property specifies the expiration time of the Browser Agent response cookie in the browser.
Values: A non-negative integer in seconds.
Default: 3
Visibility: bundle.properties file
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.response.decoration.includeURLsRegex
This property specifies the regular expression pattern that the Browser Agent uses to match against the request full URL. The match is used for adding the Browser Agent response cookie and header.
The full URLs (possibly encoded) consist of protocol, hostname, port number and / or query parameters.
The following format example matches all URLs with path
/my%20page.jsp
:
introscope.agent.browseragent.response.decoration.includeURLsRegex=.*/my20page.jsp
This pattern matches the exact
http://SERVER_HOSTNAME:SERVER_PORTNUMBER/myapp/mypage.html?a1=b
URL:
introscope.agent.browseragent.response.decoration.includeURLsRegex=http://SERVER_HOSTNAME:SERVER_PORTNUMBER/myapp/mypage.html\\?a1=b
Values: Regular expression
Default: BLANK
Visibility: bundle.properties file
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.response.decoration.apmData.enabled
This property enables and disables the Java agent ability to send encrypted agent information to the Browser Agent. 
When the following information is available in the Java Agent, this property encrypts and sends the information in the response cookie and response header:
  • Agent name
  • Host name
  • Process name
  • Application name
  • Servlet name
  • UserId
The Java agent adds the encrypted information to the response cookie only when 
both
 introscope.agent.browseragent.response.decoration.apmData.enabled and introscope.agent.browseragent.response.decoration.enabled are set to true.
Values: TRUE/FALSE
Default: TRUE
Visibility: bundle.properties file
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.response.decoration.enabled
This property enables the Browser Agent response cookie. The cookie is used for business transaction matching support and end-to-end transaction trace correlation.
Values: TRUE/FALSE
Default: FALSE 
Visibility: bundle.properties file
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.sustainabilityMetrics.enabled
This property enables the creation of the Browser Agent sustainability metrics.
Values: TRUE/FALSE
Default: TRUE
Visibility: bundle.properties file
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.decorator.userid.cookie.name
This property specifies the cookie name from the transaction request. The Java agent uses the cookie name as the user ID in transaction traces and the Browser Agent response cookie.
When you set a cookie name for
introscope.agent.decorator.userid.cookie.name
, and a cookie with that name has a value, the value displays in both the Java agent and Browser Agent transaction traces.
For example:
introscope.agent.decorator.userid.cookie.name=TestAppUserID.
The cookie that is named
TestAppUserID
has a value of
123
presented in a web page. The agent collects a transaction trace and an End User takes an action on the web page. Both the Java agent and Browser Agent Trace View transaction traces display
123
as the User ID.
Values: String
Default: BLANK
Visibility: bundle.properties file
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.response.decoration.cookie.contenttype
This property specifies the content types that are used to match against the response content type for adding the Browser Agent response cookie decoration.
Specify a single entry, or a comma-delimited list of entries.
Format example:
introscope.agent.browseragent.response.decoration.cookie.contenttype=text/html,xhtml
Here, the example matches all responses with content-type
text/html
or
xhtml
.
Values: String
Default: text/html
Visibility: bundle.properties file
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.corguid.enabled
This property specifies whether the Java agent should always send the correlation ID to the browser. If the property is enabled, the correlation ID is always sent to the browser in the response.
Values: TRUE/FALSE
Default: TRUE
Visibility: bundle.properties file
Configuration Type: This agent-specific property does not require you to restart the application or application server.