Skip to content
CA Application Performance Management - 10.0
Documentation powered by DocOps

Java Agent Properties

Last update September 20, 2018

The agent refers to properties in the IntroscopeAgent.profile for its basic connection and naming properties. When you install an agent, the agent profile is installed in the <Agent_Home>/core/config directory.

Configuring the IntroscopeAgent.profile location

The agent refers to properties in the IntroscopeAgent.profile for its basic connection and naming properties. When you install an agent, the agent profile is installed in the <Agent_Home>/core/config directory.

Introscope looks for the agent profile in these locations, in this sequence:

  • location defined in the system property com.wily.introscope.agentProfile
  • location defined in com.wily.introscope.agentResource
  • <working directory>/core/config directory
Note: When adding a path on a Windows computer, escape the backslash (\) with another backslash as follows: C:\\Introscope\\lib\\Agent.jar.

You can change the location of the IntroscopeAgent.profile.

Follow these steps:

  1. Define the new location using one of these methods:
    • define a system property on the Java command line with the -D option to specify the full path to the location of the IntroscopeAgent.profile file:

      -Dcom.wily.introscope.agentProfile.

    • Make the IntroscopeAgent.profile available in a resource on the classpath. Set com.wily.introscope.agentResource to specify the path to the resource containing the agent profile.

      Note: If you change the location of the IntroscopeAgent.profile, the AutoProbe log location will also have to be changed. For more information, see Managing ProbeBuilder Logs.
  2. Move your ProbeBuilder directives (PBD and PBL files) to the same location as the agent profile -- they are referenced relative to the profile location.

Command-line property overrides

In Introscope, you can override specific properties of the Enterprise Manager, agents, Workstation, and WebView using the command line. With regard to the Java agent, this is useful when you have a clustered environment with multiple copies of an agent being shared and you want to tailor some of the agent settings for each application being monitored.

These steps assume you have installed and configured an agent on the application server to be monitored, and that the agent successfully connects to the Enterprise Manager.

To override agent properties using the command line

  1. Open the file where you modified the Java command to start the agent.
    The location of this file varies depending on the application server you use in your environment.
  2. Add a -D command to override a property. For example, you can add the following command to make the agent also use the weblogic-full.pbl file:

    -Dintroscope.autoprobe.directivesFile=weblogic-full.pbl

    Place this command next to other -D commands in the open file.

    Note: When you use this command to override hot deployable properties, the property is no longer hot deployable. Also, if you modify the property at a later time in the configuration file, you will receive a warning message in the Workstation stating you modified an overridden property and your change will have no effect. To avoid this, remove the override command before modifying the property in a configuration file.
  3. Save the file.
  4. Restart the agent.
    In the example used above, you would now see the additional WebLogic metrics in the agent node in the Workstation.

    Important! System properties become part of the property space of Introscope properties, allowing things like java.io.tmpdir to be visible to anything using IndexedProperties.

Agent Failover Properties

If the Java agent loses connection with its primary Enterprise Manager, the Agent failover properties specify which Enterprise Manager the agent will failover to, and how often it will try to reconnect to its primary Enterprise Manager.

introscope.agent.enterprisemanager.connectionorder

Specifies the connection order of backup Enterprise Managers the agent uses if it is disconnected from its default Enterprise Manager.

Property settings

Names of other Enterprise Managers the agent can connect to.

Default

The Enterprise Manager defined by the DEFAULT host name, port number, and socket factory properties.

Example

introscope.agent.enterprisemanager.connectionorder=DEFAULT

Notes

  • Use a comma separated list.
  • You must restart the managed application before changes to this property take effect.

introscope.agent.enterprisemanager.failbackRetryIntervalInSeconds

Specifies the number of seconds between attempts by a denied agent to reconnect to these Enterprise Managers:

  • Enterprise Managers based on order configured in the agent profile introscope.agent.enterprisemanager.connectionorder property value.
  • Any Enterprise Manager allowed based on loadbalancing.xml configuration.

If an agent cannot connect to an Enterprise Manager, it handles connections in these ways:

  • Tries to connect to the next allowed Enterprise Manager.
  • Does not connect to any Enterprise Manager on which it is disallowed.

Note: For information about configuring loadbalancing.xml and agent to Enterprise Manager connections, see the CA APM Configuration and Administration Guide.

Default

The default interval is 120 seconds.

Example

introscope.agent.enterprisemanager.failbackRetryIntervalInSeconds=120

Notes

Restart the managed application so that changes to this property take effect.

This property is commented out by default.

This property is useful for environments where an agent is allowed to connect across the following CA APM components:

  • Clusters.
  • Collectors and Standalone Enterprise Managers.
  • Any combination of clusters, Collectors, and Standalone Enterprise Managers.

If an agent can connect to Enterprise Managers in different clusters and this property is not set, then the following example shows what occurs:

  1. An agent connected to an Enterprise Manager in Cluster disconnects.
  2. The agent connects to an Enterprise Manager in Cluster 2 in disallowed mode.
  3. The agent does not know when the allowed Enterprise Manager in Cluster 1 becomes available.

This property enforces the agent to keep trying to connect to its allowed Enterprise Managers until an Enterprise Manager is available for connection.

Agent to Enterprise Manager Connection Properties

You can control how the agent connects to the Enterprise Manager.

introscope.agent.enterprisemanager.transport.tcp.host.DEFAULT

Specifies the host name of the computer running the Enterprise Manager that the agent connects to by default.

Default: localhost

Example: introscope.agent.enterprisemanager.transport.tcp.host.DEFAULT=localhost

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.enterprisemanager.transport.tcp.port.DEFAULT

Specifies the port number on the computer that hosts the Enterprise Manager that listens for connections from the agent.

Default

The default port depends on the type of communication channel you want to configure. For direct communication between the agent and Enterprise Manager, the default port is 5001.

Example

introscope.agent.enterprisemanager.transport.tcp.port.DEFAULT=5001

Notes

  • You must restart the managed application before changes to this property take effect.
  • If you want to connect to the Enterprise Manager using HTTPS (HTTP over SSL), the default port is 8444. If you want to connect to the Enterprise Manager using SSL, the default port is 5443. However, these default settings are commented out by default.

introscope.agent.enterprisemanager.transport.tcp.socketfactory.DEFAULT

Specifies the default client socket factory to use for connections from the agent to the Enterprise Manager.

Default: The default socket factory depends on the type of communication channel you want to configure. For direct communication between the agent and Enterprise Manager, the default socket factory is as follows:

com.wily.isengard.postofficehub.link.net.DefaultSocketFactory

Example:

introscope.agent.enterprisemanager.transport.tcp.socketfactory.DEFAULT=com.wily.isengard.postofficehub.link.net.DefaultSocketFactory

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.enterprisemanager.transport.tcp.local.ipaddress.DEFAULT

Specifies the IP address of the application server environment used by the agent for connecting to the Enterprise Manager. This property is useful if there are multiple NICs on the agent computer and you want to use a specific one for the agent.

Default: localhost

Example: introscope.agent.enterprisemanager.transport.tcp.local.ipaddress.DEFAULT=<IP address>

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.enterprisemanager.transport.tcp.local.port.DEFAULT

Specifies the default local port on the application server to enable connections from the agent to the Enterprise Manager. If the property is not set (or set to 0), the agent picks any available port number.

Default: 0

Example: introscope.agent.enterprisemanager.transport.tcp.local.port.DEFAULT=<port number>

Note:

  • You must restart the managed application before changes to this property take effect.
  • You can customize the port number setting of the agent to work with your server environment as shown in the following example:

    introscope.agent.enterprisemanager.transport.tcp.local.port.DEFAULT=5000

    In this case you must also configure the TIME_WAIT settings of the operating system where the agent is installed to prevent a connection failure between the agent and the Collector. For instructions on managing port timeout settings, refer to the Operating System documentation of the computer where the agent is installed.

  • For more information about this property, see TEC1902143.

Agent HTTP tunneling for proxy servers

The following properties only apply to agents configured to tunnel over HTTP and must connect to an Enterprise Manager using a proxy server.

introscope.agent.enterprisemanager.transport.http.proxy.host

Specifies the proxy server host name.

Default: commented out; not specified

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.enterprisemanager.transport.http.proxy.port

Specifies the proxy server port number.

Default: commented out; not specified

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.enterprisemanager.transport.http.proxy.username

Specifies the user name for authentication, if the proxy server requires the agent to authenticate it.

Default: commented out; not specified

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.enterprisemanager.transport.http.proxy.password

Specifies the password for authentication, if the proxy server requires the agent to authenticate it.

Default: commented out; not specified

Note: You must restart the managed application before changes to this property take effect.

Agent HTTPS tunneling

You can configure agents to send information using HTTPS, enabling agents to connect to an Enterprise Manager remotely.

introscope.agent.enterprisemanager.transport.tcp.host.DEFAULT

Specifies the host name of the computer running the Enterprise Manager that the agent connects to by default.

Default: localhost

Example: introscope.agent.enterprisemanager.transport.tcp.host.DEFAULT=localhost

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.enterprisemanager.transport.tcp.port.DEFAULT

Specifies the port number on the computer that hosts the Enterprise Manager. This property is commented out by default.

Default: 8444

Example: introscope.agent.enterprisemanager.transport.tcp.port.DEFAULT=8444

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.enterprisemanager.transport.tcp.socketfactory.DEFAULT

Specifies the client socket factory to use for connections from the agent to the Enterprise Manager when using HTTPS.

Default: com.wily.isengard.postofficehub.link.net.HttpsTunnelingSocketFactory

Example: introscope.agent.enterprisemanager.transport.tcp.socketfactory.DEFAULT=com.wily.isengard.postofficehub.link.net.HttpsTunnelingSocketFactory

Note: You must restart the managed application before changes to this property take effect.

Agent Memory Overhead Property

Significant agent memory overhead only occurs in certain extreme cases. The typical trade-off for lowering memory consumption is a potential increase in response time. However, each application is unique and the trade-off between memory usage and response time can vary depending on the application itself.

introscope.agent.reduceAgentMemoryOverhead

Specifies the agent configuration to use. Uncomment if you want to reduce the agent memory overhead.

Values: true or false

Default: false

Example: introscope.agent.reduceAgentMemoryOverhead=false

Note: Restart the managed application for the changes to this property take effect.

Agent Metric Aging Properties

Agent metric aging periodically removes dead metrics from the agent memory cache. A dead metric is a metric that has no new data reported in a configured amount of time. Removing old metrics helps to improve agent performance and avoid potential metric explosions.

Note: A metric explosion happens when an agent is inadvertently set up to report more metrics than the system can handle. When too many metrics are reported, the agent can affect the performance of the application server, or in extreme cases, prevent the server from functioning at all.

Metrics that are in a group are removed only if all metrics in the group are considered candidates for removal. Currently, only BlamePointTracer and MetricRecordingAdministrator metrics are removed as a group. Other metrics are removed individually.

The MetricRecordingAdministrator has the following interfaces for creating, retrieving, or removing a metric group:

  • getAgent().IAgent_getMetricRecordingAdministrator.addMetricGroup
    String component, collection metrics. The component name is the metric resource name of the metric group. The metrics must be under the same metric node to qualify as a group. The metrics are a collection of com.wily.introscope.spec.metric.AgentMetric data structures. You can only add AgentMetric data structures to this collection.
  • getAgent().IAgent_getMetricRecordingAdministrator.getMetricGroup
    String component. Based on the component name which is the metric resource name, you can get the Collection of metrics.
  • getAgent().IAgent_getMetricRecordingAdministrator.removeMetricGroup
    String component. The metric group is removed based on the component which is the metric resource name.
  • getAgent().IAgent_getDataAccumulatorFactory.isRemoved
    Checks if the metric is removed. You use this interface if you keep an instance of an accumulator in your extension. If the accumulator is removed because of metric aging, you use this interface to prevent holding onto a dead reference.
Important! If you create an extension that uses a MetricRecordingAdministrator interface (for example, for use with other CA Technologies products), be sure to delete your own instance of an accumulator. If a metric is aged out because it has not been invoked, and data later become available for that metric, the old accumulator instance will not create new metric data points. To avoid this situation, do not delete your own instance of an accumulator and use instead the getDataAccumulatorFactory interface.

Configuring agent metric aging

Agent metric aging is on by default. You can choose to turn off this capability using the property introscope.agent.metricAging.turnOn. If you remove this property from the IntroscopeAgent.profile, agent metric aging is turned off by default.

Agent metric aging runs on a heartbeat in the agent. The heartbeat is configured using the property introscope.agent.metricAging.heartbeatInterval. Be sure to keep the frequency of the heartbeat low. A higher heartbeat will impact the performance of the agent and Introscope.

During each heartbeat, a certain set of metrics are checked. This is configurable using the property introscope.agent.metricAging.dataChunk. It is also important to keep this value low, as a higher value will impact performance. The default value is 500 metrics to be checked per heartbeat. Each of the 500 metrics is checked to see if it is a candidate for removal. For example, if you set this property to check chunks of 500 metrics per heartbeat, and you have a total of 10,000 metrics in the agent memory, then it will take longer with lower impact on performance to check all 10,000 metrics. However, if you set this property to a higher number, you would check all 10,000 metrics faster, but with possibly high overhead.

A metric is a candidate for removal if the metric has not received new data after certain period of time. You can configure this period of time using the property introscope.agent.metricAging.numberTimeslices. This property is set to 180000 by default. If a metric meets the condition for removal, then a check is performed to see if all the metrics in its group are candidates for metric removal. If this requirement has also been met then the metric is removed.

introscope.agent.metricAging.turnOn

Turns on or off agent metric aging.

Values: true or false

Default: true

Example: introscope.agent.metricAging.turnOn=true

Note: Changes to this property take effect immediately and do not require the managed application to be restarted.

introscope.agent.metricAging.heartbeatInterval

Specifies the time interval when metrics are checked for removal, in seconds.

Default: 86400

Example: introscope.agent.metricAging.heartbeatInterval=86400

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.metricAging.dataChunk

Specifies the number of metrics that are checked during each interval.

Default: 500

Example: introscope.agent.metricAging.dataChunk=500

Note: Changes to this property take effect immediately and do not require the managed application to be restarted.

introscope.agent.metricAging.numberTimeslices

Specifies the number of intervals to check without any new data before making it a candidate for removal.

Default: 180000

Example: introscope.agent.metricAging.numberTimeslices=180000

Note: Changes to this property take effect immediately and do not require restarting the managed application.

introscope.agent.metricAging.metricExclude.ignore.0

Excludes specified metrics from being removed. To exclude one or more metrics from aging, add the metric name or a metric filter to the list.

Values: Comma separated list of metrics. You can use an asterisk (*) as a wildcard in metric names.

Default: metric names beginning with Threads (Threads*).

Example: introscope.agent.metricAging.metricExclude.ignore.0=Threads*

Note: Changes to this property take effect immediately and do not require the managed application to be restarted.

Agent Metric Clamp Property

You can configure the agent to approximately clamp the number of metrics sent to the Enterprise Manager. If the number of metrics generated exceeds the value of the property, the agent stops collecting and sending new metrics.

introscope.agent.metricClamp

Configures the agent to approximately clamp the number of metrics sent to the Enterprise Manager.

Default

50000

Example

introscope.agent.metricClamp=50000

Notes

  • When the property is not set, by default the agent clamps at 50000 metrics and new metrics are not reported.
  • Restart the managed application to put property changes into effect.
  • This clamp property works with the introscope.enterprisemanager.agent.metrics.limit property located in the apm-events-thresholds-config.xml file.

    If introscope.enterprisemanager.agent.metrics.limit clamp value is triggered before the introscope.agent.metricClamp value, then the Enterprise Manager reads agent metrics but does not report them in the Investigator metric browser tree.
    If the introscope.agent.metricClamp clamp value is triggered before the introscope.enterprisemanager.agent.metrics.limit clamp value, the agent stops sending metrics to the Enterprise Manager

Agent Naming Properties

You can configure properties to obtain the Java agent name for application servers.

introscope.agent.agentAutoNamingEnabled

Specifies whether agent autonaming is used to obtain the Java agent name for supported application servers.

Values: true or false

Default: Varies by application server.

Example: introscope.agent.agentAutoNamingEnabled=false

Notes:

  • Agent autonaming is enabled by default for WebLogic and WebSphere.
  • This property requires the Startup Class to be specified for WebLogic, and requires the Custom Service to be specified for WebSphere.
  • Agent auto naming is disabled in the following application servers: Interstage and Tomcat.
  • See Enabling Autonaming for JBoss to enable autonaming for JBoss.
  • You must restart the managed application before changes to this property take effect.

introscope.agent.agentAutoNamingMaximumConnectionDelayInSeconds

Specifies the amount of time in seconds the agent waits for naming information before connecting to the Enterprise Manager.

Default: 120

Example: introscope.agent.agentAutoNamingMaximumConnectionDelayInSeconds=120

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.agentAutoRenamingIntervalInMinutes

Specifies the time interval in minutes during which the agent will check to see if it has been renamed.

Default: 10

Example: introscope.agent.agentAutoRenamingIntervalInMinutes=10

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.agentName

Provides a default agent name if other agent naming methods fail.

Value: For any installation, if the value of this property is invalid or if this property is deleted from the profile, the agent name will be UnnamedAgent.

Example: #introscope.agent.agentName=AgentName

Note:

  • You must restart the managed application before changes to this property take effect.
  • In the agent profile provided with application server-specific agent installers, the default reflects the application server, for instance WebLogic Agent.
  • In the agent profile provided with the default agent installer, the property value is AgentName, and the line is commented out.
  • Uncomment this property to provide a default agent name if other agent naming methods fail.

introscope.autoprobe.directivesFile

You need to enable ServletHeaderDecorator / HTTPHeaderDecorator and CEMTracer through the directivesFile property configuration.

The directives file property specifies where to find the directive files (PBD) or directive lists (PBL) for AutoProbe.

AutoProbe uses directives to enable your applications, and to determine which metrics the agents report to the Enterprise Manager.

Settings

Depends on the agent application server installed, with the format of <appserver>-full.pbl or <appserver>-typical.pbl.

Default

default-typical.pbl

Example

introscope.autoprobe.directivesFile=weblogic-typical.pbl

Notes

Although you can simply add "ServletHeaderDecorator.pbd" or "httpheaderdecorator.pbd" to the end of this property list, it is better practice to:

  1. Locate the PBL file specified in the property (in the example above, weblogic-typical.pbl).
  2. Open the PBL file in a text editor.
  3. For a Java agent, uncomment to enable the ServletHeaderDecorator.pbd line.
  4. For a .NET agent, uncomment to enable the httpheaderdecorator.pbd line.
  5. Save your changes to the PBL file.

introscope.agent.agentNameSystemPropertyKey

Specifies the agent name using the value of a java system property.

Default: Not specified.

Example: introscope.agent.agentNameSystemPropertyKey

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.disableLogFileAutoNaming

Specifies whether to disable automatic naming of agent log files when using AutoNaming options.

Setting this property to true disables the auto-naming of log files for the agent, AutoProbe and LeakHunter with the agent name or a timestamp.

Value: true or false

Default: false

Example: introscope.agent.disableLogFileAutoNaming=false

Note:

  • You must restart the managed application before changes to this property take effect.
  • Log file auto-naming only takes effect when the agent name can be determined using a Java system property or an application server custom service.

introscope.agent.clonedAgent

Enables you to run identical copies of an application on the same machine. Set this property to true if you have identical copies of an application running on the same machine.

Values: true or false

Default: false

Example: introscope.agent.clonedAgent=false

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.customProcessName

Specifies the process name as it should appear in the Introscope Enterprise Manager and Workstation.

Default: Varies by application server.

Example: introscope.agent.customProcessName=CustomProcessName

Note:

  • You must restart the managed application before changes to this property take effect.
  • In the agent profile provided with application server-specific agent installers, the default reflects the application server, for instance "WebLogic."
  • In the agent profile provided with default agent installer, the property is commented out.

introscope.agent.defaultProcessName

Specifies the value used for the process name, if no custom process name is provided and the agent is unable to determine the name of the main application class.

Default: UnknownProcess

Example: introscope.agent.defaultProcessName=UnknownProcess

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.display.hostName.as.fqdn

Specifies whether the agent name is displayed as a fully qualified domain name (fqdn). To enable the fully-qualified domain name, set this property value to 'true.' By default, the agent displays the host name.

Property settings: true or false

Default: false

Example: introscope.agent.display.hostName.as.fqdn=false

Note:

  • You must restart the managed application before changes to this property take effect.
  • For the Catalyst integration, set this property to 'true'.

Agent Recording (Business Recording) Property

You can control how the agent handles business transaction recording.

introscope.agent.bizRecording.enabled

Enables or disables business transaction recording for the agent.

Values: true or false

Default: true

Example: introscope.agent.bizRecording.enabled=true

Note: You must restart the managed application before changes to this property take effect.

Agent Thread Priority Property

The property in this section controls the priority of agent threads.

introscope.agent.thread.all.priority

Controls the priority of agent threads.

Values: 1 (low) to 10 (high).

Default: commented out; 5

Example: introscope.agent.thread.all.priority=5

Note: You must restart the managed application before changes to this property take effect.

Application Triage Map Properties

You can configure business transaction recording for the agent and application triage map data.

introscope.agent.appmap.enabled

Enables or disables the tracking of monitored code for the application triage map.

Values: true or false

Default: true

Example: introscope.agent.appmap.enabled=true

introscope.agent.appmap.metrics.enabled

Enables or disables the tracking of metrics for application triage map nodes.

Values: true or false

Default: commented out; false

Example: introscope.agent.appmap.metrics.enabled=false


introscope.agent.appmap.queue.size

Specifies the buffer size for the application triage map.

Value: Positive integers

Default: commented out;1000

Example: introscope.agent.appmap.queue.size=1000

Note: If the value is set to 0, the buffer is unbounded.

introscope.agent.appmap.queue.period

Specifies the frequency in milliseconds for sending application triage map data to the Enterprise Manager.

Values: Positive integers.

Default: commented out; 1000

Example: introscope.agent.appmap.queue.period=1000

Note: If the value is set to 0, the default value is used.

introscope.agent.appmap.intermediateNodes.enabled

Enables or disables the ability to include intermediate nodes between the application frontend and backend nodes.

Values: true or false

Default: commented out; false

Example: #introscope.agent.appmap.intermediateNodes.enabled=true

Note:

  • Changes to this property takes effect immediately and do not require the managed application to be restarted.
  • If you set this property to true, you may experience a slowdown of agent performance.

Application Triage Map and Catalyst Integration Property

You can configure application triage map data for the Catalyst integration.

Configure the Ability to Send Information

This property enables or disables the ability to send additional information from the agent for integration with Catalyst.

Follow these steps:

  1. Open the default IntroscopeAgent.profile file in a text editor.
    Locate the line: introscope.agent.appmap.catalystIntegration.enabled=<false|true>, and set a value as follows:
    • true
      Enables the ability to send additional information from the agent for integration with Catalyst.
    • false
      Disables the configuration.
      The following example shows the format:

      introscope.agent.appmap.catalystIntegration.enabled=false

    Note: This property is commented out by default.
  2. Save and close the file.
    The agent is set up to use the configuration.

Configure a List of Available Networks

The introscope.agent.primary.net.interface.name property specifies the primary network interface name of the host computer used by the agent for the Catalyst integration. You can change the configuration of this property and the change is applied automatically.

Note: When the agent logging level is set to DEBUG, information about network interface names available for configuration appears in the log file. Alternatively, you can use the Network Interface utility to determine the primary network interface name for this property.

Follow these steps:

  1. Open the default IntroscopeAgent.profile file in a text editor.
  2. Locate the line: introscope.agent.primary.net.interface.name=, and specify the name value.
    The following example shows the name format:

    introscope.agent.primary.net.interface.name=eth4

    Note: The default value is undefined. When this property is not set, the agent assigns the first available network interface as the primary interface. You can use the Network Interface utility to determine the name value for this property.
  3. (Optional) Allow for multiple network addresses by specifying the subinterface number (starts at 0).
    The following example shows the subinterface number format:

    introscope.agent.primary.net.interface.name=eth4.1

  4. Save and close the file.
    The profile is set up to use the configuration.

Application Triage Map Business Transaction POST Parameters Property

You can configure your Local Product Shorts to perform more complex monitoring by matching POST parameters.

Note: Understand how agent recording works before you configure the property.

introscope.agent.bizdef.matchPost

This property determines when POST parameters are matched.

Property settings

The valid settings for this property are never, before, or after.

  • Set the property to never for full agent functionality and better performance. This setting allows your application to identify all business transactions using URLs, cookies or header parameters, but will fail to match any business transactions that are identified solely through POST parameters.
  • Set the property to before to get full agent performance. This setting allows applications to use POST parameters to identify some or all business transactions, but never access the servlet stream directly for HTTP form requests. New applications deployed must also conform to standard API when this property is set to before.

    Important! Setting this property to before could have potentially hazardous repercussions for your applications. Review this property setting with a CA Technologies representative before implementation.
  • Set the property to after to safely match business transactions with POST parameters, but with limited agent functionality. When this property is set to after, the agent will not be able to map business transactions that are identified by POST parameters across processes, or produce full sets of metrics for them. This setting also consumes slightly more CPU time compared to the other options, but is considered the safest setting if one needs the POST parameter functionality. It allows applications to use POST parameters to identify some or all business transactions and cannot guarantee that the servlet stream is never accessed directly.

Example

introscope.agent.bizdef.matchPost=after

Notes

  • never - never attempt to match POST parameters. This is the fastest option but may result in inaccurate business transaction component matching.
  • before - matches POST parameters before the servlets execute.
  • after - matches POST parameter patterns after the servlet has executed. Cross process mapping and some metrics will not be available. Default setting for the parameter.

Known limitations

The metrics defined using agent recording are displayed in the application triage map in the Investigator. When configuring agent recording, there are some known limitations when using regular expressions. Most of the limitations have to do with POST parameters.

The known limitations are:

  • Line terminators (.) are not supported for POST parameter values.
  • If POST parameter definitions are dependent on the business transaction definition, only three metrics will be provided for the business transaction component. These metrics are:
    • Average Response Time
    • Responses Per Interval
    • Errors Per Interval
  • If POST parameter definitions are dependent on the business transaction definition, then the business component name in the transaction trace component will have a generic name and not the specific name of the business service, business transaction, and business transaction component. This also applies to business transaction definitions that are dependent on POST parameter definitions that do not match.

Application Triage Map managed Socket Configuration Properties

The properties in this section allow you to enable or disable the appearance of socket metrics in the application triage map.

introscope.agent.sockets.managed.reportToAppmap

Enables managed sockets to appear in application triage map.

Values: true or false

Default: true

Example: introscope.agent.sockets.managed.reportToAppmap=true

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.sockets.managed.reportClassAppEdge

Enables managed sockets to report class level application edges to the application triage map.

Values: true or false

Default: false

Example: introscope.agent.sockets.managed.reportClassAppEdge=false

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.sockets.managed.reportMethodAppEdge

Enables managed sockets to report method level application edges to the application triage map.

Values: true or false

Default: true

Example: introscope.agent.sockets.managed.reportMethodAppEdge=true

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.sockets.managed.reportClassBTEdge

Enables managed sockets to report class level business transaction edges to the application triage map.

Values: true or false

Default: false

Example: introscope.agent.sockets.managed.reportClassBTEdge=false

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.sockets.managed.reportMethodBTEdge

Enables managed sockets to report method level business transaction edges to the application triage map.

Values: true or false

Default: true

Example

introscope.agent.sockets.managed.reportMethodBTEdge=true

Note: You must restart the managed application before changes to this property take effect.

AutoProbe Properties

introscope.autoprobe.constructor.policy

AutoProbe constructor instrumentation policies allow as much visibility as possible into constructor transactions. This visibility includes the instrumentation limitations. Constructor instrumentation limitations can cause byte-code verification errors on some JVMs. 

Values:

  • Auto
    Auto instrumentation sets JVM versions 1.6 and lower to the full value, and sets JVM versions 1.7 and higher to the Partial value.
  • Full
    Full instrumentation provides the full timing of constructor methods and catches all thrown exceptions. However, the Full setting can cause class verification errors on some applications and JVMs. This setting creates two try/catch blocks, one for the super() constructor method call, and the other for rest of the constructor body. 
  • None
    The Java agent is not allowed to instrument constructor methods.

Default: Auto

Example: introscope.autoprobe.constructor.policy=Auto

Notes:

  • This property is not included in the introscopeagent.profile file. Add this property to the introscopeagent.profile to change it.
  • The property values are case-sensitive. The first letter must be uppercase, and the remaining letters must be lowercase.
  • This property also has a Partial value that is used by CA Support in specific circumstances. 
    This setting creates one try/catch block for rest of the constructor body. Therefore, the Java agent does not report the timing of the super() constructor method call. When the super() constructor method call throws an exception, the Java agent does not know that the constructor was ever called, therefore cannot report the error. 
  • When Partial is the value, the introscope.autoprobe.constructor.policy property must work with the introscope.autoprobe.constructor.instrumentation.affected.vendors property. The introscope.autoprobe.constructor.instrumentation.affected.vendors property states the vendor of the JVM in use. 
    For example, the APM Administrator has worked with CA Support to use the Partial value for monitoring Oracle Java JVM constructor transactions. The Administrator sets these properties:

    introscope.autoprobe.constructor.policy=Partial

    introscope.autoprobe.constructor.instrumentation.affected.vendors=Oracle

  • When, introscope.autoprobe.constructor.instrumentation.affected.vendors contains a JVM vendor (for example. Oracle or IBM), then introscope.autoprobe.constructor.policy defaults to Partial. Otherwise introscope.autoprobe.constructor.policy defaults to Full.

    More information: introscope.autoprobe.constructor.instrumentation.affected.vendors

  • Restart the managed application for changes to this property to take effect.

introscope.autoprobe.constructor.instrumentation.affected.vendors

This property lists the JVM vendors that provide JVMs that allow the to be set to Partial.

Values: IBM, SAP, Oracle

Default: None

Example: introscope.autoprobe.constructor.instrumentation.affected.vendors=IBM

Notes:

  • This property is not included in the introscopeagent.profile file. Add this property to the introscopeagent.profile to change it.
  • The introscope.autoprobe.constructor.instrumentation.affected.vendors property requires a value to set the introscope.autoprobe.constructor.policy property to the Partial setting.

  • Restart the managed application for changes to this property to take effect.

introscope.autoprobe.directivesFile

Specifies ProbeBuilder directives files for AutoProbe.

Default: Varies by installer.

Notes

  • You must restart the managed application before changes to this property take effect.
  • If this property includes one or more directories, and dynamic ProbeBuilding is enabled, the agent will load directives files from the specified directories without an application restart.

introscope.autoprobe.enable

Enables or disables inserting probes into bytecode automatically.

Values: true or false

Default: true

Example: introscope.autoprobe.enable=true

Note: Setting this property to false turns off automatic insertion of probes into application bytecode, but does not turn off the agent or agent reporting. Restart of the JVM is required for any change to take effect.

introscope.autoprobe.logfile

Specifies if the location of the log file must be moved to something other than the default.

Values: Absolute file paths, or non-absolute paths. Non-absolute names are resolved relative to the location of this properties file.

Default: ../../logs/AutoProbe.log

Example: introscope.autoprobe.logfile=../../logs/AutoProbe.log

To disable logging, comment out the log file as follows:

introscope.autoprobe.logfile=logs/AutoProbe.log

You can set a JVM parameter to limit the AutoProbelog to an approximate size. When this property is set, AutoProbe log compares the current log size to this system property. If the current log size is larger than the property value, then AutoProbe logging stops.  Therefore, the AutoProbe log file size can be larger than the specified value.

Add this property to the monitored application Java parameters in the same location as the -javaagent properties:

-Dcom.wily.autoprobe.logSizeInKB=

This example shows how to set an AutoProbe log file size limit of about 1 MB (1024 KB):

-Dcom.wily.autoprobe.logSizeInKB=1024

Note: You must restart the managed application before changes to this property take effect.

Deep Inheritance Settings

The most common functionality for which you would enable the deep inheritance property is EJB and servlet  request tracing. For example, WebLogic uses its own implementation of ServletRequest and it is not recognized if the deep inheritance property is disabled. EJBs only work if they directly implement SessionBean and EJBObject which, depends on the web server version and type of implementation. This rule also applies to extension and other custom PBDs that apply the deep inheritance property.

PBD Examples:

apm-common.pbd 

IdentifyDeepInheritedAs: javax.servlet.ServletRequest ServletRequestClass

IdentifyDeepInheritedAs: javax.servlet.http.HttpServletRequest ServletRequestClass

j2ee.pbd 

IdentifyDeepInheritedAs: javax.ejb.SessionBean SessionBeanTracing

IdentifyDeepInheritedAs: javax.ejb.EntityBean EntityBeanTracing

IdentifyDeepInheritedAs: javax.ejb.MessageDrivenBean MessageDrivenBeanTracing

IdentifyDeepInheritedAs: javax.ejb.EJBObject EJB2StubTracing

HTTP_Tracer_For_SYSVIEW.pbd 

IdentifyDeepInheritedAs: java.net.URLConnection URLConnectionCorrelationTracing

IdentifyDeepInheritedAs: javax.servlet.http.HttpServlet HttpServletCorrelationTracing

introscope.autoprobe.deepinheritance.enabled

This property enables deep inheritance instrumentation through PBD directives.

If this property is set to false, deep inheritance directives behave as shallow inheritance. Meaning, inheritance relations beyond the immediate super class interfaces are not recognized.

Values: true or false

Default: true

Property Example: introscope.autoprobe.deepinheritance.enabled=false

Note: Restart the managed application before changes to this property take effect.

introscope.autoprobe.deepinheritance.auto.turnoff.enable

If you enable the deep inheritance property this parameter takes effect. This property controls if whether deep inheritance will automatically turn off when it takes too much time:

  • If the property is set to true, deep inheritance automatically turns off when it takes too much time. 
  • If the property is set to false, deep inheritance does not automatically turn off and it continues.

Values: true or false

Default: true

Property Example: introscope.autoprobe.deepinheritance.auto.turnoff.enable=true

Note: Restart the managed application before changes to this property take effect.

introscope.autoprobe.deepinheritance.auto.turnoff.requests.per.interval

If you enable the deep inheritance auto turn off property this parameter takes effect. This property specifies the number of requests in a checking interval.

Values: numeric

Default: 100

Property Example: introscope.autoprobe.deepinheritance.auto.turnoff.requests.per.interval=100

Note: Restart the managed application before changes to this property take effect.

introscope.autoprobe.deepinheritance.auto.turnoff.maxtime.per.interval

If you enable the deep inheritance auto turn off property this parameter takes effect. This property specifies the maximum amount of time in milliseconds allowed in a checking interval.

Values: numeric

Default: 12000

Property Example: introscope.autoprobe.deepinheritance.auto.turnoff.maxtime.per.interval=12000

Note: Restart the managed application before changes to this property take effect.

introscope.autoprobe.deepinheritance.auto.turnoff.maxtime.total

If you enable the deep inheritance auto turn off property this parameter takes effect. This property specifies the total maximum time deep inheritance can spend after an application starts. If the application exceeds the value specified, then deep inheritance is disabled. 

Values: numeric

Default: 120000

Property Example: introscope.autoprobe.deepinheritance.auto.turnoff.maxtime.total=120000

Note: Restart the managed application before changes to this property take effect.

Bootstrap Classes Instrumentation Manager Properties

The properties in this section configure the Bootstrap Classes Instrumentation Manager:

The Bootstrap Classes Instrumentation Manager instruments a set of classes after the agent bootstrap, allowing easy implementation of tracers for Java NIO and Secure Sockets Layer (SSL), as well as improving agent performance. You can disable this property by commenting it out in the IntroscopeAgent.profile.

introscope.bootstrapClassesManager.enabled

Enables or disables the bootstrap manager.If set to false, no system classes are instrumented.

Values: true or false

Default: false

Example: introscope.bootstrapClassesManager.enabled=true

Note:

  • This property only functions with JVMs running Java 1.5 at a minimum.
  • You must restart the managed application before changes to this property take effect.

introscope.bootstrapClassesManager.waitAtStartup

Sets the time in seconds for the agent wait time after startup to instrument bootstrap classes.

Default:

  • 240 seconds when used with Interstage, WebLogic, or WebSphere Application Server.
  • 5 seconds when used with JBoss, Sun, or Tomcat.

Example: introscope.bootstrapClassesManager.waitAtStartup=5

Note:

  • This property only functions with JVMs running Java 1.5 at a minimum.
  • When this property is active, it can overrule classes that have been designated as skipped. If skipped classes are being instrumented, contact your CA Technologies representative, or CA Support.

CA CEM Agent Profile Properties

You can configure CA CEM-related IntroscopeAgent.profile properties. The Introscope agent profile file is found in the <Agent_Home> directory.

All the CA CEM-related properties are preconfigured to the required options for the integration with CA CEM and Introscope to work.

introscope.agent.remoteagentconfiguration.allowedFiles

This property identifies the files that are allowed to be copied remotely from any machine to the agent directory.

The Enterprise Manager uses the file name in this property to identify the valid CA CEM domain configuration file to send to the agents. The domain configuration file contains the CA CEM business service and transactions definitions.

Settings

Use valid file name.

Default

domainconfig.xml

Example

introscope.agent.remoteagentconfiguration.allowedFiles=domainconfig.xml

Notes

This property also applies to the Introscope Command-Line Workstation (CLW) Send Config File command.

For more information, see Using the Command-Line Workstation in the CA APM Configuration and Administration Guide.

This property is valid for CA CEM releases.

introscope.agent.remoteagentconfiguration.enabled

If this Boolean value is set to true, it allows remote file copies to the agent from another computer.

The Enterprise Manager requires you to set this property to true to send the CA CEM domain configuration file to the agents. The domain configuration file contains the CA CEM business service and transactions definitions.

Settings

true or false

Default

  • true for Java Agents
  • false for .NET Agents

Example

introscope.agent.remoteagentconfiguration.enabled=true

Notes

A remote user can also use the Introscope Command-Line Workstation (CLW) Send Config File command to copy the file or files specified in the introscope.agent.remoteagentconfiguration.allowedFiles property into the agent directory.

For noncompatible agents (that is, an unsupported .NET agent, an EPA agent, or other non-Java agent), set the introscope.agent.remoteagentconfiguration.enabled property to false.

introscope.agent.decorator.enabled

If this Boolean value is set to true, it configures the agent to add additional performance monitoring information to HTTP response headers. ServletHeaderDecorator / HTTPHeaderDecorator attaches the GUID to each transaction and inserts the GUID into an HTTP header, x-wily-info.

This enables the correlation of transactions between CA CEM and Introscope.

Settings

True or false

Default

  • false for Java agents
  • false for .NET agents

Example

introscope.agent.decorator.enabled=false

introscope.agent.decorator.security

This property determines the format of decorated HTTP response headers that are sent to CA CEM.

Settings

  • clear -- clear text encoding
  • encrypted -- header data is encrypted

Default

encrypted

Example

introscope.agent.decorator.security=encrypted

Note: For supported versions, see the Product Compatibility Matrix.

ChangeDetector Configuration Properties

You can control how the local agent works with ChangeDetector.

introscope.changeDetector.enable

Specifies whether ChangeDetector is enabled or disabled. Set the property to true to enable ChangeDetector. It is commented out and set to false by default. If you enable ChangeDetector, you should also set the additional ChangeDetector-related properties.

Property settings

True or False

Default

False

Example

introscope.changeDetector.enable=false

Notes

You must restart the managed application before changes to this property take effect.

introscope.changeDetector.agentID

Specifies the text string used by ChangeDetector to identify the local agent. This property is commented out by default. If you enable ChangeDetector, you should uncomment this property and set it to an appropriate value.

Default

The default value is SampleApplicationName.

Example

introscope.changeDetector.agentID=SampleApplicationName

introscope.changeDetector.rootDir

Specifies the root directory for ChangeDetector files. The root directory is the folder where ChangeDetector creates its local cache files.

Property settings

Full path to the root directory for ChangeDetector files as a text string.

Default

The default path is c:\\sw\\AppServer\\<Agent_Home>\\change_detector.

Example

introscope.changeDetector.rootDir=c:\\sw\\AppServer\\<Agent_Home>\\change_detector

Notes

Use a backslash to escape the backslash character, as in the example.

introscope.changeDetector.isengardStartupWaitTimeInSec

Specifies the number of seconds to wait after the agent starts before ChangeDetector tries to connect to the Enterprise Manager. This property is commented out by default.

Default

The default is 15 seconds.

Example

introscope.changeDetector.isengardStartupWaitTimeInSec=15

introscope.changeDetector.waitTimeBetweenReconnectInSec

Specifies the number of seconds ChangeDetector waits before retrying a connection to the Enterprise Manager. This property is commented out by default.

Default

The default is 10 seconds.

Example

introscope.changeDetector.waitTimeBetweenReconnectInSec=10

introscope.changeDetector.profile

Specifies the absolute or relative path to the ChangeDetector datasources configuration file. This property is commented out by default.

Default

The default is ChangeDetector-config.xml.

Example

introscope.changeDetector.profile=CDConfig\\ChangeDetector-config.xml

Notes

Use a backslash to escape the backslash character, as in the example.

introscope.changeDetector.profileDir

Specifies the absolute or relative path to the directory that contains datasource configuration files. If this property is set, all of the datasource configuration files in this directory are used in addition to any file specified by the introscope.changeDetector.profile property. This property is commented out by default.

Default

The default is changeDetector_profiles.

Example

introscope.changeDetector.profileDir=c:\\CDconfig\\changeDetector_profiles

Notes

Use a backslash to escape the backslash character.

introscope.changeDetector.compressEntries.enable

Specifies whether to allow compression on the ChangeDetector data buffer. You can set this property to true if you experience memory consumption at start-up to improve performance.

Property settings

True or False

Default

The default value is false if the property is not set in the agent profile or if commented out.

Example

introscope.changeDetector.compressEntries.enable=true

Notes

You must restart the managed application before changes to this property take effect.

introscope.changeDetector.compressEntries.batchSize

This property defines the batch size for the compression job, set in introscope.changeDetector.compressEntries.enable above.

Default

1000

Example

introscope.changeDetector.compressEntries.batchSize=1000

Notes

You must restart the managed application before changes to this property take effect.

Smart Instrumentation Properties

If appropriate for your environment, you can vary the depth and scope of smart instrumentation visibility. You can consider the overhead impact and your monitoring environment. For example, you can experiment with higher overhead in a test or QA environment, but not in production.

Note: To see deep visibility components, both of these properties must be set to true:

  • introscope.agent.deep.instrumentation.enabled
  • introscope.agent.deep.trace.enabled

introscope.agent.deep.instrumentation.enabled

Enables and disables agent ability to automatically instrument deep visibiliy components without PBD configuration to provide smart instrumentation.

Values: true or false

Default: true

Example: introscope.agent.deep.instrumentation.enabled=true

Notes:

Requires managed application restart.

The introscope.agent.deep.instrumentation.enabled property must be enabled for the introscope.agent.deep.trace.enabled property to function.

introscope.agent.deep.trace.enabled

Enables and disables the agent ability to collect deep visibility components and send the data to the Enterprise Manager.

Values: true or false

Default: true

Example: introscope.agent.deep.trace.enabled=true

Notes:

Dynamic property. No managed application restart needed.

The introscope.agent.deep.instrumentation.enabled property must be enabled for the introscope.agent.deep.trace.enabled property to function.

When introscope.agent.deep.instrumentation.enabled=true and introscope.agent.deep.trace.enabled=true, the agent automatically instruments deep visibility components and Introscope sends deep visibility component data to the Enterprise Manager..

When introscope.agent.deep.instrumentation.enabled=true and introscope.agent.deep.trace.enabled=false, the agent automatically instruments deep visibility components. However no deep visibility component data is sent to the Enterprise Manager or displayed.

When introscope.agent.deep.instrumentation.enabled=false and introscope.agent.deep.trace.enabled=true, the agent does not instrument deep visibility components. Therefore no deep visibility components are discovered, sent to the Enterprise Manager, or displayed.

Note: Both introscope.agent.deep.instrumentation.enabled and introscope.agent.deep.trace.enabled must be set to true for the following properties to function.

introscope.agent.deep.instrumentation.level

Sets the instrumentation level. Determines the amount of managed application code that the agent instruments to discover deep-visibility methods.

Important! Setting the level to high causes the most overhead.

When the instrumentation level is changed, classes are reloaded in batches. The duration of the level change depends on the number of classes, and the batch size and interval. When a level change is in progress and another change is made, the first change completes before the second change starts. View the Current Instrumentation Level supportability metric for level status.

Values:

  • low: To balance visibility with minimal impact to application resources.
  • medium: To provide deeper visibility with more impact to application resources.
  • high: To provide greatest visibility with higher impact to application resources than the medium and low settings.

Default: low

Example: introscope.agent.deep.instrumentation.level=low

Notes: Dynamic property. No managed application restart needed.

introscope.agent.deep.instrumentation.level.batch.size
 

Important! The batch size default value is optimized for typical production environments. A value greater than the default can increase performance overhead in environments with a high transaction load.

When the introscope.agent.deep.instrumentation.level property is changed, classes are reloaded in batches. This property specifies the number of classes that are reloaded per batch.

Values: Integer > 0. If <=0, automatically reset to the default.

Default: 5

Example: introscope.agent.deep.instrumentation.level.batch.size=5

Note: No managed application restart required.

introscope.agent.deep.instrumentation.level.batch.interval

When the introscope.agent.deep.instrumentation.level property is changed, classes are reloaded in batches. This property specifies the time interval in minutes between batches.

Values: Integer >= 1. If <1, automatically reset to the default.

Default: 2

Example: introscope.agent.deep.instrumentation.level.batch.interval=2

Note: No managed application restart required.

introscope.agent.deep.errorsnapshot.enable

Enables and disables visibility of deep visibility components in error snapshots. Stack View in Live Error Viewer and Historical Event Viewer display the detailed error snapshot information.

Values: true or false

Default: true

Example: introscope.agent.deep.errorsnapshot.enable=true

Notes: Dynamic property. No managed application restart needed.

introscope.agent.deep.stallsnapshot.enabled

Enables and disables visibility of deep visibility components for stalls in error snapshots. Stack View in Live Error Viewer and Historical Event Viewer display the detailed stall information.

Values: true or false

Default: true

Example: introscope.agent.deep.stallsnapshot.enabled=true

Notes: Dynamic property. No managed application restart needed.

introscope.agent.deep.instrumentation.max.methods

Limits the number of methods that the agent can automatically instrument without PBD instrumentation.

Values: Integer > 0 <= 10000

Default: 10000

Example: introscope.agent.deep.instrumentation.max.methods=10000

Note: Requires managed application restart.

introscope.agent.deep.trace.max.components

Limits the maximum number of deep visibility components an agent can collect in a transaction trace.

Values: Integer > 0 <= 1000

Default: 1000

Example: introscope.agent.deep.trace.max.components =1000

Note: No managed application restart required.

introscope.agent.deep.trace.max.consecutive.components

Limits the maximum number of consecutive deep visibility components in a transaction trace. Sets the number of deep visibility components discovered and displayed between PBD-instrumented methods.

Values: Integer > 0

Default: 15

Example: introscope.agent.deep.trace.max.consecutive.components=15

Note: No managed application restart required.

introscope.agent.deep.instrumentation.custom.prefixes

Specifies the Java packages that Introscope makes low priority to be instrumented by smart instrumentation.

Values: Any string consisting of valid Java package prefix characters. One or multiple prefix segments are allowed. Use commas to separate multiple strings. No wild cards allowed.

Default: java

Example: introscope.agent.deep.instrumentation.custom.prefixes=java,org.apache

In this example, Introscope considers the methods that call the APIs defined in Java and org.apache as low priority to be instrumented by smart instrumentation.

Note: Managed application restart required.

introscope.agent.deep.automatic.trace.enabled

Enables and disables Introscope to automatically collect transaction traces.

Values: true or false

Default: true

Example: introscope.agent.deep.automatic.trace.enabled=true

Notes: 

  • Dynamic property. No managed application restart needed.
  • This property does not apply to transaction trace sampling.

introscope.agent.deep.automatic.trace.clamp

Limits the number of automatic transaction traces that Introscope collects per 1-minute interval.

Values: Integer > 0. If <= 0, Introscope does not collect automatic transaction traces.

Default: 10

Example: introscope.agent.deep.automatic.trace.clamp=10

Note: 

  • No managed application restart required.
  • This property does not apply to transaction trace sampling.

introscope.agent.deep.entrypoint.enabled

Enables and disables the agent ability to detect entry points.

Values: true or false

Default: true

Example: introscope.agent.deep.entrypoint.enabled=true

Notes: 

  • Dynamic property. No managed application restart needed.

introscope.agent.deep.entrypoint.skip.pkgs

Specifies the Java package prefixes for classes that the agents skips and does not consider for entry points. These prefixes are in addition to skipped flags and classes in existing default or custom PBDs

Values: Any consisting of valid Java package prefix characters. Use commas to separate multiple strings. No wild cards allowed.

Default: <blank>

Example: introscope.agent.deep.entrypoint.skip.pkgs=com.abc

In this example, the agent skips all the classes with the prefix com.abc. The agent does not consider these classes as possible entry points.

Note: Managed application restart required.

introscope.agent.deep.entrypoint.count.max

Limits the maximum number of entry points that can be persisted in AutoPersist pbd.

Values: Integer > 0 <= 250

Default: 100

Example: introscope.agent.deep.entrypoint.count.max =100

Note: No managed application restart required.

Dynamic Instrumentation Properties

You can enable classes and methods to be instrumented dynamically without writing custom PBDs, restarting the application server, or restarting the agent.

introscope.autoprobe.dynamicinstrument.enabled

Enables dynamic ProbeBuilding for agents.

Values: true or false

Default: true

Example: introscope.autoprobe.dynamicinstrument.enabled=true

Note: Valid for agents that run on JDK 1.5 at a minimum and use AutoProbe

autoprobe.dynamicinstrument.pollIntervalMinutes

Determines the frequency with which the agent polls for new and changed PBDs.

Default: 1

Example: autoprobe.dynamicinstrument.pollIntervalMinutes=1

Note: Valid for agents that run on JDK 1.5 at a minimum using AutoProbe and dynamic ProbeBuilding

introscope.autoprobe.dynamicinstrument.classFileSizeLimitInMegs

Some classloader implementations have been observed to return huge class files.This is to prevent memory errors.

Default: 1

Example: introscope.autoprobe.dynamicinstrument.classFileSizeLimitInMegs=1

Note: You must restart the managed application before changes to this property take effect.

introscope.autoprobe.dynamic.limitRedefinedClassesPerBatchTo

Re-defining too many classes at a time might be very CPU intensive. In cases where the changes in PBDs trigger a re-definition of a large number of classes, this batches the process at a comfortable rate.

Default: 10

Example: introscope.autoprobe.dynamic.limitRedefinedClassesPerBatchTo=10

introscope.agent.remoteagentdynamicinstrumentation.enabled

Enables or disables remote management of dynamic instrumentation.

Values: true or false

Default: true

Example: introscope.agent.remoteagentdynamicinstrumentation.enabled=true

Note:

  • You must restart managed applications before changes to this property take effect.
  • Dynamic instrumentation is a CPU-intensive operation. Use configurations that minimize the classes that are being instrumented.

introscope.autoprobe.dynamicinstrument.pollIntervalMinutes

Defines the polling interval in minutes to poll for PBD changes.

Default: 1

Example: introscope.autoprobe.dynamicinstrument.pollIntervalMinutes=1

Note: You must restart the managed application before changes to this property take effect.

ErrorDetector Properties

ErrorDetector is installed by default with the agent. You can control how the agent interacts with ErrorDetector. 

introscope.agent.errorsnapshots.enable

This property enables the agent to capture transaction details about serious errors. This property must be set to true for error snapshots to be available for viewing.

Values: true or false

Default: true

Note: You  do not need to restart the managed application.

introscope.agent.errorsnapshots.throttle

This property specifies the maximum number of error snapshots that the agent can send in a 15-second period.

Default: 10

Example: introscope.agent.errorsnapshots.throttle=10

Note: You  do not need to restart the managed application.

introscope.agent.errorsnapshots.ignore.<index>

This property specifies one or more error message filters. You can specify as many filters as you need using the index identifier that is appended to the property name (for example, .0, .1, .2 ...). You can use wildcards (*) Error messages matching the criteria that you specify are ignored. When errors match the filters that you define, the agent does not generate error snapshots and does not send error events to the Enterprise Manager.

Important! You cannot use this property to filter SOAP error messages.

Default: The IntroscopeAgent.profile provides example values.

Example:

introscope.agent.errorsnapshots.ignore.0=*com.company.HarmlessException*
introscope.agent.errorsnapshots.ignore.1=*HTTP Error Code: 404*

Note: You  do not need to restart the managed application.

Extensions Properties

You can configure the location of agent extensions.

introscope.agent.extensions.directory

Specifies the location of all extensions to be loaded by the agent. You can specify an absolute or relative path to the directory. If you do not specify an absolute path, the value you specify is resolved relative to the location of the IntroscopeAgent.profiles file.

Default: ext directory in the <Agent_Home>/ext directory.

Example: introscope.agent.extensions.directory=../ext

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.common.directory

Configures the location of Agent Extension related files.

Default: common folder in the <Agent_Home>/common directory.

Example: introscope.agent.common.directory=../../common

External Business Transaction Monitoring Properties

In the IntroscopeAgent.* profile, you can use:

  • The External Business Transaction Monitoring properties to configure CA APM business transaction to external business transaction matching. End-User Endpoints Monitoring uses this name matching.
  • The Transaction Tracer Configuration x-apm-bt property to record specific HTTP request headers, parameters, or session attributes in the Transaction Tracer data.

Note: The properties are not for the legacy mode Java agent.

introscope.agent.external.biz.enabled

Turns on/off the External Business Transaction Monitoring feature.

Default: true

introscope.agent.external.biz.header.size.max

Specifies the maximum data size for the External Business Transaction header parameter (x-apm-bt). The unit is 1 KB. A request with a parameter exceeding this limit is not processed as an External Business Transaction.

Default: 10

introscope.agent.external.biz.bt.count.max

Specifies the maximum number (clamp) of External Business Transactions allowed. The clamp is per agent (the instrumented Java backend application instance). If the clamp is reached, an entry appears in the agent logs and in the supportability metric. Resets the current External Business Transaction definition.

Default: 100

introscope.agent.transactiontracer.parameter.httprequest.headers=x-apm-bt

Specifies HTTP request headers, parameters, or session attributes in the Transaction Tracer data.

GC Monitor Property

The metrics under the GC Monitor node report information on Garbage Collectors and Memory Pools. These metrics help you detect memory-related issues that are adversely affecting performance. You must manually enable the collection of these metrics in the agent profile.

introscope.agent.gcmonitor.enable

Enables or disables the metrics for Garbage Collectors and Memory Pools.

Values: true or false

Default: true

Example: introscope.agent.gcmonitor.enable=true

Note:

  • This property is dynamic. You can change the configuration of this property during run time and the change is picked up automatically.
  • You can only report GC Monitor metrics for agents that monitor Sun or IBM JVMs.

Java NIO Properties

The Java Agent supports the Java New I/O (Java NIO, or NIO) capabilities. Java NIO is a collection of APIs designed to provide access to the low-level I/O operations of modern operating systems. Java NIO metrics capture information about how instrumented applications use Java NIO.

Note: Introscope Java NIO metrics and metric collection of Java NIO information is only available on Java 1.5 JVMs at a minimum.

The Introscope Java Agent collects metrics for NIO channels.

You can restrict the generation of certain NIO metrics.

Java NIO tracer groups have been enabled by default. You can turn off these tracer groups to restrict metric generation further.

Channels

Java NIO channels provide bulk data transfers to and from NIO buffers, as well as external systems. This is a low-level data transfer mechanism that was specifically designed to address performance and scalability issues within standard Java I/O.

Channels provide mechanisms for moving bytes between buffers and external systems. Introscope channel metrics characterize data flow rates through channels. Collected NIO channel metrics correspond to metrics currently created for file and socket I/O using standard Java I/O techniques. Metrics for the following channel types are collected separately and displayed in the Workstation Investigator:

  • Datagram Channels
  • Socket Channels

NIODatagramTracing metrics

Although UDP is a connection-less protocol, the term "connection" is used in the description of NIODatagramTracing to describe how the Java Agent collects datagram metrics. The Java Agent collects metrics separately for each remote endpoint datagrams that are ‘sent to’ or ‘received from’. Connections are classified as client or server depending on the direction of the first datagram observed from each ‘to’ or ‘from’ endpoint.

For example, if the first datagram is ‘from’ the endpoint, the Java Agent classifies all further datagrams to or from that endpoint under NIO|Channels|Datagrams|Server|Port {PORT}, where {PORT} is the local port.

If the first datagram is ‘to’ the endpoint, all further datagrams to or from that endpoint are classified under NIO|Channels|Datagrams|Client|{HOST}|Port {PORT}, where {HOST} and {PORT} are the remote endpoint.

The Java Agent also generates backend metrics for client "connections", except in the case of datagrams read by the 'receive' method. Datagram channels created using DatagramChannel connect method are considered client connections irrespective of direction of first datagram observed.

Note: Datagram channels created using a UDP connection (with a connect method) are considered client connections.

Restricting Java NIO metrics

You can configure properties to control how Java NIO instrumentation works. You can also restrict generation of datagram and socket metrics. These properties only affect the detail metrics generated by NIOSocketTracing and NIODatagramTracing tracer groups.

introscope.agent.nio.datagram.client.hosts

Restricts metric reporting to 'client' UDP "connections" with specified host(s).

Values: Comma separated list of hosts.

Default: undefined (no value)

Example: introscope.agent.nio.datagram.client.hosts=hostA,hostB

Note:

  • If the list is left empty, no host restriction will apply.
  • Hosts may be specified by name or textual representation of IP address (in either IPv4 or IPv6 forms).
  • Invalid host names will be reported in the agent log and ignored.
  • This property is dynamic. You can change the configuration of this property during run time and the change will be picked up automatically.
  • Duplicate host names are discarded. In cases where multiple host names map to a single IP, only one of the names is retained. The property will, however, match client connections with any of the set of synonymous names.

introscope.agent.nio.datagram.client.ports

Lists the ports that will report NIO metrics. Only 'client' datagram metrics for specified ports will be generated.

Values: Comma separated list of port numbers. Port is the remote port to/from which datagrams are sent/received.

Default: undefined (no value)

Example: introscope.agent.nio.datagram.client.ports=123,456,789

Note:

  • If the list is empty, no port restriction will apply.
  • Invalid port numbers will be reported in the agent log and ignored.
  • This property is dynamic. You can change the configuration of this property during run time and the change will be picked up automatically.
  • Duplicate ports are discarded. In cases where multiple ports map to a single IP, only one of the ports is retained.

introscope.agent.nio.datagram.server.ports

Lists the ports that will report NIO metrics. Only 'server' datagram metrics for specified ports will be generated.

Values: Comma separated list of port numbers. Port is the local port through which datagrams are sent/received.

Default: undefined (no value)

Example: introscope.agent.nio.datagram.server.ports=123,456,789

Note:

  • If the list is empty, no port restriction will apply.
  • Invalid port numbers will be reported in the agent log and ignored.
  • This property is dynamic. You can change the configuration of this property during run time and the change will be picked up automatically.

introscope.agent.nio.socket.client.hosts

Restricts metric reporting to 'client' TCP "connections" with specified host(s).

Values: Comma separated list of hosts.

Default: undefined (no value)

Example: introscope.agent.nio.socket.client.hosts=hostA, hostB

Note:

  • If the list is empty, no host restriction will apply.
  • Hosts may be specified by name or textual representation of IP address (in either IPv4 or IPv6 forms).
  • Invalid host names will be reported in the agent log and ignored.
  • This property is dynamic. You can change the configuration of this property during run time and the change will be picked up automatically.

introscope.agent.nio.socket.client.ports

Lists the ports that will report NIO metrics. Only 'client' socket metrics for specified ports will be generated.

Values: Comma separated list of port numbers. Port is the remote port to/from which datagrams are sent/received.

Default: undefined (no value)

Example: introscope.agent.nio.socket.client.ports=123,456,789

Note:

  • If list is empty, no port restriction will apply.
  • Invalid port numbers will be reported in the agent log and ignored.
  • This property is dynamic. You can change the configuration of this property during run time and the change will be picked up automatically.

introscope.agent.nio.socket.server.ports

Lists the ports that will report NIO metrics. Only 'server' socket metrics for specified ports will be generated.

Values: Comma separated list of port numbers. Port is the local port through which datagrams are sent/received.

Default: undefined (no value)

Example: introscope.agent.nio.socket.client.ports=123,456,789

Note:

  • If list is empty, no port restriction will apply.
  • Invalid port numbers will be reported in the agent log and ignored.
  • This property is dynamic. You can change the configuration of this property during run time and the change will be picked up automatically.

Java NIO metrics appear under the NIO node under the agent's top level node in the Workstation Investigator. Additional NIO metrics for any 'client' connections will appear under the Backends node.


Individual NIO metrics may be suppressed by commenting out the TraceOneMethodIfFlagged or TraceOneMethodWithParametersIfFlagged directives for the metric(s) to be suppressed. However, no tracers whose name ends with BackendTracer or MappingTracer should be commented out.


For example, to suppress the Concurrent Readers metric for Datagrams, comment out:

TraceOneMethodWithParametersIfFlagged: NIODatagramTracing read NIODatagramConcurrentInvocationCounter "Concurrent Readers"

JMX Properties

introscope.agent.jmx.enable

Enables collection of JMX Metrics.

Values: true or false

Default: Varies by agent version

Example: introscope.agent.jmx.enable=false

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.jmx.ignore.attributes

Controls which (if any) JMX MBean attributes are to be ignored.

Values: A comma-separated list of keywords.

Default: Commented out; server

Example: introscope.agent.jmx.ignore.attributes=server

Note:

  • If an MBean attribute name matches one on the list, the attribute will be ignored.
  • Leave the list empty to include all MBean attributes.
  • You must restart the managed application before changes to this property take effect.

introscope.agent.jmx.name.filter

Specifies a comma-separated list of filter strings to determine what JMX data Introscope collects and displays.

Introscope reports JMX-generated metrics that match a filter string. Filter strings can contain the asterisk (*) and question mark (?) wildcard characters:

  • * matches zero or more characters
  • ? matches a single character

To match a literal * or ?, escape the character with \\.

Examples:

  • ab\\*c matches a metric name that contains ab*c
  • ab*c matches a metric name that contains abc, abxc, abxxc etc.
  • ab?c matches a metric name that contains abxc
  • ab\\?c matches a metric names that contains ab?c

Default: commented out

For WebLogic:

ActiveConnectionsCurrentCount,WaitingForConnectionCurrentCount,PendingRequestCurrentCount,ExecuteThreadCurrentIdleCount,OpenSessionsCurrentCount,j2eeType


Example:

#introscope.agent.jmx.name.filter=ActiveConnectionsCurrentCount,WaitingForConnectionCurrentCount,PendingRequestCurrentCount,ExecuteThreadCurrentIdleCount,OpenSessionsCurrentCount,j2eeType

Note:

  • Leave empty to include all MBean data available in the system.
  • You must restart the managed application before changes to this property take effect.

introscope.agent.jmx.name.jsr77.disable

Controls whether or not Introscope collects and reports full JSR77 data, including complex JMX data.

This property is only available for use in the WebLogic and WebSphere IntroscopeAgent.profile files.

Values: true or false

Default: true

Note:

  • JSR-77 Management support must be provided by the application server in order for this property to have any effect.
  • You must restart the managed application before changes to this property take effect.

introscope.agent.jmx.name.primarykeys

Specifies user-defined order of MBean information, and simplifies name conversion.

Values: A comma-separated, ordered list of keys which should uniquely identify a particular MBean.

Default: commented out in default IntroscopeAgent.profile file

Example: introscope.agent.jmx.name.primarykeys=J2EEServer

Note:

  • Property settings for WebLogic:
    • Type
    • Name
  • Comment out this property if using WebLogic Server 9.0 (minimum).
  • Property settings for WebSphere:
    • J2EEServer
    • Application
    • j2eeType
    • JDBCProvider
    • name
    • mbeanIdentifier
  • You must restart the managed application before changes to this property take effect.

introscope.agent.jmx.excludeStringMetrics

Controls whether or not to include string-valued metrics. To enable string-valued metrics, set this property value to false.

Values: true or false

Default: true

Example: introscope.agent.jmx.excludeStringMetrics=true

Note:

  • Excluding string-valued metrics reduces the overall metric count, improving agent and EM performance.
  • You must restart the managed application before changes to this property take effect.

introcope.agent.jmx.syncWithAllMbeanServersForcibly

Controls ability for agent to poll for all Mbeans in all Mbean servers. When set to true, agent polls for all Mbeans in all Mbean servers.

Values: true or false

Default: false

Example: introcope.agent.jmx.syncWithAllMbeanServersForcibly=true

Note:

  • This property is dynamic. You can change the configuration of this property during run time and the change will be picked up automatically

Logging Properties

log4j.logger.IntroscopeAgent

Specifies both the logging level and the output location for log information.

Values:

Level of detail value can be:

  • INFO
  • VERBOSE#com.wily.util.feedback.Log4JSeverityLevel

Destination value can be:

  • console
  • logfile
  • both console and logfile

Default: INFO, logfile

Example: log4j.logger.IntroscopeAgent=INFO, logfile

To disable agent logging, remove the options from this property as follows:

log4j.logger.IntroscopeAgent=

Note: Changes to this property take effect immediately and do not require a restart of the managed application.

log4j.appender.logfile.File

Specifies the name and location of IntroscopeAgent.log file if logfile is specified in log4j.logger.IntroscopeAgent property. The filename is relative to the directory that contains the agent profile.

Default: IntroscopeAgent.log

Example: log4j.appender.logfile.File=../../logs/IntroscopeAgent.log

Notes: System properties (Java command line -D options) are expanded as part of the file name. For example, if Java is started with -Dmy.property=Server1, then log4j.appender.logfile.File=../../logs/Introscope-${my.property}.log is expanded to: log4j.appender.logfile.File=../../logs/Introscope-Server1.log.

log4j.logger.IntroscopeAgent.inheritance

Specifies log level and destination for log messages about classes that require instrumentation.

Values: To configure logging of classes that have not been instrumented because they extend a supertype or interface, set this property to: INFO, pbdlog

Default: None

Example: log4j.logger.IntroscopeAgent.inheritance=INFO,pbdlog

log4j.appender.pbdlog.File

Specifies a log file for messages about classes that require instrumentation.

Values: To configure logging of classes that have not been instrumented because they extend a supertype or interface set to: pbdupdate.log

Default: None

Example: log4j.appender.pbdlog.File=../../pbdupdate.log

log4j.appender.pbdlog

Specifies a package for logging messages about classes that require instrumentation.

Values: To configure logging of classes that have not been instrumented because they extend a supertype or interface, set this property to: com.wily.introscope.agent.AutoNamingRollingFileAppender

Default: None

Example: log4j.appender.pbdlog=com.wily.introscope.agent.AutoNamingRollingFileAppender

log4j.appender.pbdlog.layout

Specifies rules for logging messages about classes that require instrumentation.

Values: To configure logging of classes that have not been instrumented because they extend a supertype or interface, set this property to: com.wily.org.apache.log4j.PatternLayout

Default: None

Example: log4j.appender.pbdlog.layout=com.wily.org.apache.log4j.PatternLayout

log4j.appender.pbdlog.layout.ConversionPattern

Specifies rules for logging messages about classes that require instrumentation.

Values: To configure logging of classes that have not been instrumented because they extend a supertype or interface, set this property to:

%d{M/dd/yy hh:mm:ss a z} [%-3p] [%c] %m%n

Default: None

Example: log4j.appender.pbdlog.layout.ConversionPattern=%d{M/dd/yy hh:mm:ss a z} [%-3p] [%c] %m%n

log4j.additivity.IntroscopeAgent.inheritance

Specifies if the directives for multiple level inheritance must be logged only in the pbdupdate.log file.

To configure the logging of multiple level inheritance directives in the pbdupdate.log only, add this property to the agent profile and set to false.

Values: true or false

Default: true

Example: log4j.additivity.IntroscopeAgent.inheritance=true

Metric Count Property

introscope.ext.agent.metric.count

Controls where you will see the Metric Count metric in the Investigator. By default, the Metric Count is displayed as under the Custom Metric Agent node. If you want to see the Metric Count metric under the Agent Stats node, add this property to the IntroscopeAgent.profile.

Values: true or false

Default: not present in the IntroscopeAgent.profile; false

Example: introscope.ext.agent.metric.count=true

Multiple Inheritance Properties

introscope.autoprobe.hierarchysupport.enabled

Enables instrumentation of classes that extend a supertype or interface.

Values: true or false

Default: true

Example: introscope.autoprobe.hierarchysupport.enabled=true

Note:

  • Valid for agents that run on JDK 1.5 at a minimum using AutoProbe and dynamic ProbeBuilding.
  • You must restart the managed application before changes to this property take effect.

introscope.autoprobe.hierarchysupport.runOnceOnly

Controls whether the utility that enables the feature runs only once or at a specified interval, when you have enabled instrumentation of classes that extend a supertype or interface.

Change this property to true only if you need detection on a periodic basis.

Values: true or false

Default: false

Example: introscope.autoprobe.hierarchysupport.runOnceOnly=false

Note: You must restart the managed application before changes to this property take effect.

introscope.autoprobe.hierarchysupport.pollIntervalMinutes

Specifies the polling interval to check for classes which could not be instrumented due to multiple inheritance. In most cases this happens only once; however, a conservative value is recommended to account for application server initialization.

Default: 5

Example: introscope.autoprobe.hierarchysupport.pollIntervalMinutes=5

Note: You must restart the managed application before changes to this property take effect.

introscope.autoprobe.hierarchysupport.executionCount

Specifies the exact number of times the polling interval is run, if you need the polling interval to run a finite times instead of running it only once or running it periodically.

Using this property overrides the run once only setting.

Values: A positive integer

Default: 3

Example: introscope.autoprobe.hierarchysupport.executionCount=3

Note: You must restart the managed application before changes to this property take effect.

introscope.autoprobe.hierarchysupport.disableLogging

Specifies if the classes being detected must be logged or not. Only uncomment this property if dynamic instrumentation is enabled.

Values: true or false

Default: true

Example: #introscope.autoprobe.hierarchysupport.disableLogging=true

Note: You must restart the managed application before changes to this property take effect.

introscope.autoprobe.hierarchysupport.disableDirectivesChange

Specifies to log the changes and disable the triggering of dynamic instrumentation.

Values: true or false

Default: true

Example: introscope.autoprobe.hierarchysupport.disableDirectivesChange=true

Note: You must restart the managed application before changes to this property take effect.

Platform Monitoring Property

introscope.agent.platform.monitor.system

Specifies name of operating system to load a platform monitor for.

Default: Commented out; varies by platform.

Example: introscope.agent.platform.monitor.system=LinuxIntelAmd64

Note: Restart the managed application before changes to this property take effect.

Remote Configuration Properties

The properties in this section allow remote configuration of the Java Agent.

introscope.agent.remoteagentconfiguration.enabled

This property enables or disables remote configuration of the agent.

Property settings

True or False

Default

True

Example

introscope.agent.remoteagentconfiguration.enabled=true

Notes

Changes to this property take effect immediately and do not require the managed application to be restarted.

introscope.agent.remoteagentconfiguration.allowedFiles

This property lists the exact list of files that are allowed to be remotely transferred to this agent.

Property settings

domainconfig.xml

Default

domainconfig.xml

Example

introscope.agent.remoteagentconfiguration.allowedFiles=domainconfig.xml

Notes

Changes to this property take effect immediately and do not require the managed application to be restarted.

Security Property

The property in this section configures security of HTTP headers being sent to CA CEM:

introscope.agent.decorator.security

This property determines the format of decorated HTTP response headers, which are sent to CA CEM.

Property settings

clear: clear text encoding

encrypted: header data is encrypted

Default

encrypted

Example

introscope.agent.decorator.security=encrypted

Servlet Header Decorator Property

The property in this section enables correlation of transactions between CA CEM and Introscope

introscope.agent.decorator.enabled

Specifies if the agent must add additional performance monitoring information to HTTP response headers. ServletHeaderDecorator attaches the GUID to each transaction and inserts the GUID into an HTTP header, for example: x-wily-info.

If the value is true, then additional information is included.

Values: true or false

Default: false

Example: introscope.agent.decorator.enabled=false

Socket Metrics Properties

Generation of I/O Socket metrics may be restricted by the properties in this section.

com.wily.introscope.agent.sockets.clamp.level

Specifies the total number of sockets that the agent monitors. The list of sockets depends upon a unique combination [port]:[<host>|<ip>].

Default: 100

Example: com.wily.introscope.agent.sockets.clamp.level=100

  • Restart the managed application before changes to this property take effect.
  • If the client and server socket are on the same JVM, they are counted as two sockets for the clamp.
  • Increasing the value of the default setting causes significant memory overhead.
  • For optimal performance, the summary metric for NIO Datagram Concurrent Readers is not clamped.

introscope.agent.sockets.reportRateMetrics

Enables reporting of individual socket's input/output (I/O) bandwidth rate metrics.

Values: true or false

Default: false

Example: introscope.agent.sockets.reportRateMetrics=false

Note:

  • Only functions if ManagedSocketTracing is enabled and SocketTracing is disabled. See Backwards compatibility for more information.
  • You must restart the managed application before changes to this property take effect.

introscope.agent.io.socket.client.hosts

Restricts socket client connections instrumented to those with specified remote hosts.

Values: A comma-separate list of values.

Example: introscope.agent.io.socket.client.hosts=

Note:

  • If any individual value is invalid, it will be ignored.
  • If any parameter is not defined, or after exclusion of any invalid values is an empty list, no restriction will apply to that parameter.
  • This property is dynamic. You can change the configuration of this property during run time and the change will be picked up automatically.

introscope.agent.io.socket.client.ports

Restricts socket client connections instrumented to those with specified remote ports

Values: A comma-separate list of values.

Example: introscope.agent.io.socket.client.ports=

Note:

  • If any individual value is invalid, it will be ignored.
  • If any parameter is not defined, or after exclusion of any invalid values is an empty list, no restriction will apply to that parameter.
  • This property is dynamic. You can change the configuration of this property during run time and the change will be picked up automatically.

introscope.agent.io.socket.server.ports

Restricts socket client connections instrumented to those using specified local ports.

Values: A comma-separate list of values.

Example: introscope.agent.io.socket.server.ports=

Note:

  • If any individual value is invalid, it will be ignored.
  • If any parameter is not defined, or after exclusion of any invalid values is an empty list, no restriction will apply to that parameter.
  • This property is dynamic. You can change the configuration of this property during run time and the change will be picked up automatically.

SQL Agent Properties

You can configure aspects of the SQL Agent.

introscope.agent.sqlagent.normalizer.extension

Specifies the name of the SQL normalizer extension that is used to override the preconfigured normalization scheme.

To make custom normalization extension work, the value of its manifest attribute com-wily-Extension-Plugin-{pluginName}-Name must match the value given in this property.

If you specify a comma-separated list of names, the Agent uses the default normalizer extension.

For example, with the following setting RegexSqlNormalizer is used for normalization:

introscope.agent.sqlagent.normalizer.extension=RegexSqlNormalizer

This property limits how much of a SQL statement appears in the Investigator tree for SQL Agent metrics, in bytes.

Values: The name of the SQL normalizer extension that is used to override the preconfigured normalization scheme.

Default: RegexSqlNormalizer

Example: introscope.agent.sqlagent.normalizer.extension=RegexSqlNormalizer

Note:

  • If you use the default setting, you also must configure the regular expressions SQL statement normalizer properties:
    • introscope.agent.sqlagent.normalizer.regex.matchFallThrough
    • introscope.agent.sqlagent.normalizer.regex.keys
    • introscope.agent.sqlagent.normalizer.regex.key1.pattern
    • introscope.agent.sqlagent.normalizer.regex.key1.replaceAll
    • introscope.agent.sqlagent.normalizer.regex.key1.replaceFormat
    • introscope.agent.sqlagent.normalizer.regex.key1.caseSensitive
  • Changes to this property take effect immediately and do not require that you restart the managed application.

introscope.agent.sqlagent.normalizer.regex.matchFallThrough

Sets the regular expressions SQL statement normalizer in conjunction with introscope.agent.sqlagent.normalizer.extension property. When this property is set to true, it will evaluate SQL strings against all regex key groups.

The implementation is chained. For example, if SQL matches multiple key groups, the normalized SQL output from group1 is fed as input to group2, and so on.

If the property is set to false, as soon as a key group matches, the normalized SQL output from that group is returned.

Values: true or false

Default: false

Example: introscope.agent.sqlagent.normalizer.regex.matchFallThrough=false

Note: Changes to this property take effect immediately and do not require the managed application to be restarted.

introscope.agent.sqlagent.normalizer.regex.keys

Sets the regular expressions SQL statement normalizer in conjunction with introscope.agent.sqlagent.normalizer.extension property. This property specifies the regex group keys. They are evaluated in order.

Default: key1

Example: introscope.agent.sqlagent.normalizer.regex.keys=key1

Note: Changes to this property take effect immediately and do not require the managed application to be restarted.

introscope.agent.sqlagent.normalizer.regex.key1.pattern

Sets the regular expressions SQL statement normalizer in conjunction with introscope.agent.sqlagent.normalizer.extension property. This property specifies the regex pattern that will be used to match against the SQL.

Values: All valid regex entries allowed by java.util.Regex package can be used here.

Default: .*call(.*\)\.FOO(.*\)

Example: introscope.agent.sqlagent.normalizer.regex.key1.pattern=.*call(.*\)\.FOO(.*\)

Note: Changes to this property take effect immediately and do not require the managed application to be restarted.

introscope.agent.sqlagent.normalizer.regex.key1.replaceAll

Sets the regular expressions SQL statement normalizer in conjunction with introscope.agent.sqlagent.normalizer.extension property. When this property is set to false, it will replace the first occurrence of the matching pattern in the SQL query with the replacement string. If set to true, it will replace all occurrences of the matching pattern in the SQL query with replacement the string.

Values: true or false

Default: false

Example: introscope.agent.sqlagent.normalizer.regex.key1.replaceAll=false

Note: Changes to this property take effect immediately and do not require the managed application to be restarted.

introscope.agent.sqlagent.normalizer.regex.key1.replaceFormat

Sets the regular expressions SQL statement normalizer in conjunction with introscope.agent.sqlagent.normalizer.extension property. This property specifies the replacement string format.

Values: All valid regex entries allowed by the java.util.Regex package and java.util.regex.Matcher class can be used here.

Default: $1

Example: introscope.agent.sqlagent.normalizer.regex.key1.replaceFormat=$1

Note: Changes to this property take effect immediately and do not require the managed application to be restarted.

introscope.agent.sqlagent.normalizer.regex.key1.caseSensitive

Sets the regular expressions SQL statement normalizer in conjunction with introscope.agent.sqlagent.normalizer.extension property. This property specifies whether the pattern match is sensitive to case.

Values: true or false

Default: false

Example: introscope.agent.sqlagent.normalizer.regex.key1.caseSensitive=false

Note: Changes to this property take effect immediately and do not require the managed application to be restarted.

introscope.agent.sqlagent.sql.artonly

Specifies if the agent must create and send only the Average Response Time metric. All SQL agent metrics under back-ends are affected. When the value for this property is true, performance of the agent for SQL metrics and transaction traces can improve.

Setting introscope.agent.sqlagent.sql.turnoffmetrics to true overrides this property.

Default: false

Note:

  • This property does not control custom metrics.
  • You must restart the managed application before changes to these properties take effect.
  • The following tracer parameter must be set for this property setting to work:

    SetTracerParameter: StatementToConnectionMappingTracer agentcomponent "SQL Agent"

introscope.agent.sqlagent.sql.rawsql

Specifies if the agent must add unnormalized SQL as a parameter for SQL components in Transaction Trace. When the value for this property is true, performance of the agent for SQL metrics and transaction traces can improve.

Default:false

Note:

  • Changes to this property take effect after you restart the managed application.
  • Enabling this property can result in passwords and sensitive information being presented in Transaction Trace.

introscope.agent.sqlagent.sql.turnoffmetrics

Specifies that the SQL statement metrics can be turned off to send fewer metrics from the agent to the Enterprise Manager. When the value for this property is true, performance of the agent for SQL metrics and transaction traces can improve.

Default: false

Note:

  • This property overrides the introscope.agent.sqlagent.sql.artonly property.
  • You must restart the managed application before changes to these properties take effect.
  • The following tracer parameter must be set for this property setting to work:

    SetTracerParameter: StatementToConnectionMappingTracer agentcomponent "SQL Agent"

introscope.agent.sqlagent.sql.turnofftrace

Controls whether the agent creates and sends transaction trace components to the Enterprise Manager for SQL statements under back-ends. When the value for this property is true, performance of the agent for SQL metrics and transaction traces can improve.

Default: false

Note:

  • You must restart the managed application before changes to these properties take effect.
  • The following tracer parameter must be set for this property setting to work:

    SetTracerParameter: StatementToConnectionMappingTracer agentcomponent "SQL Agent"

SSL Communication Properties

The agent can connect to the Enterprise Manager over SSL. Use the properties in this section to configure that communication.

introscope.agent.enterprisemanager.transport.tcp.host.DEFAULT

Specifies the host name of the computer running the Enterprise Manager that the agent connects to by default.

Default: localhost

Example: introscope.agent.enterprisemanager.transport.tcp.host.DEFAULT=localhost

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.enterprisemanager.transport.tcp.port.DEFAULT

Specifies the port number on the computer that hosts the Enterprise Manager that listens for connections from the agent. If you are using Secure Socket Layer (SSL) protocol, the default port that listens for connections from the agent is 5443.

Default

5443

Example

introscope.agent.enterprisemanager.transport.tcp.port.DEFAULT=5443

Notes

You must restart the managed application before changes to this property take effect.

introscope.agent.enterprisemanager.transport.tcp.socketfactory.DEFAULT

Specifies the client socket factory to use for connections from the agent to the Enterprise Manager when using SSL.

Default

com.wily.isengard.postofficehub.link.net.SSLSocketFactory

Example

introscope.agent.enterprisemanager.transport.tcp.socketfactory.DEFAULT=com.wily.isengard.postofficehub.link.net.SSLSocketFactory

Notes

You must restart the managed application before changes to this property take effect.

introscope.agent.enterprisemanager.transport.tcp.truststore.DEFAULT

Location of a truststore containing trusted Enterprise Manager certificates. If no truststore is specified, the agent trusts all certificates.

Property settings

Either an absolute path or a path relative to the agent's working directory.

Example

introscope.agent.enterprisemanager.transport.tcp.truststore.DEFAULT=/var/trustedcerts

Notes

On Windows, backslashes must be escaped. For example: C:\\keystore

introscope.agent.enterprisemanager.transport.tcp.trustpassword.DEFAULT

The password for the truststore.

Example

introscope.agent.enterprisemanager.transport.tcp.trustpassword.DEFAULT=

introscope.agent.enterprisemanager.transport.tcp.keystore.DEFAULT

Location of a keystore containing the agent's certificate. A keystore is needed if the Enterprise Manager requires client authentication.

Property settings

Either an absolute path or a path relative to the agent's working directory.

Example

introscope.agent.enterprisemanager.transport.tcp.keystore.DEFAULT=c:\\keystore

Notes

On Windows, backslashes must be escaped. For example: C:\\keystore

introscope.agent.enterprisemanager.transport.tcp.keypassword.DEFAULT

The password for the keystore.

Example

introscope.agent.enterprisemanager.transport.tcp.keypassword.DEFAULT=MyPassword768

introscope.agent.enterprisemanager.transport.tcp.ciphersuites.DEFAULT

Set the enabled cipher suites.

Property settings

A comma-separated list of cipher suites.

Example

introscope.agent.enterprisemanager.transport.tcp. ciphersuites.DEFAULT=SSL_DH_anon_WITH_RC4_128_MD5

Notes

If not specified, use the default enabled cipher suites.

Stall Metrics Properties

introscope.agent.stalls.thresholdseconds

Specifies the number of seconds that an executing process can take before it is considered a stalled process. To ensure an accurate Stall Count metric, set the stall threshold to 15 seconds or more. This setting allows time for the Enterprise Manager to complete its harvest cycle.

Default: 30 seconds

Example: introscope.agent.stalls.thresholdseconds=30

Note: This property is dynamic. You can change the configuration of this property during run time and the change is picked up automatically.

introscope.agent.stalls.resolutionseconds

Specifies the frequency that the agent checks for stalls. To ensure an accurate Stall Count metric, do not set the stall resolution to less than 10 seconds. This setting allows time for the Enterprise Manager to complete its harvest cycle.

Default: 10 seconds

Example: introscope.agent.stalls.resolutionseconds=10

Note: This property is dynamic. You can change the configuration of this property during run time and the change is picked up automatically.

Thread Dump Properties

The Thread Dump properties enable and configure agent aspects of Introscope thread dump functionality.

introscope.agent.threaddump.enable

Enables thread dumps to be collected on an agent JVM and allows users to view the Thread Dumps tab.

Values: true or false

Default: true

Example: introscope.agent.threaddump.enable=true

Note:

  • Changes to this property take effect immediately and do not require you to restart the managed application.
  • This property works together with the IntroscopeEnterpriseManager.properties file introscope.enterprisemanager.threaddump.enable property, which enables the Enterprise Manager thread dump functionality if this property is set to true.

introscope.agent.threaddump.deadlockpoller.enable

Enables the Deadlock Count metric in the metric browser tree to display the current number of deadlocks in the agent JVM.

Values: true or false

Default: true

Example: introscope.agent.threaddump.deadlockpoller.enable=true

Note: Changes to this property take effect immediately and do not require you to restart the managed application.

introscope.agent.threaddump.deadlockpollerinterval

Specifies the frequency in milliseconds at which Introscope polls the agent JVM for deadlocked threads

Values: Integer greater than 0

Default: 15000 (milliseconds)

Example: introscope.agent.threaddump.deadlockpollerinterval=15000

Note: Restart the managed application so changes to this property can take effect.

introscope.agent.threaddump.MaxStackElements

Specifies the total number of lines allowed in the thread stack. This value determines the size of a Introscope thread dump.

Values: Integer greater than 0 and no greater than 25000

Default: 12000

Example: introscope.agent.threaddump.MaxStackElements=12000

Note: Restart the managed application so that changes to this property can take effect.

Transaction Tracing Properties

The properties in this section are for transaction tracing and sampling.

introscope.agent.bizdef.turnOff.nonIdentifying.txn

Enable or disable tracing of nonidentifying transactions.

Traces for nonidentifying transactions are generated when this property is set to false in IntroscopeAgent.profile.

By default traces for nonidentifying transactions are not generated even if the feature is enabled in the CEM UI.

Values: true or false

Default: true

Example: introscope.agent.bizdef.turnOff.nonIdentifying.txn=false

introscope.agent.transactiontracer.parameter.httprequest.headers

Specifies (in comma-separated list) HTTP request header data to capture. Use a comma separated list.

Default: commented out; User-Agent

Example: introscope.agent.transactiontracer.parameter.httprequest.headers=User-Agent

introscope.agent.transactiontracer.parameter.httprequest.parameters

Specifies (in comma-separated list) HTTP request parameter data to capture.

Default: commented out; generic parameters.

Example: introscope.agent.transactiontracer.parameter.httprequest.parameters=parameter1,parameter2

introscope.agent.transactiontracer.parameter.httpsession.attributes

Specifies (in comma-separated list) HTTP session attribute data to capture.

Default: commented out; generic parameters.

Example:

introscope.agent.transactiontracer.parameter.httpsession.attributes=attribute1,attribute2

introscope.agent.transactiontracer.userid.key

Specifies the User-defined key string.

Default: commented out; generic parameters.

Example: #introscope.agent.transactiontracer.parameter.httpsession.attributes=attribute1,attribute2

Note: Optionally supply the values, if in your environment, user IDs are accessed using HttpServletRequest.getHeader or HttpServletRequest.getValue.

introscope.agent.transactiontracer.userid.method

Specifies the method that returns User IDs.

Values:

  • HttpServletRequest.getRemoteUser
  • HttpServletRequest.getHeader
  • HttpServletRequest.getValue

Default: commented out

Example:

The IntroscopeAgent.profile includes a commented out property definition for each of the three allowable values. You can uncomment the property you want to use.

introscope.agent.transactiontracer.userid.method=HttpServletRequest.getRemoteUser

#introscope.agent.transactiontracer.userid.method=HttpServletRequest.getHeader

#introscope.agent.transactiontracer.userid.method=HttpSession.getValue

introscope.agent.transactiontrace.componentCountClamp

Limits the number of components allowed in a Transaction Trace.

Default: 5000

Important! If the clamp size is increased, the requirements on memory are higher. In extreme cases, the maximum heap size for the agent may need to be adjusted or the managed application could run out of memory.

Example: introscope.agent.transactiontrace.componentCountClamp=5000

Note:

  • Any Transaction Trace exceeding the clamp is discarded at the agent and a warning message is logged in the agent log file.
  • This property is dynamic. You can change the configuration of this property during run time and the change will be picked up automatically.
  • When the set limit is reached, warnings appear in the log, and the trace stops.
  • Zero is not a valid value. Do not set introscope.agent.transactiontrace.componentCountClamp=0.

introscope.agent.crossprocess.compression

Reduces the size of cross process transaction tracing data.

Values: lzma, gzip, none

Default: lzma

Example: introscope.agent.crossprocess.compression=lzma

Note:

  • This option will increase agent CPU overhead, but reduce the size of interprocess headers.
  • lzma compression is more efficient than gzip, but may use more CPU.
  • .NET agents do not support the gzip option, so if interoperability is required, do not use gzip.
  • This property is dynamic. You can change the configuration of this property during run time and the change will be picked up automatically.

introscope.agent.crossprocess.compression.minlimit

Specifies the minimum length of cross process parameter data length for which to apply compression.

Values: 0 to twice the total maximum limit, set in the introscope.agent.crossprocess.correlationid.maxlimit.

If set below the default of 1500, the compression will run more frequently and consume more CPU overhead. The default setting of 1500 usually results in no impact to CPU overhead in normal conditions.

Default: 1500

Example: introscope.agent.crossprocess.compression.minlimit=1500

Note:

  • Used with the introscope.agent.crossprocess.compression property.
  • This property is dynamic. You can change the configuration of this property during run time and the change will be picked up automatically.

introscope.agent.crossprocess.correlationid.maxlimit

Specifies the maximum size of cross process parameter data allowed.

If the total size of cross process parameter data is more than this limit, even after applying compression, some data will be dropped and some cross process correlation functionality will not work properly.

However, this setting will protect user transactions from failing in network transmission due to too large header size.

Default: 4096

Example: introscope.agent.crossprocess.correlationid.maxlimit=4096

Note:

  • Used with the introscope.agent.crossprocess.compression and introscope.agent.crossprocess.compression.minlimit properties.
  • This property is dynamic. You can change the configuration of this property during run time and the change will be picked up automatically.

introscope.agent.transactiontracer.sampling.enabled

Enables or disables Transaction Tracer Sampling.

Note: Transaction tracer sampling cannot be disabled through the Enterprise Manager properties file.

Values: true or false

Default: true

Example: introscope.agent.transactiontracer.sampling.enabled=false

Note: Changes to this property take effect immediately and do not require the managed application to be restarted.

introscope.agent.transactiontracer.sampling.perinterval.count

Specifies the number of transactions to trace, during the interval you specify.

Disables the introscope.agent.transactiontracer.sampling.perinterval.count configuration in the Enterprise Manager if this property is configured in the agent.

Default: 1

Example: introscope.agent.transactiontracer.sampling.perinterval.count=1

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.transactiontracer.sampling.interval.seconds

Specifies the length of time to trace the number of transactions you specify.

Disables the introscope.agent.transactiontracer.sampling.interval.seconds configuration in the Enterprise Manager if this property is configured in the agent.

Default: 120

Example: introscope.agent.transactiontracer.sampling.interval.seconds=120

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.transactiontrace.headFilterClamp

Specifies the maximum depth of components allowed in head filtering. Head filtering is the process of examining the start of a transaction for the purpose of potentially collecting the entire transaction. Head filtering checks each component until the first blamed component exits. For transaction with very deep call stacks, this can be a problem if no clamping is applied. The clamp value limits the memory and CPU utilization impact of this behavior by forcing the agent to only look up to a fixed depth.

Default: 30

Important! If the clamp size is increased, the requirement on memory is higher. Garbage collection behavior will be affected, which will have an application-wide performance impact.

Example: introscope.agent.transactiontrace.headFilterClamp=30

Note:

  • Changes to this property take effect immediately and do not require the managed application to be restarted.
  • Any Transaction Trace whose depth exceeds the clamp will no longer be examined for possible collection unless some other mechanism, such as sampling or user-initiated transaction tracing, is active to select the transaction for collection.

introscope.agent.ttClamp

Limits the number of transactions that are reported by the agent per reporting cycle.

Values: integers.

Default: 50

Example: introscope.agent.ttClamp=50

Note:

  • You must restart the managed application before changes to this property take effect.
  • If the property is not set (left blank), the value defaults to 200.

introscope.agent.weblogic.crossjvm

Configures cross-process tracing in WebLogic Server:

Values: true or false

Default: commented out; true

Example: introscope.agent.weblogic.crossjvm=true

introscope.agent.transactiontracer.tailfilterPropagate.enable

Controls whether the presence of a tail filter triggers automatic collection of traces from downstream agents or not. This property does not affect collection of automatic downstream traces due to passing of head filters. Enabling this property and running long periods of Transaction Trace session with tail filters can cause large numbers of unwanted traces to be sent to the Enterprise Manager.

Values: true or false

Default: true

Example: introscope.agent.transactiontracer.tailfilterPropagate.enable=false

Note: Restart the managed application for the changes to this property to take effect.

URL Group Properties

The properties in this section are for configuring URL Groups for frontend metrics.

introscope.agent.urlgroup.keys

Specifies configuration settings for Frontend naming.

Default: default

Example: introscope.agent.urlgroup.keys=default

introscope.agent.urlgroup.group.default.pathprefix

Specifies configuration settings for frontend naming.

Default: *

Example: introscope.agent.urlgroup.group.default.pathprefix=*

introscope.agent.urlgroup.group.default.format

Specifies configuration settings for Frontend naming.

Default: default

Example: introscope.agent.urlgroup.group.default.format=default

WebSphere PMI Properties

introscope.agent.pmi.enable

Enables collection of data from WebSphere PMI.

Values: true or false

Default: true

Example: introscope.agent.pmi.enable=true

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.pmi.enable.alarmManagerModule

Enables collection of PMI alarm manager data when set to true.

Values: true or false

Default: false

Example: introscope.agent.pmi.enable.alarmManagerModule=false

Note:

  • The alarm manager data category must be turned on in WebSphere to be visible as Introscope data.
  • You must restart the managed application before changes to this property take effect.

introscope.agent.pmi.enable.beanModule

Enables collection of PMI bean data.

Values: true or false

Default: false

Example: introscope.agent.pmi.enable.beanModule=false

introscope.agent.pmi.enable.cacheModule

Enables collection of PMI cache data when set to true.

Values: true or false

Default: false

Example: introscope.agent.pmi.enable.cacheModule=false

Note:

  • The cache data category must be turned on in WebSphere to be visible as Introscope data.
  • You must restart the managed application before changes to this property take effect.

introscope.agent.pmi.enable.connectionPoolModule

Enables collection of PMI connectionPool data.

Values: true or false

Default: true

Example: introscope.agent.pmi.enable.connectionPoolModule=true

introscope.agent.pmi.enable.hamanagerModule

Enables collection of PMI manager data when set to true.

Values: true or false

Default: false

Example: introscope.agent.pmi.enable.hamanagerModule=false

Note:

  • The manager data category must be turned on in WebSphere to be visible as Introscope data.
  • You must restart the managed application before changes to this property take effect.

introscope.agent.pmi.enable.j2cModule

Enables collection of PMI J2C data when set to true.

Values: true or false

Default: true

Example: introscope.agent.pmi.enable.j2cModule=true

Note:

  • The J2C data category must be turned on in WebSphere to be visible as Introscope data.
  • You must restart the managed application before changes to this property take effect.

introscope.agent.pmi.enable.jvmpiModule

Enables collection of PMI JVM PI data.

Values: true or false

Default: false

Example: introscope.agent.pmi.enable.jvmpiModule=false

Note: For data to be provided to this module, JVMPI must be turned on in WebSphere.

introscope.agent.pmi.enable.jvmRuntimeModule

Enables collection of PMI JVM runtime data.

Values: true or false

Default: false

Example: introscope.agent.pmi.enable.jvmRuntimeModule=false

Note:

  • For data to be provided to this module, JVMPI must be turned on in WebSphere.
  • You must restart the managed application before changes to this property take effect.

introscope.agent.pmi.enable.objectPoolModule

Enables collection of PMI object pool data when set to true.

Values: true or false

Default: false

Example: introscope.agent.pmi.enable.objectPoolModule=false

Note:

  • The object pool data category must be turned on in WebSphere to be visible as Introscope data.
  • You must restart the managed application before changes to this property take effect.

introscope.agent.pmi.enable.orbPerfModule

Enables collection of PMI orbPerf data when set to true.

Values: true or false

Default: false

Example: introscope.agent.pmi.enable.orbPerfModule=false

Note:

  • The orbPerf data category must be turned on in WebSphere to be visible as Introscope data.
  • You must restart the managed application before changes to this property take effect.

introscope.agent.pmi.enable.schedulerModule

Enables collection of PMI scheduler data when set to true.

Values: true or false

Default: false

Example: introscope.agent.pmi.enable.schedulerModule=false

Note:

  • The scheduler data category must be turned on in WebSphere to be visible as Introscope data.
  • You must restart the managed application before changes to this property take effect.

introscope.agent.pmi.enable.servletSessionsModule

Enables collection of PMI servletSessions data.

Values: true or false

Default: true

Example: introscope.agent.pmi.enable.servletSessionsModule=true

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.pmi.enable.systemModule

Enables collection of PMI system data when set to true.

Values: true or false

Default: false

Example: introscope.agent.pmi.enable.systemModule=false

Note:

  • The system data category must be turned on in WebSphere to be visible as Introscope data.
  • You must restart the managed application before changes to this property take effect.

introscope.agent.pmi.enable.threadPoolModule

Enables collection of PMI thread pool data when set to true.

Values: true or false

Default: true

Example: introscope.agent.pmi.enable.threadPoolModule=true

Note:

  • The thread pool data category must be turned on in WebSphere to be visible as Introscope data.
  • You must restart the managed application before changes to this property take effect.

introscope.agent.pmi.enable.transactionModule

Enables collection of PMI transaction data.

Values: true or false

Default: false

Example: introscope.agent.pmi.enable.transactionModule=false

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.pmi.enable.webAppModule

Enables collection of PMI webApp data.

Values: true or false

Default: false

Example: introscope.agent.pmi.enable.webAppModule=false

Note: You must restart the managed application before changes to this property take effect.

introscope.agent.pmi.enable.webServicesModule

Enables collection of PMI web services data when set to true.

Values: true or false

Default: false

Example: introscope.agent.pmi.enable.webServicesModule=false

Note:

  • The web services data category must be turned on in WebSphere to be visible as Introscope data.
  • You must restart the managed application before changes to this property take effect.

introscope.agent.pmi.enable.wlmModule

Enables collection of PMI WLM data when set to true.

Values: true or false

Default: false

Example: introscope.agent.pmi.enable.wlmModule=false

Note:

  • The WLM data category must be turned on in WebSphere to be visible as Introscope data.
  • You must restart the managed application before changes to this property take effect.

introscope.agent.pmi.enable.wsgwModule

Enables collection of PMI WSGW data when set to true.

Values: true or false

Default: false

Example: introscope.agent.pmi.enable.wsgwModule=false

Note:

  • The WSGW data category must be turned on in WebSphere to be visible as Introscope data.
  • You must restart the managed application before changes to this property take effect.

introscope.agent.pmi.filter.objrefModule

Controls for hard-coded filters.

The objref filter filters out names ending with "@xxxxx" where "xxxxx" is a numeric string.

Values: true or false

Default: false

Example: introscope.agent.pmi.filter.objrefModule=false

Note: You must restart the managed application before changes to this property take effect

WLDF Metrics Property

introscope.agent.wldf.enable

Enables the collection of WLDF metrics.

Values: true or false

Default: false

Example: introscope.agent.wldf.enable=false

Was this helpful?

Please log in to post comments.