IntroscopeEnterpriseManager.properties

A variety of Enterprise Manager behaviors are controlled by properties defined in one of three Enterprise Manager properties files, IntroscopeEnterpriseManager.properties. (The others are and .)
apmdevops106
A variety of Enterprise Manager behaviors are controlled by properties defined in one of three Enterprise Manager properties files,
IntroscopeEnterpriseManager.properties
. (The others are APMEnterpriseManager.properties and apm-events-thresholds-config.xml.)
After configuring most Enterprise Manager properties, you must restart the Enterprise Manager before any changes you make will take effect.
Some Enterprise Manager properties, however, use the Introscope hot configuration service. It is not necessary to restart the Enterprise Manager after making changes to these so-called "hot config" properties. For more information, see Hot Configuration Service.
2
2
Welcome Screen
introscope.apmserver.ui.welcome.url
This property relates to the welcome dialog. The link displays on the welcome dialog in Team Center after first login or after an update of the product.
Authorization
introscope.aca.cacheRefreshPeriodInMinutes
This property defines the refresh period in minutes for the user group cache used for authorization and how often Enterprise Manager refreshes the list of user groups from LDAP or EEM. By default, this property is commented out and the refresh period is every 60 minutes. Change this value if synchronization with LDAP/EEM is required to occur more often.
Default
: 60
Example:
introscope.aca.cacheRefreshPeriodInMinutes=60
Enterprise Team Center Configuration
introscope.apmserver.teamcenter.master
This property defines an Enterprise Manager as the Master in an Enterprise Team Center environment.
Default
: False
Example
:
introscope.apmserver.teamcenter.master=true
Team Center Configuration
introscope.enterprisemanager.transactiontrace.arrivalbuffer.incubationtime.fast
Set the fast incubation buffer time to a value that catches the vast majority of successful transactions. We recommend that you set the fast incubation buffer time to a value that is double the time it takes 95% of transactions to complete. For example, if 95% of your transactions complete in 30 seconds, set the fast transaction buffer time to 60 seconds.
Default
: 300
Example:
introscope.enterprisemanager.transactiontrace.arrivalbuffer.incubationtime.fast = 240
The value must be an integer value of time, stated in seconds.
introscope.enterprisemanager.transactiontrace.arrivalbuffer.incubationtime.slow
Set the slow incubation buffer time to longer than the longest possible time to complete a transaction. For example, if the maximum possible time for a transaction is 900 seconds, set the transaction buffer to 1200 seconds. If you experience a transaction time longer than the slow buffer time, increase the value of the slow buffer time.
Default
: 1200
Example
:
introscope.enterprisemanager.transactiontrace.arrivalbuffer.incubationtime.fast = 900
The value must be an integer value of time, stated in seconds.
introscope.apm.feature.enabled
By default, Team Center is active and displays map data collected by Enterprise Managers.
To reduce overhead, you can disable map functionality at the Enterprise Manager level with the
introscope.apm.feature.enabled
property. This affects Team Center, WebView, and Workstation maps.
To turn off Enterprise Manager map functionality, set the property to false.
introscope.apm.feature.enabled=false
Default
: true
introscope.apmserver.feature.enabled
Set this property to false to disable APM Team Center.
introscope.apmserver.feature.enabled=false
Default:
true
Team Center Map Configuration
These properties allow you to enable and apply Team Center map data settings. For configuration instructions, see Configure Team Center Map.
introscope.apm.data.agingTime
This property, which is loaded by agents, controls how often agents report Team Center map data to the Enterprise Manager.
Notes
This property is not hot configurable. If you change this property, restart the agent and Enterprise Manager in order for the changes to take effect.
Before changing this property, delete the map data from the APM database. When this value is changed and old map data is used with new map data, historical queries will show inconsistent results with respect to the new value.
This value cannot be less than 1 minute. If you set it to less than 1 minute, the property defaults to 1 day.
When deciding on this setting, consider how often your organization adds and modifies applications. If you set a lower value, then the map displays application dependencies on a real-time basis, but this can use agent and Enterprise Manager overhead. If you set a higher value, then the map displays application dependencies that can be less current, but this can use less agent and Enterprise Manager overhead.
For information about agent and Enterprise Manager overhead, see the CA APM
Sizing and Performance Guide
.
Use any of these time units, which are not case sensitive. For:
  • Days use: days, D
  • Minutes use: mins, M
  • Hours use: hours, H
This agingTime property works in conjunction with the
introscope.apm.data.timeWindow
property, such that agingTime is usually a subset of the timeWindow.
Example
If the
introscope.apm.data.agingTime
value is 3 days, and the
introscope.apm.data.timeWindow
value is 10 days, the Team Center map displays application dependencies that have been reported by agents during the previous 10 days. If no data has been reported for a dependency during those 10 days, the dependencies will appear as aged after the agingTime period has expired, or 3 days, and will remain as aged elements on the map until the end of the 10 day timeWindow.
Default
1 day
introscope.apm.pruning.cron.trigger.expression
This property controls how often the database is pruned of old data.
It is formatted as an opensymphony quartz scheduler expression.
Default:
By default, the prune task runs every day at 6 AM.
introscope.apm.pruning.cron.trigger.expression=0 0 6 * * ?
This property is related to CEM tables and not to teamcenter data (appmap_edges, appmap_vertices, appmap_attribs, appmap_states, at_stories, at_evidences).
introscope.apm.pruning.enabled
This property enables the pruning of Team Center map data from the APM database.
Notes
  • This property is not hot configurable. If you change this property, restart the Enterprise Manager in order for the changes to take effect.
  • When this property is set to true, Team Center map data is pruned from the APM database.
  • Pruning occurs at EM startup and then every 24 hours after the last pruning run. For example, if EM starts at 3pm, pruning happens immediately, and then it is executed every following day at 3pm.
  • When this property is set to false, Team Center map data is not pruned from the APM database, and is stored indefinitely.
Default
Team Center map data pruning is enabled by default to be done on the APM database in a cluster environment for standalone Enterprise Managers and MOMs.
You cannot configure a Collector for Team Center data pruning. If you set the introscope.apm.pruning.enabled property to true for a Collector, errors are returned.
introscope.apm.data.preserving.time
This property controls how long Team Center map data is stored in the APM database. Map data older than the preserving time value is considered aged out, and can be pruned.
Notes
This property is not hot configurable. If you change this property, restart the Enterprise Manager in order for the changes to take effect.
During pruning, Team Center map data that is older than the sum of the
introscope.apm.data.preserving.time
and
Introscope.apm.data.agingTime
values is deleted.
For example, if the
introscope.apm.data.preserving.time
value
is 30 days and the
Introscope.apm.data.agingTime
value is 1 day, map data older than 30 + 1 = 31 days is deleted.
If the preservation time value is set too low (seconds or milliseconds), Team Center map data might be deleted from the APM database right after the data arrives from the Enterprise Manager.
Use any of these time units, which are not case sensitive. For:
  • Days use: days, D
  • Minutes use: mins, M
  • Hours use: hours, H
  • Seconds use: secs, S
  • Milliseconds use: MS
Default
365 days
introscope.apm.alert.preserving.time
This property controls alert status changes for Team Center map data stored in the APM database.
Use any of these time units, which are not case sensitive. For:
  • Days use: days, D
  • Minutes use: mins, M
  • Hours use: hours, H
  • Seconds use: secs, S
  • Milliseconds use: MS
Default
62 Days
Team Center Experience Cards Data Clamp
The data clamp is 9000 experiences. Experiences are business transactions or application entry points. The data clamp is configurable.
The data clamp property is hot configurable. You do not need to restart the Enterprise Manager.
introscope.apmserver.atc.landing.clamp.size
Default:
9000
Maximum Recommended Value:
9000
Example:
introscope.apmserver.atc.landing.clamp.size = 9000
Team Center Observed Periods for Alerts Data Clamp
introscope.enterprisemanager.alerts.maxPeriods
The maximum number of observed periods for alerts.
Default:
20 (5 minutes)
Example:
introscope.enterprisemanager.alerts.maxPeriods = 2000
Team Center Domain Universe Synchronization
introscope.apmserver.domainuniverses.enable
This property creates and updates a set of automatic domain universes in Team Center so that you can use existing domain segregation. Domain universe synchronization is disabled by default. Set the value to true to enable synchronization.This property is hot. The domain universes disappear from Team Center a few minutes after changing the value to
false
.
Default:
False
introscope.enterprisemanager.domainsconfiguration.dynamicupdate.enable
This property enables the dynamic update. Set the value to
true
to enable the dynamic update.
Default:
False
introscope.enterprisemanager.domainsconfiguration.dynamicupdate.detectioninterval
This property defines the frequency with which the
domains.xml
file is checked and updated in Team Center.
Default:
1 minute
introscope.apmserver.domainuniverses.followtransactionpath
This property defines the
FOLLOW TRANSACTION PATH
option in the filter settings. This setting shows components on the map that are upstream from the filtered components. Set the value to
true
to include these components.
Default:
False
introscope.apmserver.domainuniverses.includestartpoint
This property shows the component on the map from which the transaction was initiated. Set the value to
true
to include the initial component.
Default:
False
introscope.apmserver.domainuniverses.customname
This property defines the name of the universe. Team Center replaces {0} with the domain name.
Default:
{0} domain
Example:
domain: {0}
This example uses
domain:
as the prefix. Use prefixes to group domain universes in your list of universes.
Assisted Triage Master Switch
Assisted Triage Master Switch section contains the following property:
introscope.triage.enabled
Use the
introscope.triage.enabled=false
property to disable or enable the generators and processors in Assisted Triage that are running in this Enterprise Manager. Uncomment this property to disable Assisted Triage.
Available Processors
The Available Processors section of
IntroscopeEnterpriseManager.properties
contains the following property.
introscope.enterprisemanager.availableprocessors
Use this property to set the number of processors available to this Enterprise Manager. It should be used if there is more than one Enterprise Manager on a host.
Default:
<blank>
Alert Behaviors
The Alert State Metrics section of
IntroscopeEnterpriseManager.properties
contains the following property:
introscope.enterprisemanager.alertstatemetric.prefix
Name of the Investigator node under which Alert state metrics are shown.
Default:
Alerts
Communications
The Port Settings section of
IntroscopeEnterpriseManager.properties
contains the following properties:
introscope.enterprisemanager.enabled.channels
Specifies the communication channels that the Enterprise Manager can use. To enable a communication channel, add the channel type to the comma separated list of enabled channels. To disable a communication channel, remove it from the list.
The enabled.channels property works in conjunction with the introscope.enterprisemanager.port.<ChannelName> property.
Example:
If you have two communications channels called channel1 and channel2, you would set these properties:
introscope.enterprisemanager.enabled.channels=channel1,channel2 introscope.enterprisemanager.port.channel1=5001 introscope.enterprisemanager.port.channel2=5002
Default:
channel1
introscope.enterprisemanager.port.<ChannelName>
This listener port that the Enterprise Manager uses for encrypted communication with Workstations and agents.
To create a custom communication channel, add these properties to the properties file:
  • introscope.enterprisemanager.port.ChannelName
  • introscope.enterprisemanager.serversocketfactory.ChannelName
  • where
    ChannelName
    is the name of the new channel.
To enable the custom channel, add its name to the introscope.enterprisemanager.enabled.channels property.
Default:
5001
introscope.enterprisemanager.serversocketfactory.<ChannelName>
This property identifies the classname of the Server Socket Factory that the Enterprise Manager uses for encrypted communication with Workstations and agents.
If you create a custom communication channel, add a new property to the properties file, for instance:
introscope.enterprisemanager.serversocketfactory.ChannelName
where ChannelName is the name of the new channel, and set the property value to the fully qualified classname of the custom Server Socket Factory that implements the
com.wily.isengard.postofficehub.link.net.IServerSocketFactory
interface.
You must also specify the listener port for the channel, and enable it, as described in introscope.enterprisemanager.port.<ChannelName>.
Example:
If you have two communications channels called channel1 and channel2 set like this:
introscope.enterprisemanager.enabled.channels=channel1,channel2 introscope.enterprisemanager.port.channel1=5001 introscope.enterprisemanager.port.channel2=5002
you would set the serversocketfactory property like this:
introscope.enterprisemanager.serversocketfactory.channel1=<classname> introscope.enterprisemanager.serversocketfactory.channel2=<classname>
Default:
com.wily.isengard.postofficehub.link.net.server.DefaultServerSocketFactory
introscope.enterprisemanager.serversockets.reuseaddr
Set this property to true to allow a communication channel server socket to rebind to a local port that is stuck in a
FIN_WAIT
or
TIME_WAIT
state. Once the Enterprise Manager starts up again, this property should be disabled.
Do not enable this property by default, since there may be a valid reason that the port is already in use.
Default:
False
introscope.enterprisemanager.disableInteractiveMode
Disables interactive console (whether or not the console accepts input).
Notes:
On many UNIX platforms, nohup will not work if the application is trying to read from standard input. To run in nohup mode, set this property to true, and change the lax.stdin.redirect property in the excecution script to <blank>. If both of these properties are not set exactly as stated above, it can either render the application unable to start up in nohup, or cause maximum CPU utilization.
Default:
True
introscope.enterprisemanager.webserver.port
The port on which the Enterprise Manager’s embedded Web server listens.
Default:
8081
introscope.enterprisemanager.webserver.portinuse.fail
Prevents the Enterprise Manager from starting when another application is running on the same port as the Enterprise Manager.
If another application runs on the same port as the Enterprise Manager, these property settings control whether the Enterprise Manager starts:
  • When this property is set to true, then the Enterprise Manager is prevented from starting.
  • When this property is set to false, an error message displays saying the port is in use. However, the Enterprise Manager is allowed to start.
Default:
true
introscope.enterprisemanager.ipaddress
Binds all Enterprise Manager communication channels, including the embedded Web server, to a specific local IP address.
When this property is not configured, the Enterprise Manager accepts connections on all local addresses.
Rules to consider when configuring this property:
  • If this property is configured to a IPv4 address, the Enterprise Manager will only accept connections from agents or clients on running on an IPv4 system.
  • If the property is configured to an IPv6 address, the Enterprise Manager will only accept connections from agents or clients on machines running an IPv6 compliant JVM. Agents or clients on machines running an IPv4 JVM cannot use an IPv6 address to connect.
  • If you do not bind the Enterprise Manager or WebView instance running on IPV6 enabled system to a specific IP address, the instance is bound to all local addresses. It can accept connections from both IPv4 and IPv6 environments.
  • Workstations, agents, Browsers, and other clients should use the DNS name, not the IP address, to connect to the Enterprise Manager or WebView instance.
  • IPv6 support on the agent is dependent upon IPv6 support in the environment (JVM, operating system, hardware stack) in which the agent is running.
Default:
<commented out, no value>
introscope.enterprisemanager.workstation.connection.channel
Specifies the channel for connecting to the Web Start Workstation.
Default:
channel1
introscope.enterprisemanager.workstation.extendedLiveQuery
Allows a Workstation user to enter custom time range and resolution for live mode, instead of the default time range of 8 minutes and resolution of 15 seconds.
Note:
Setting a time range greater than 8 minutes could negatively affect Enterprise Manager performance due to I/O operations to fetch data from smartstor.
introscope.enterprisemanager.sockets.receivebuffersize
Enables TCP tuning to improve communication performance between MOM and Collector. This property must be updated in all Enterprise Managers (EMs) and after you define the property, restart the EMs.
Default:
32K
Example
introscope.enterprisemanager.sockets.receivebuffersize=32768
Telemetry
The telemetry services section of IntroscopeEnterpriseManager.properties contains the following properties:
introscope.apmserver.telemetry
Enables collection of telemetry data. Set to true to enable the service. You do not need to restart the Enterprise Manager.
Default:
False
Example
introscope.apmserver.telemetry.enabled=true
introscope.apmserver.unmonitored.class.telemetry
Enables telemetry reporting about unmonitored agent classes that are gathered through RDI. Set this property to false to disable telemetry data collection about unmonitored agent classes.
Default:
True
Example
introscope.apmserver.unmonitored.class.telemetry=false
introscope.apmserver.telemetry.auto.post.count
Sets the post number at the point that you want to send the report information.
Default:
1000
Example
introscope.apmserver.telemetry.auto.post.count=1000
introscope.apmserver.telemetry.periodic.post.seconds
Sets the period at the point that you want to send the report information.
Default:
300
Example
introscope.apmserver.telemetry.periodic.post.seconds=300
APM reports the classes to telemetry when the tracked class count reaches either the specified value or period. If APM detects that the post count is reached before the time limit, APM reports the data. Use these settings to limit reporting frequency in periods of high volume. By enabling the telemetry service, you agree that CA Technologies collects your supportability metrics.
Workstation Login Parameters Auto Fill section
The Workstation Login Parameters section of IntroscopeEnterpriseManager.properties contains the following properties.
introscope.enterprisemanager.workstation.rememberLogin
Controls whether Workstation remembers login parameters (Enterprise Manager host, port, and UserId) for Web Start. If set to FALSE, Workstation will not remember login parameters.
Default
: True
EM Web Server Settings
The EM Web Server Settings section of IntroscopeEnterpriseManager.properties contains the following properties:
introscope.enterprisemanager.webserver.jetty.configurationFile
The path to a Jetty XML configuration file. Either an absolute path, or a path relative to the <
EM_Home
>/config directory. This file creates an SSL listener on port 8444 for HTTPS traffic.
Notes:
If you uncomment the introscope.enterprisemanager.webserver.jetty.configurationFile property, the unsecured HTTP listener that is specified in the IntroscopeEnterpriseManager.properties file introscope.enterprisemanager.webserver.port property is not created. However, you can configure the unsecured HTTP listener in the Jetty XML configuration file.
This property does not support hot configuration.
Default:
em-jetty-config.xml
introscope.enterprisemanager.webserver.max.threads
The maximum number of listener threads in the Web server -- that is, the number of concurrent HTTP clients that can be served by the Enterprise Manager’s embedded Web server.
Notes:
Configure this property only if more than 80 HTTP tunneling agents are connecting to this Enterprise Manager. In this situation, CA Technologies recommends setting the property value to 20 more than the maximum number of connecting HTTP tunneling agents. If you expect fewer than 80 concurrent HTTP agents, do not modify this property value.
Default
: 100
Hot Configuration Service
The Enterprise Manager includes a hot configuration that is enabled by default for these properties:
introscope.enterprisemanager.hotconfig.enable
Enables the hot configuration service. Set to false to disable the service.
Default
true
introscope.enterprisemanager.hotconfig.pollingInterval
Specifies how often to check this file for changes, in seconds.
Default
60 seconds
Logging
Logging properties define the level of detail in the Enterprise Manager logs and the name and location of Enterprise Manager log files. See Log4J documentation at https://logging.apache.org/log4j/1.2/manual.html for information on advanced Log4J functions.
These Enterprise Manager properties use the Introscope hot configuration service. It is not necessary to restart the Enterprise Manager after making changes to these hot configuration properties. For more information, see Hot Configuration Service
.
log4j.logger.Manager
Controls the level of detail, and destination for log messages.
Level of detail value can be:
INFO
or
VERBOSE#com.wily.util.feedback.Log4JSeverityLevel
.
Destination value can be console or logfile. The default setting writes log information to the console and the log file.
Default
INFO, console, logfile
log4j.appender.logfile.File
Name and location of Enterprise Manager logfile, relative to the Enterprise Manager home directory.
Default
logs/IntroscopeEnterpriseManager.log
log4j.appender.logfile.layout.ConversionPattern
Allows you to customize your log files.
The property can be set the following values:
d{M/dd/yy hh:mm:ss a z} [%-3p] [%c] %m%n
The pattern is implemented in the log4j library and the format is described here: http://logging.apache.org/log4j/docs/api/org/apache/log4j/PatternLayout.html
The date/time format appears in the
%d{..}
and follows a pattern described here: http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html
Default
<blank>
Auditing
The auditing properties define the level, name, location, and detail of the audit logs. Edit the following properties to configure the auditing functionality:
introscope.apmserver.auditing.enabled
Enables or disables auditing.
Default:
False
Example:
introscope.apmserver.audit.enabled=true
This property is hot configurable. You do not need to restart the Enterprise Manager.
introscope.apmserver.audit.max.age
Sets the time in days, during which the audit records are stored in the Enterprise Manager database. Enter 0 to disable the database cleanup.
Default:
0
Example:
introscope.apmserver.audit.max.age=365
You must restart the Enterprise Manager.
APM SQL
An APMSQL server lets you connect to and extract APM data using a true JDBC driver, or over an appropriate ODBC driver in the case of MS Excel. Older JDBC interfaces were limited to a single type of query.  The APMSQL interface supports the full SQL syntax, including GROUP BY clauses. See the APMSQL Cookbook for more details.
introscope.enterprisemanager.restapi.sql.connectionLimit
The value of the property can be set to positive or negative numbers. If value of this property is set to positive number then APM Data SQL rest API will be limited to a set number of parallel connections. If the value is negaitive, transfer is unlimited.
Default
5
Persistent Collections -- Recording Data to a Database
You can configure the properties described in this section to record traced data to an external, relational database. For more information, see the SQL Database Settings section of the
IntroscopeEnterpriseManager.properties
file. These settings are deployed by hot configuration, so they do not require a manual restart of the Enterprise Manager.
These Enterprise Manager properties use the Introscope hot configuration service. You do not need to restart the Enterprise Manager after changing these so-called "hot config" properties. For more information, see Hot Configuration Service.
introscope.enterprisemanager.database.collection.agentExpression
This is the agent regular expression property. Add this setting to the
IntroscopeEnterpriseManager.properties
file and is deployed via hot configuration.
For example:
Introscope.enterprisemanager.database.collection.agentExpression=rhart-dt1\\|EPAgentProcess1\\|EPAgent5
Default
<blank>
introscope.enterprisemanager.database.collection.metricExpression
This is the metric regular expression property. Add this setting to the
IntroscopeEnterpriseManager.properties
file and is deployed via hot configuration.
Example
introscope.enterprisemanager.database.collection.metricExpression=Servlets\\|MyServlet:Average Response Time \\(ms\\)
Default
<blank>
introscope.enterprisemanager.database.collection.frequencyinseconds
Where agentExpression is the agent regular expression, metricExpression is the metric regular expression, and frequencyinseconds is the frequency in seconds to aggregate the data and write it to the database. Add this setting to the
IntroscopeEnterpriseManager.properties
file and is deployed via hot configuration.
There is no default setting as each persistent collection can have a different value. This property should be set for each persistent collection.
Default
none
introscope.enterprisemanager.database.recordingQueue.upperLimit.value
The maximum number of metric data points on the queue. A metric data point is one time slice of data for one metric. This setting is deployed via hot configuration.
Default
150k (thousand)
Flat File Properties
Flat files are plain-text comma-separated value (
.csv
) files. Introscope can write to flat files, but cannot read from them. You can analyze flat files with numerical analysis tools.
Flatfile recording is enabled by default and directed to the
<EM_Home>/flatfiles
directory. You can also specify that these files reside in a directory outside of the Introscope directory. Note that for Windows paths, you must escape backslashes (\) with another backslash (doubled), for example:
C:\\Introscope\\FlatFileDir
.
Transaction Event Database
The Enterprise Manager stores captured transaction events locally on its file system for a fixed length of time or until a maximum disk usage is exceeded. You can control where to store these events and when they should be deleted by setting the transaction event database properties.
introscope.enterprisemanager.transactionevents.storage.dir
Specifies the location, relative to the Enterprise Manager home directory, where Introscope stores transaction event data.
Default
traces
introscope.enterprisemanager.transactionevents.storage.max.data.age
Specifies, in days, how long to store transaction event data.
Default
14
introscope.enterprisemanager.transactionevents.storage.optimize.frequency
Specifies how often, in hours, the trace storage should be optimized by cleaning up aged data.
Enables aging of transaction trace data when the Enterprise Manager starts.
Default
24 hours
introscope.enterprisemanager.transactionevents.storage.optimize.timeoffsethour
Specifies the time offset for storage optimization, which allows you to schedule purges to start on a specific hour of every day against the time offset.
For example, if the time offset is set to 02 and optimize frequency (see introscope.enterprisemanager.transactionevents.storage.optimize.frequency) is set to 24 hours, optimization will run every 24 hours offset from time 02:00AM.
Entering a 00 value for this property will display an error message, as this value must be a positive integer.
Default
02 (2AM)
Transaction Trace Sampling
These transaction trace sampling properties are located, by default, in
IntroscopeEnterpriseManager.properties
.
These properties are hot configuration properties.
introscope.agent.transactiontracer.sampling.perinterval.count
Configured for 1 sample trace by default. This property works in conjunction with the introscope.agent.transactiontracer.sampling.interval.seconds property.
You can change the number of traces per interval to trace, by modifying its value and uncommenting it in the properties file.
Default
1
introscope.agent.transactiontracer.sampling.interval.seconds
Configured to trace every 2 minutes by default. This property works in conjunction with the introscope.agent.transactiontracer.sampling.perinterval.count property.
You can change the sampling interval by modifying its value and uncommenting it in the properties file.
Notes
Before overriding the defaults for the sampling.perinterval and sampling.interval properties, consider the potential for increased load in the Enterprise Manager with higher sampling rates.
Default
120 seconds
Application Transaction Detection Clamp
Application Transactions identify paths of all transactions through an application and assign identities if the path is not identified as a Business Transaction by CEM. This identity enables users to filter any Team Center map to display all components in a specified transaction path. In large environments this means that large numbers of edges are detected relative to the number of vertexes which can lead to performance issues. Use the Application Transaction Detection Clamp, to prevent performance degradation. Add the following properties to IntroscopeEnterpriseManager.properties to configure the clamp and threshold.
introscope.enterprisemanager.transactiontrace.applicationtransaction.producing.threshold
Defines the threshold as a number of edges for the introscope.enterprisemanager.transactiontrace.applicationtransaction.producing property. Below this threshold Application Transaction path detection is automatic and is not disabled regardless of the ratio of edges to vertexes.
Default
: 50000
introscope.enterprisemanager.transactiontrace.applicationtransaction.producing
This property is applied if the number of edges in the Enterprise Environment is above the threshold configured in introscope.enterprisemanager.transactiontrace.applicationtransaction.producing.threshold.  This property configures the upper limit for Application Transaction detection. Above this value Application Transaction detection stops and existing application transaction information is deleted.
Options
:
  • Positive Integer Value
    -- representing the ratio of edges to vertexes in the Enterprise Environment.
  • never - application transactions are never created.
  • always - application transactions are always created and clamping is never applied.
Default
: 10
Example
:
introscope.enterprisemanager.transactiontrace.applicationtransaction.producing=10
Note
: In this example the Application Transaction detection is clamped when the number of edges is above the threshold and 10 times the number of vertexes in the Enterprise Environment.
Total Duration Display
Set the properties in this section to configure the Enterprise Manager to display the total duration information for a trace. The total duration of a trace is the wall clock time from the start to the end of all the trace components. Restart the Enterprise Manager to view the Total Duration (in milliseconds) column in the Transaction Viewer.
introscope.workstation.transactiontracer.showTotalDuration
Shows or hides the Total Duration (in milliseconds) column in the Transaction Viewer. This property works in conjunction with the introscope.workstation.transactiontracer.showTotalDuration.sumAllTraceComponents property.
Set both the properties to true in the IntroscopeEnterpriseManager.properties file as follows to view the Total Duration (in milliseconds) column in the Transaction Viewer:
introscope.workstation.transactiontracer.showTotalDuration=true introscope.workstation.transactiontracer.showTotalDuration.sumAllTraceComponents=true
When using cross-process trace correlation and header filters in the live trace view, the total duration column is not calculated and displayed completely. This is because only the first component with the header described in the filter is visible in the live view. The subsequent components are not visible even though they are correlated. The total duration is thus partially calculated and displayed based on the components visible in the live view.
Enterprise Manager Metric Clamping
These properties define the limits set for the number of results that you get for metrics from a standalone Enterprise Manager or clustered Collector. The properties are hot configurable, meaning that when the Enterprise Manager checks the property file during a hot deploy, the values are applied. A hot deploy occurs every 60 seconds.
To disable clamps, follow these steps:
  1. Open the
    IntroscopeEnterpriseManager.properties
    file and navigate to the EM Metric Clamping section.
  2. To disable the clamp, set the clamp value to
    0
    .
  3. Save and close
    IntroscopeEnterpriseManager.properties
    .
Additional Enterprise Manager clamps are in the apm-events-thresholds-config.xml file in the
<EM_Home>/config
directory.
introscope.enterprisemanager.query.datapointlimit
This property defines the maximum number of metric data points that an Enterprise Manager retrieves from SmartStor during the execution of a batch of metric queries.
The software issuing the query can be the Workstation, WebView, or the Command Line Workstation (CLW). The query can be a Top N query or another type of filter.
The effect of this clamp is to limit the number of metrics a clustered Collector or standalone Enterprise Manager retrieves from SmartStor. The Enterprise Manager always returns the full data for at least the first query in a batch. After you execute a query, you cannot stop it. However, if a query exceeds the maximum data point that is set, subsequent queries in the batch do not execute. The clamp can cause missing values in a table that comprise many values produced by a single query and that are executed together in a batch.
This property works with the
introscope.enterprisemanager.query.returneddatapointlimit
property.
The
introscope.enterprisemanager.query.returneddatapointlimit
clamp differs from
introscope.enterprisemanager.query.datapointlimit
because it limits the number of data points returned from the execution of a batch of queries. The
introscope.enterprisemanager.query.datapointlimit
property
limits the number of data points fetched from SmartStor during the execution of a batch of queries. The two are not the same because of the retrieved data-point aggregation.
Default:
0 (where 0 means that there is no limit.)
Example
The
introscope.enterprisemanager.query.datapointlimit
property is set to 1000 and the
introscope.enterprisemanager.query.returneddatapointlimit
property is set to 0 (no limit).
You open a component overview page in Workstation that lists the five blame point metrics for 20 components. This setup executes a batch of 100 metric queries. If, after executing the first 90 queries, the total number of data points retrieved from SmartStor exceeds 1000, the remaining 10 queries in the batch are not executed. Consequently, the clamp causes 10 missing values in the component overview page.
You cannot set this property to clamp a query on a MOM. You can set this property only on standalone and Collector Enterprise Managers.
introscope.enterprisemanager.query.returneddatapointlimit
This Enterprise Manager clamp property limits the number of data points that are returned from a batch of metric queries. A data point is the value of one metric for a specified period.
The number of data points that a query returns depends on these factors:
  • Number of matching metrics.
  • Time range that you request.
  • Resolution of the SmartStor data that depends on the configuration of the SmartStor data tiers.
The Enterprise Manager returns the full data for at least the first query in a batch. After you execute a query, you cannot stop it. If a query brings the total number of data points retrieved so far in that batch to exceed the maximum data point that is set, subsequent queries in the batch do not execute. Consequently, the clamp can cause missing values in a table that comprise many values produced by a single query and that are executed together in a batch. This property applies to both a clustered Collector or a standalone Enterprise Manager.
This property works in conjunction with the
introscope.enterprisemanager.query.datapointlimit
property.
The
introscope.enterprisemanager.query.returneddatapointlimit
property is hot configurable.
This clamp differs from
introscope.enterprisemanager.query.datapointlimit
because it limits the number of data points returned from the execution of a batch of queries. The
introscope.enterprisemanager.query.datapointlimit
property
limits the number of data points fetched from SmartStor during the execution of a batch of queries. The two are not the same because of the retrieved data-point aggregation.
Example
The
introscope.enterprisemanager.query.datapointlimit
is set to 0 (no limit) and the
introscope.enterprisemanager.query.returneddatapointlimit
property is set to 1000.
You open a component overview page in Workstation that lists the five blame point metrics for four components, and set the time resolution to 30 s. This setup executes a batch of 10 metric queries. Each query retrieves 300 data points from SmartStor, with each data point showing a value every 15 s. Because of the required aggregation to the time resolution of 30 s, the original 300 data points are aggregated to 150. After seven queries, 1050 data points are collected, which exceeds the
introscope.enterprisemanager.query.returneddatapointlimit
clamp. Consequently, the remaining three queries are not executed.
If, after executing the first 90 queries, the total number of data points retrieved from SmartStor exceeds 1000, the remaining 10 queries in the batch are not executed. The clamp then causes 10 missing values in the component overview page.
Default:
0 (where 0 means that no limit is set.)
You cannot set this property to clamp a query on a MOM. You can set this property only on standalone and Collector Enterprise Managers.
SmartStor
The properties in this section define the directory where SmartStor data is stored, and configure data collection and aging behavior for three tiers of storage. It also allows you to disable SmartStor if desired.
Note:
All three tiers must be defined. You cannot define more than three tiers.
introscope.enterprisemanager.smartstor.enable
Allows you to enable or disable SmartStor. While disabling SmartStor will save disk space, it will not store statistics and you will be prevented from monitoring them.
Set to False to disable SmartStor.
Notes
If you do not see the property in the SmartStor section, then SmartStor is enabled. To disable SmartStor add the following line to the properties file:
introscope.enterprisemanager.smartstor.enable=false
Default
True
introscope.enterprisemanager.smartstor.directory
Specifies the directory, relative to the Enterprise Manager home directory, that SmartStor will use.
Default
data
introscope.enterprisemanager.smartstor.directory.archive
Specifies the directory that SmartStor will use to store archived data.
Default
data/archive.
introscope.enterprisemanager.smartstor.dedicatedcontroller
Specifies whether SmartStor data is written to a dedicated disk.
Set to true if SmartStor data is being written to a dedicated disk.
Default
false
introscope.enterprisemanager.smartstor.tier1.frequency
Specifies the frequency (in seconds) of data collection for the first data tier. The frequency:
  • must be a multiple of 15 seconds.
  • must not be greater than 1800 seconds (30 minutes).
  • must be an even multiple of the previous tier's frequency -- this multiple can be one; each tier can have the same frequency.
Default
15
introscope.enterprisemanager.smartstor.tier1.age
Specifies the number of days after which data in first tier ages out of SmartStor. The value cannot be zero.
Default
7
introscope.enterprisemanager.smartstor.tier2.frequency
Specifies the frequency (in seconds) of data collection for the second data tier. The frequency:
  • must be a multiple of 15 seconds.
  • must not be greater than 1800 seconds (30 minutes).
  • must be an even multiple of the previous tier's frequency -- this multiple can be one; each tier can have the same frequency.
Default
60
introscope.enterprisemanager.smartstor.tier2.age
Specifies the number of days after which data in second tier ages out of SmartStor. The value cannot be zero.
Default
23
introscope.enterprisemanager.smartstor.tier3.frequency
Specifies the frequency (in seconds) of data collection for the third data tier. The frequency:
  • must be a multiple of 15 seconds.
  • must not be greater than 1800 seconds (30 minutes).
  • must be an even multiple of the previous tier's frequency -- this multiple can be one; each tier can have the same frequency.
Default
900
introscope.enterprisemanager.smartstor.tier3.age
Specifies the number of days after which data in third tier ages out of SmartStor. The value cannot be zero.
Default
335
introscope.enterprisemanager.memoryCache.elements
This property controls the number of data points that the Enterprise Manager keeps in an internal compressed memory cache to speed historical data queries.
Each data point contains 15 seconds of metric data. The default of 32 data points contains 8 minutes of historical metric data.
The range is 32 (8 minutes) to 11520 (48 hours), and must be divisible by 32.
You can set the cache larger than 32 data points for triaging situations when there are spikes in Workstation usage. For example, a value of 240 data points allows the Enterprise Manager to provide every historical query for the last hour from the memory cache.
Notes
This property is not hot configurable. If you change this property, restart Enterprise Manager for the changes to take effect.
This value cannot be less than 32 data points. If you set it to less than 32, it is set to the default value.
If the value is not divisible by 32, it is reduced to the nearest number divisible by 32.
Increasing the number of data points in the cache requires RAM. Do not set the value higher than the default unless you are running a 64-bit computer with multiple gigabytes of extra heap memory.
Use the following calculation to calculate the heap memory the cache requires. Assume an average of 32 bytes per cached data point.
Number of data points * 32 bytes * Number of metrics = Required cache heap memory
Example
You decide to increase the cache to hold about an hour of data and set the value to 256 data points. You use the following equation to calculate the cache heap memory needed:
256 data points * 32 bytes * 500,000 metrics = 4.1 GB of cache heap memory
You examine the Enterprise Manager heap size to see if you need to adjust it based on the cache heap memory requirement.
Default
32 data points
introscope.enterprisemanager.smartstor.reperiodizationOffsetHour
This property allows you to configure the time offset for data tiering.
Constraints
Must be an integer from 0 to 23, representing hours of the day, where 0 signifies midnight and 13 signifies 1:00 p.m.
Default
0 (0 means that data tiering starts at midnight).
Example
If you set this property to 2, the data tiering starts at 2:00 a.m.
introscope.enterprisemanager.smartstor.conversionOffsetMinute
This property allows you to configure a time offset for spool converting to data.
Constraints
Must be an integer from 0 to 59, representing the number of minutes after the hour.
Default
0 (for example, setting the value to xx:00 means that conversion starts on the hour).
Example
If you set the value to 10 (xx:10), the spool conversion starts at 10 minutes after the hour.
Variance Data Storage
The EM Object Database Settings section of
IntroscopeEnterpriseManager.properties
contains the following property:
introscope.enterprisemanager.dbfile
Specifies the filename, and its location relative to the Enterprise Manager home directory, of the database in which Introscope stores metric variance information.
Default
data/variance.db
SNMP Collections
The SNMP Adapter section of
IntroscopeEnterpriseManager.properties
contains the following properties:
introscope.enterprisemanager.snmp.enable
Enables SNMP agent (only relevant if you have installed SNMPServices.jar)
Default
false
introscope.enterprisemanager.snmp.agent.port
Enterprise Manager port that communicates with the SNMP agent
Default
161
WebView
The WebView Configuration section of
IntroscopeEnterpriseManager.properties
contains the following properties:
introscope.enterprisemanager.webview.disableLogin
Determines whether WebView can establish a connection with Enterprise Manager.
Default
false
introscope.enterprisemanager.webview.password
Specifies password WebView users to connect to Enterprise Manager.
Default
WebView
introscope.webview.default.url
For the SMTP email notification configuration, the introscope.webview.default.url property defines the WebView default URL for embedded hyperlinks that point to alerts and metrics. A time range is used by this property to enable viewing of the alert or metric at start time.
This property uses the host name of the local Enterprise Manager server (or MOM) and corresponding port number when the default value is not set.
Follow these steps
:
  1. Open the IntroscopeEnterpriseManager.properties file for editing in the <
    EM_Home>
    /config directory.
  2. Locate the introscope.webview.default.url property and set the value as follows:
    introscope.webview.default.url=http://<
    server_name (or mom_name)
    >:<
    port_number
    >
    Example: http://apm.mom:8080/
  3. Save changes.
Before any changes can take effect, you must restart the Enterprise Manager.
CA APM ChangeDetector
The CA APM ChangeDetector section of
IntroscopeEnterpriseManager.properties
contains the following property:
introscope.changeDetector.disable
This property allows you to enable or disable CA APM ChangeDetector.
Default
true
Management Module Bootstrapping
The Management Module Bootstrapping section of
IntroscopeEnterpriseManager.properties
contains the following property:
introscope.enterprisemanager.managementModules.invalid.references.as.errors
Logs invalid references as warnings. If set to true, invalid references will prevent the Enterprise Manager from starting.
Default
false
Management Module Deployment
The Management Module Deployment section of
IntroscopeEnterpriseManager.properties
contains the following properties:
introscope.enterprisemanager.hotdeploy.directory
Defines the directory, relative to the Enterprise Manager home directory, to check for updated applications to deploy.
Default
deploy
introscope.enterprisemanager.hotdeploy.checkFrequencyInSeconds
Specifies how often, in seconds, to check for updated Management Modules to deploy.
Default
60
Clustering Settings
Some of these properties require Enterprise Manager restart to put the settings into effect. Others use the Introscope hot configuration service. It is not necessary to restart the Enterprise Manager after making changes to these so-called "hot config" properties.
introscope.enterprisemanager.clustering.manager.slowcollectorthreshold
Set this property to define the threshold for the ping metric for your environment. The ping metric monitors only the lower boundary of the round-trip response time from the MOM to each Collector.
Default
10000 (in milliseconds)
introscope.enterprisemanager.clustering.manager.slowcollectordisconnectthresholdseconds
Set this property to define the threshold for which the MOM will automatically disconnect from the Collector if exceeded. This will prevent the entire cluster from hanging, which is a side effect of when one Collector in a cluster is greatly under performing.
If this property is set to zero or a negative value, which is not recommended, this will not be enabled.
Notes
The MOM checks Collectors every 7.5 seconds, so small changes will not affect its behavior.
Default
60 (in seconds)
introscope.enterprisemanager.clustering.manager.staggeredstartdelay
Set this optional property on the MOM to alter the length of time between MOM connection attempts to clustered Collectors. If this property is not set, the default time between connection attempts is 0 seconds, meaning that the MOM recognizes each Collector as soon as the Collector becomes available.
Setting this property helps even out the MOM’s startup overhead. It gives the MOM a period of time to process the connection as each Collector comes online before starting the connection process with another waiting Collector.
The minimum value is 0 seconds.
Default
0 (seconds). The minimum value is 0 seconds.
introscope.enterprisemanager.clustering.mode
This property specifies the Enterprise Manager role in a CA APM environment.
  • Options
    CDV -- Enterprise Manager runs as a Cross-cluster Data Viewer
    Collector -- Enterprise Manager runs as a Collector
    MOM -- Enterprise Manager runs as a Manager
    StandAlone -- Enterprise Manager runs as a standalone Enterprise Manager
  • Note
    Restart the Enterprise Manager to put this property setting into effect.
    If an Enterprise Manager is configured as a CDV, then changed to any of these roles, the machine requires an APM database:
    • MOM
    • Collector
    • Standalone Enterprise Manager
  • Default value
    StandAlone
  • Example
    introscope.enterprisemanager.clustering.mode=StandAlone
introscope.enterprisemanager.clustering.login.<emName>.host
Hostname or IP address of the Collector Enterprise Manager.
Default
<blank>
introscope.enterprisemanager.clustering.login.<emName>.port
Value of the Collector Enterprise Manager’s introscope.enterprisemanager.port.<ChannelName> property.
Default
<blank>
introscope.enterprisemanager.clustering.login.<emName>.publickey
Specifies the public key for encrypting the password the MOM uses to connect to a Collector Enterprise Manager.
Default
config/internal/server/EM.public, commented out
introscope.enterprisemanager.clustering.login.em1.weight
Set this optional property to control the relative load of the Collector.
All other things being equal, the weight divided by the total weight for the cluster is the percentage of metric load assigned to that Collector. For example, if the weight of a Collector is 50 and the sum of the weights of all Collectors is 250, the Collector should get 20% of the cluster's metric load.
Average value for the cluster, with the weight being the load balancing weight for this Enterprise Manager Collector.
introscope.enterprisemanager.clustering.collector.identifier
Optional. You can set this property if you want to give this Collector a descriptive name.
If you don’t specify an identifier, Introscope uses the default identifier of [email protected], where host is the Enterprise Manager's host name, and port is the Enterprise Manager's connection port.
Default
false
introscope.enterprisemanager.collector.privatekey
Specifies the private key a Collector Enterprise Manager uses to decrypt the password the MOM uses to connect to it.
Default
config/internal/server/EM.private
introscope.enterprisemanager.loadbalancing.threshold
Set this property to define the tolerance of the Load Balancer for imbalance. The number of metrics in a Collector must differ from the weight-adjusted cluster average (i.e. the average for all Collectors) by at least the threshold before the Load Balancer rebalances the cluster.
Rebalancing means redistributing agents among Collectors to equalize the weight-adjusted metric load.
Default
20000 (metrics)
introscope.enterprisemanager.loadbalancing.interval
Set this property to determine how often the Load Balancer should rebalance in seconds. The minimum value is 120 seconds.
Default
600 (10 minutes)
introscope.enterprisemanager.cluster.mapdomains
Starting with APM 9.5, the identical domains.xml file is required for the MOM and Collectors. Custom domains must be on Collectors.
This property reverts the system to pre-9.5 behavior. Set this property to true to map agents to domains when domains.xml contains custom domains configured on only the MOM.
Warning!
Conflicting domains.xml files can result in these issues:
  • Data loss due to agents not being assigned to Collectors.
  • On the Metric Browser tab, blank Live mode graphs and metric gaps in Historical mode graphs.
  • Default
    false
  • Example
    introscope.enterprisemanager.cluster.mapdomains=true
  • Notes
    Add this property to the IntroscopeEnterpriseManager.properties file on only the MOM.
    Restart the cluster for the property to take effect.
Agent interactions
Some agent interaction properties require Enterprise Manager restart after configuration. Others are automatically deployed using the Enterprise Manager hot deploy configuration service, and hot deploy is noted in the property description.
Some agent interaction properties are not included in the Enterprise Manager properties file. To change their default values, add them to the
IntroscopeEnterpriseManager.properties
file and save the file. If a property is not hot deployed, shut down and restart the Enterprise Manager to enable the new values.
introscope.apm.agentcontrol.agent.allowed
When an agent does not match any regular expression in loadbalancing.xml, this setting determines whether the agent is allowed to connect to any of these Enterprise Managers:
  • Specific standalone Enterprise Manager.
  • Collectors.
  • Default
    true
  • Example
    introscope.apm.agentcontrol.agent.allowed=true
  • Notes
    This setting is deployed using hot configuration.
    If this property is set as follows:
    • Missing from the IntroscopeEnterpriseManager.properties file, then the value is true.
    • Set to true on the MOM, then all agents not matched in loadbalancing.xml are allowed in the cluster.
    • Set to false, then all agents not matched in loadbalancing.xml are configured as disallowed with these results:
      • Valid for: Pre 9.1 agents
        -- Pre-9.1 agents do not connect to any Enterprise Manager.
      • Valid for: 9.1 and later agents
        -- 9.1 and later agents passively connect to the Enterprise Manager and do not send any metric data.
      • Agents are added to the APM Status console Denied Agents list.
    Valid for: Pre 9.1 agents
    -- If a pre-9.1 agent has the following conditions:
    • Connected to an Enterprise Manager.
    • Disallowed base on a change of this property setting.
    Then the Enterprise Manager disconnects the agent. The Enterprise Manager denies all further agent connection attempts until the agent is allowed either by changing this property or configuring loadbalancing.xml. The agent waits to reconnect based on the time configured in the introscope.enterprisemanager.agent.disallowed.connection.limit property.
introscope.apm.agentcontrol.agent.emlistlookup.enable
Determines whether the following can send to each agent the list of Enterprise Managers to which the agent is allowed to connect:
  • MOM.
  • Collectors.
  • Standalone Enterprise Manager.
When any of the following goes down with the agent connected, this list tells the agent to which Enterprise Manager to connect next:
  • MOM.
  • Standalone Enterprise Manager.
  • Initial Collector to which the agent connects.
  • Default
    true
  • Example
    introscope.apm.agentcontrol.agent.emlistlookup.enable=true
  • Notes
    This setting is deployed using hot configuration.
    If an agent restarts, it uses its agent profile introscope.agent.enterprisemanager.connectionorder property for its initial Collector connection information.
introscope.apm.agentcontrol.agent.reconnect.wait
This setting provides the base duration, in seconds, that an agent waits before trying to reconnect to a standalone Enterprise Manager or Collector.
  • Default
    45 (seconds)
  • Example
    introscope.apm.agentcontrol.agent.reconnect.wait=45
  • Notes
    This setting is deployed using hot configuration.
    The minimum value is 45. If the value is set to less than 45, then the value defaults to 45.
    To avoid many simultaneous agent connections, the Enterprise Manager adds to the property value a random number of seconds from this set of values: -30, -15, 0, 15, 30. The Enterprise Manager at random chooses one of the calculated values and gives the value to the agent. The agent waits for the given period before trying to reconnect.
    For example, if the value is set to 60, the Enterprise Manager adds 60 to -30,-15, 0, and 15. The Enterprise Manager created this set of calculated values: 30, 45, 60, 75, and 90. The Enterprise Manager at random chooses 75, and gives the value to the agent. The agent waits for 75 seconds, before trying to reconnect.
introscope.enterprisemanager.agentconnection.metrics.enable
Controls whether or not the Enterprise Manager generates agent connection metrics. You can set this to True or False.
This property is not included in the Enterprise Manager properties file. To change the value, add the property to the properties file and restart the Enterprise Manager to enable the property.
Default
True
introscope.enterprisemanager.agentconnection.metrics.agentTimeoutInMinutes
Specifies how many minutes after an agent disconnect the Enterprise Manager stops generated connection metrics for the agent.
Once an agent disconnects from the Enterprise Manager, Introscope continues to generate disconnected state metrics until the agent is timed out. When an agent times out, no additional connection metrics are generated or reported to the Enterprise Manager.
When an agent disconnects, the Enterprise Manager changes the agent "ConnectionStatus" from 1 to 3. After 30 minutes (default) this metric stops reporting in Investigator.
This property is not included in the Enterprise Manager properties file. To change the value, add the property to the properties file and restart the Enterprise Manager to enable the property.
Default
30 (minutes)
introscope.enterprisemanager.agent.disallowed.connection.limit
Limits the number of agents that are configured as disallowed that can passively connect to an Enterprise Manager. Passively connected agents do not send any metric data.
This clamp property applies to the MOM, standalone Enterprise Managers, and Collectors.
When this clamp is hit and a disallowed agent tries to connect, the Enterprise Manager denies the new connection. In addition, the Enterprise Manager logs this activity and the agent is added to the APM Status console Denied Agents list.
Default
0 (unlimited)
Example
introscope.enterprisemanager.agent.disallowed.connection.limit=0
Notes
This setting is deployed using hot configuration.
This property is valid for 9.1 and later agents.
If this property is set on the MOM, the MOM value does not override the Collector value.
introscope.enterprisemanager.autoUnmountDelayInMinutes
Number of minutes the Enterprise Manager continues to track an agent after the agent is disconnected, in case the disconnection is temporary. After this time runs out, the Enterprise Manager releases agent tracking resources.
Default
60 (minutes)
Note
If both introscope.enterprisemanager.agentconnection.metrics.agentTimeoutInMinutes and introscope.enterprisemanager.autoUnmountDelayInMinutes are configured be sure the introscope.enterprisemanager.autoUnmountDelayInMinutes value is greater than or equal to the introscope.enterprisemanager.agentconnection.metrics.agentTimeoutInMinutes value.
Enterprise Manager failover
The following properties allow you to enable and apply failover settings, which can be used for enterprise managers that share the installation directories. When setting the properties, you may want to consider the Enterprise Manager failover rules.
introscope.enterprisemanager.failover.enable
This property enables failover.
Default
false
introscope.enterprisemanager.failover.primary
This property allows you to set the hostname or IP address of the primary Enterprise Manager. To configure both Enterprise Managers as primary, set to a comma-separated list of hostnames or IP addresses of the primary Enterprise Managers. For example, when both Enterprise Managers are configured as primary:
introscope.enterprisemanager.failover.primary=myhost1, myhost2
.
If you configure Enterprise Manager failover for a single host rather than a shared file system, the primary Enterprise Manager must be set to itself. Also, the
introscope.enterprisemanager.failover.secondary
property must be blank.
Default
<blank>
introscope.enterprisemanager.failover.secondary
This property allows you to set the hostname or IP address of the secondary Enterprise Manager by specifying the hostname or IP address of the Enterprise Manager's host. For example,
introscope.enterprisemanager.failover.secondary=myhost2
.
Default
<blank>
introscope.enterprisemanager.failover.interval
This property allows you to set in seconds how often a running secondary Enterprise Manager checks to see if a primary Enterprise Manager is waiting to start. This setting is deployed via hot configuration.
Default
120 (2 minutes)
Configuration directory
This property, in the EM Config Directory section, allows you to specify the location of the Enterprise Manager
config
directory.
introscope.enterprisemanager.directory.config
The directory the Enterprise Manager uses for configuration. In Windows, backslashes must be escaped (doubled). For example:
C:\\Introscope\\config
Default
The config directory in the original Introscope installation.
Location Map data
These properties allow you to configure settings on the Location Map.
introscope.workstation.locationmap.clamp
The property controls the maximum number of elements the location map can contain. The effect of the clamp is to control the size of the location map.
Notes
When the number of elements returned exceeds the clamp's value, some map elements are not displayed. Users will see an error message informing that some elements are not displayed.
Default
500
Web Services
Users who access the web services APIs on a regular basis may notice a performance degradation due to a high number of web services calls. The number of threads devoted to web services is set, by default, to 10. You can change this setting by adding a property to the IntroscopeEnterpriseManager.properties file.
introscope.apm.model.webservices.threadpool.numberofthreads
This property specifies the number of threads used in a thread pool. Use of this property is optional.
Warning!
Setting this property to a large number may cause performance degradation. Use caution in setting this property.
  • Constraint
    Must be an integer.
  • Default value
    10
  • Example
    introscope.apm.model.webservices.threadpool.numberofthreads=15
Outgoing message queue
These properties allow you to configure outgoing message queue settings.
transport.outgoingMessageQueueSize
This property specifies the number of messages in the outgoing message queue.
  • Note
    Increasing the outgoing message queue size uses more RAM.
  • Constraint
    Must be an integer.
  • Default value
    3000
  • Example
    transport.outgoingMessageQueueSize=3000
transport.override.isengard.high.concurrency.pool.max.size
This property specifies the maximum number of threads for simultaneous output socket connections. A higher number does not directly improve response time, but keeps isolated slow connections from greatly slowing the Enterprise Manager.
The default, 5, is suitable for most standalone Enterprise Managers and Collectors. MOMs should have one thread per Collector, plus about one thread for every 10 Workstations.
Because of their role as a network traffic router, MOMs in particular can benefit from having more outgoing threads. Not only because it can allow them to simultaneously service more Workstations, but also because it helps keep the entire cluster from freezing when a single Collector is overloaded.
Do not oversize, as additional thread overhead may cause OutOfMemory exceptions, especially on 32 bit JVMs
  • Constraint
    Must be an integer.
  • Default value
    5
  • Example
    transport.override.isengard.high.concurrency.pool.max.size=5
Thread dumps
These properties allow you to configure thread dumps.
introscope.enterprisemanager.threaddump.enable
This property enables the Thread Dumps tab on the metric browser tree agent node for any agent connected to an Enterprise Manager.
Notes
This property is hot configurable. If you change this property, you do not need to restart the Enterprise Manager for the changes to take effect.
This property works together with the IntroscopeAgentProfile introscope.agent.threaddump.enable property.
When this property is set to
true
and the IntroscopeAgentProfile introscope.agent.threaddump.enable property is set to
true
, then users can see the Thread Dumps tab.
When this property is set to
false
, then users cannot see the Thread Dumps tab.
Default
true
introscope.enterprisemanager.threaddump.storage.dir
Specifies the directory, relative to the Enterprise Manager home directory, where thread dumps are stored.
Notes
This property is not hot configurable. If you change this property, restart the Enterprise Manager for the changes to take effect.
<
EM_Home>
/threaddumps is not the directory where users save thread dump text files. Users can save thread dump text files to any location.
Default
threaddumps
introscope.enterprisemanager.threaddump.storage.clean.disk.freq.days
How often, in days, that Introscope purges thread dump files.
Notes
This property works with the introscope.enterprisemanager.threaddump.storage.clean.disk.olderthan.days property. Set them both so that the Enterprise Manager knows how long to store and purge thread dump files.
This property is not hot configurable. If you change this property, restart the Enterprise Manager for the changes to take effect.
Default
1 (day)
introscope.enterprisemanager.threaddump.storage.clean.disk.olderthan.days
The age, in days, after which Introscope purges thread dump files.
Notes
This property works with the introscope.enterprisemanager.threaddump.storage.clean.disk.freq.days property. Set them both so that the Enterprise Manager knows how long to store and purge thread dump files.
This property is not hot configurable. If you change this property, restart the Enterprise Manager for the changes to take effect.
Default
30 (days)
introscope.enterprisemanager.threaddump.storage.max.disk.usage
The number of thread dumps that can be stored on the Enterprise Manager.
Notes
This property is not hot configurable. If you change this property, restart the Enterprise Manager for the changes to take effect.
  • Constraint
    Must be an integer 8000 or less
  • Default value
    5000
Threads Property for Web Services Performance Handling
Users who access the web services APIs on a regular basis notice performance degradation due to a high number of web services calls. The number of threads devoted to web services is set, by default, to 10. You can change this setting by adding a property to the IntroscopeEnterpriseManager.properties file.
  • Name of property
    introscope.apm.model.webservices.threadpool.numberofthreads
  • Description
    Specifies the number of threads used in a thread pool. Use of this property is optional.
  • Constraint
    Must be an integer.
  • Default value
    10
  • Example
    introscope.apm.model.webservices.threadpool.numberofthreads=15
To use this property:
  1. Open the IntroscopeEnterpriseManager.properties file for editing.
  2. Add the introscope.apm.model.webservices.threadpool.numberofthreads property and specify a value.
    Setting this property to a large number cause performance degradation. Use caution in setting this property.
  3. Save and close the properties file.
The Enterprise Manager must be restarted after the IntroscopeEnterpriseManager.properties file is edited for the change to take effect.
SNMP Triage Map Alert Actions
The SNMP triage map alert action plug-ins are installed as part of the Enterprise Manager installer. Set these configurations to specify SNMP triage map alert action properties.
The SNMP triage map alert action plug-in properties are different from the existing SNMP alert action adapter properties. You can distinguish the new SNMP triage map alerts by their prefix,
introscope.apm.catalyst.triagemapalert.snmp
.
introscope.apm.catalyst.triagemapalert.snmp.destination.host.ip
Set this property with the IP address of the APM connector.
introscope.apm.catalyst.triagemapalert.snmp.destination.trap.port
Set this property with the SNMP port where the SNMP traps are sent.
Default
162
Example
introscope.apm.catalyst.triagemapalert.snmp.destination.trap.port=162
introscope.apm.catalyst.triagemapalert.snmp.community
Set this property with the SNMP community string.
Default
public
Example
introscope.apm.catalyst.triagemapalert.snmp.community=public
introscope.apm.catalyst. triagemapalert.snmp.trigger
Set this property with the trigger type desired for SNMP trap notifications.
Default
3
Options
1
Each Period while Problem Exists
  • 2
    When Severity Increases
  • 3
    Whenever Severity Changes
  • 4
    Report Only Final State Whenever Severity
Example
introscope.apm.catalyst. triagemapalert.snmp.trigger=3
Secure Store
Settings define which encryption algorithm is used for encrypting sensitive data in the secure store. APM currently supports only one algorithm with settings value AES128 which is an algorithm AES/CBC/PKCS5Padding. Other algorithms recommended by security authorities might be added later if AES/CBC/PKCS5Padding is compromised.
introscope.secure.store.encryption.algorithm
Value:
AES128
Session Timeout
Set this property to enable timeout (in minutes) of user inactivity in ATC UI, WebView, and Workstation.
Notes
Set this value to an integer greater than zero. Zero (default) disables the timeout. If the timeout is enabled, the user is automatically logged out after inactivity.
Default
0
Example
introscope.apmserver.ui.inactivityLogoutTimeout=60
JavaScript Calculator
introscope.enterprisemanager.javascript.dir
This property defines the directory path of Javascript. This property is hidden and must be added manually to the properties file.
Example - Windows
introscope.enterprisemanager.javascript.dir=D:\\scripts\\apm\\webview
The slash (\) must be escaped when defining a Windows path.
Example - Linux
introscope.enterprisemanager.javascript.dir=D:\scripts
introscope.enterprisemanager.javascript.refresh
This property defines the frequency of deploying the scripts available in the scripts directory. This property is hidden and must be added manually to the properties file.
Default
60
Example
introscope.enterprisemanager.javascript.refresh=60