Browser Agent Properties for .NET/.NET Core

The IntroscopeAgent.profile file includes the Browser Agent auto-snippet injection and response decoration cookie properties. These properties send business transaction match information.
cecpub
The IntroscopeAgent.profile file includes the Browser Agent auto-snippet injection and response decoration cookie properties. These properties send business transaction match information.
Use the IntroscopeAgent.profile file when you install the Browser Agent by:
  • Downloading the Introscope agent installation package from the CA APM software download area on Broadcom Support.
  • Installing the Digital Experience Collector and selecting the option to configure the Digital Experience Collector and CA APM.
To configure Browser Agent properties for .NET/.NET Core, update this section  of the IntroscopeAgent.profile file located in the <
.NET
_
Agent_Home
>/core/config directory:
##############################################
# Browser Agent Business Transaction Monitoring properties
##############################################
The Browser Agent properties that are described in the .NET IntroscopeAgent.profile are the only supported properties. No other properties from Java agent profile are supported.
2
2
introscope.agent.browseragent.autoInjectionEnabled
This property enables and disables automatic snippet injection into a web page using the .NET/.NET Core Agent. When FALSE, the .NET/.NET Core 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
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.snippetLocation
This property specifies the locationof the JavaScript snippet file on the the location of the snippet in the agent folder.
Values: String
Default: brtmsnippet.js
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.snippetString
This property specifies the value of the JavaScript snippet. This value takes precedence over the introscope.agent.browseragent.snippetLocation value when both properties are set.
Values: StringDefault: An empty string
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 .NET agent adds the correlation ID (CorBrowsGUID) to the browser agent response cookie and header. When the property is set to true, the correlation ID is always sent to the browser in the browser agent response.cookie and header. This property is related to the introscope.agent.browseragent.response.decoration.enabled property
Values: TRUE/FALSE
Default: FALSE
Visibility: This property is not included in the IntroscopeAgent.profile file; add it manually to change the setting.
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.dxchost
This property specifies the Digital Experience Collector host. The value is used to replace text in the JavaScript snippet file.
You do not need to set this property when you have configured an App Experience Analytics snippet.
Values: host
Default: BLANK
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.dxcport
This property specifies the Digital Experience Collector port. The value is used to replace text in the JavaScript snippet file.
You do not need to set this property when you have configured an App Experience Analytics snippet.
Values: port
Default: 80
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.ssl.enable
This property specifies the Digital Experience Collector protocol (http or https) for downloading the JavaScript file and sending performance data to the CA Experience Collector.
Values: TRUE/FALSE
Default: FALSE
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 controls the response decoration and insertion of cookies and headers. When response decoration is enabled, the Browser agent transaction trace is correlated with the server transaction trace that the Browser agent generates only if the trace session is on. This propertyis related to the introscope.agent.browseragent.corguid.enabled property
The last part of the URL is used as a key for the placeholder <page url> in the cookie named x-apm-brtm-response-bt-page-<page url>. The name of the header is x-apm-ba-response-bt.
Values: true/false Default: false
Configuration Type: This agent-specific property does not require you to restart the application or application server.
This property specifies the expiration time of the Browser Agent response cookie in the browser.
Values: A non-negative integer in seconds.
Default: 3
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.response.decoration.cookie.enabled
This property controls the insertion of APM browser agent cookies in the response.
Values: true/false Default: true
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.response.decoration.apmData.enabled
The property encrypts Host name, Process name, Agent name and sends this information in the response cookie and header.
Values: true/false
Default: true
Visibility: This property is not included in the IntroscopeAgent.profile file; add it manually to change the setting.
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 set of keys the Browser Agent uses to specify regular expressions for matching URLs.
The URLs that match the regular expressions are injected with the JavaScript snippet.
This property works with
introscope.agent.browseragent.autoInjection.<key1>.includeURLsRegex
.
Values: Letter and numbers. Separate values with a comma.
Default: key1
Configuration Type: This agent-specific property does not require you to restart the application or application server.
introscope.agent.browseragent.autoInjection.<key1>.includeURLsRegex
This property specifies the (.NET-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.appID
.
Values: .NET regular expression
Default: Blank
Configuration Type: This agent-specific property does not require you to restart the application or application server.
Example: All regular expressions are matched.
introscope.agent.browseragent.autoInjection.appID=key1
introscope.agent.browseragent.autoInjection.key1.includeURLsRegex=.*
introscope.agent.decorator.userid.cookie.name
This property specifies the cookie name from the transaction request. The .NET/.NET Core 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 .NET/.NET Core 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 .NET/.NET Core Agent and Browser Agent Trace View transaction traces display
123
as the User ID.
Values: String
Default: BLANK
Configuration Type: This agent-specific property does not require you to restart the application or application server.