Starting Your Product › Configure the Cross-Enterprise APM Agent › Configure the Cross-Enterprise_APM_Dynamic.properties File

Configure the Cross-Enterprise_APM_Dynamic.properties File

The Cross-Enterprise_APM_Dynamic.properties file is the main configuration file, in that it allows you to specify these settings for CA Cross-Enterprise APM:

• Top worst performing transactions to retain
• Regular expression pattern to filter which CICS regions to monitor
• Regular expression pattern to filter which transaction groups to monitor
• Regular expression pattern to filter which queue managers to monitor
• Regular expression pattern to filter which queues to monitor
• Regular expression pattern to filter which IMS subsystems to monitor
• Regular expression pattern to filter which IMS transaction groups to monitor
• Regular expression pattern to filter which CA Datacom/DB address spaces to monitor
• Regular expression pattern to filter which TCP/IP stacks to monitor
• Option to turn off collection of z/OS metrics
• Option to turn off collection of CA SYSVIEW metrics
• Option to turn off generation of CICS DB2 transaction traces
• Option to set the CA SYSVIEW XAPI time-out in seconds
• The format of the URL for the transaction trace click-through feature
• The frequency for which static metrics are reported
• The metric update interval for retrieving CA SYSVIEW metrics
• The parameters that are required to connect to a specific CA SYSVIEW
• The configuration options to turn off z/OS metric collection or metric collection completely
• The configuration options to allow distinct collection intervals for each metric category
• The following configuration properties must be properly set to collect metrics from one or more CA Insight DPM instances running on the local system:

  Insight.metrics.collect

  Determines whether metrics are collected from any CA Insight DPM instance running on the local system.

  • no indicates that DB2-specific metrics are not collected.
  • yes indicates that the Cross-Enterprise APM Agent attempts to contact the configured Xnet agent subtask of CA Insight DPM and retrieve DB2-specific metrics.

  Insight.connection.port

  Specifies the TCP/IP port that the local Xnet agent subtask of CA Insight DPM uses to listen for query requests. This Xnet agent subtask must be enabled and configured for the Cross-Enterprise APM Agent to collect DB2-specific metrics. The value corresponds to the PORT parameter for Xnet. CA APM uses this property with the Insight.connection.hostname property to connect to Xnet.

  Insight.passticket.support

  Determines whether to use PassTickets when sending authentication information to the Xnet agent subtask of CA Insight DPM. To use the PassTicket authentication, you require the following conditions:

  • Your active z/OS security manager must be properly configured to allow for the PassTicket creation.
  • The user account that is used to start the Cross-Enterprise APM Agent must have the proper permissions to create the PassTickets.
  • The Xnet agent subtask must be configured to allow for the PassTicket authentication.

  Important! When setting up PassTicket support, complete the security product configuration and enable Xnet PassTicket support before setting this property to "yes". If Xnet PassTicket support is not enabled and CA APM generates a PassTicket, the connection request fails. After some number of failed attempts, the security product will suspend that user ID.

  If this property is set to “yes”, PassTickets are used for the authentication instead of user passwords. If this property is set to “no”, specify a valid user password in the Insight.password configuration property.

  Insight.passticket.appl

  If the Insight.passticket.support property is set to “yes”, use this property to specify the application name for the generation of PassTicket authentication tokens. The Xnet agent subtask of CA Insight DPM must be configured to use this application name by specifying the same value in the PASSNAME() configuration parameter.

  Insight.username

  Specifies the user name that is sent to the Xnet agent subtask of CA Insight DPM for authentication. This property must always be specified, regardless of whether PassTicket support is enabled.

  Insight.password

  Specifies the user password sent to the Xnet agent subtask of CA Insight DPM for authentication. If PassTicket support is not enabled, this property must be specified. If PassTicket support is enabled, this property is blank. For security reasons, always use the PassTicket authentication to avoid storing unencrypted passwords in the configuration file.

• The following configuration properties identify the local DB2 entities from which you want to collect metrics:

  Insight.DB2.subsystem.name.list

  Specifies which local DB2 instances the Cross-Enterprise APM Agent monitors. A connection is established to each data collector instance of CA Insight DPM that is monitoring a DB2 subsystem in this comma-separated list. To collect metrics from all monitored local DB2 subsystems, specify the “*” wildcard character.

  Insight.DB2.group.name.list

  Specifies which local DB2 data sharing groups the Cross-Enterprise APM Agent monitors. A connection is established to each data collector instance of CA Insight DPM that is monitoring a DB2 data sharing group in this comma-separated list. To collect metrics from all monitored local DB2 data sharing groups, specify the “*” wildcard character.

  Insight.DB2.subsystem.name.list and Insight.DB2.group.name.list can specify monitored objects more precisely using advanced syntax.

  This value is comma-separated list of entries. Each entry has following format:

  db2_name_mask[&agent_name_mask]
  

  • db2_name_mask specifies a name mask for the DB2 subsystems or DB2 data sharing groups.
  • (Optional) agent_name_mask specifies a name mask for the Xnet agents that are connected to the local CA Insight DPM data collector monitoring the given DB2 resources. & acts as a separator.

  The mask is character string optionally with wildcards that match the whole actual name. A wildcard (the “*” character) matches zero or more characters in the name, for example:

  • * matches any name.
  • DB0* matches any name starting with DB0.
  • *DB* matches any name containing DB.

  The following examples show some use of the advanced syntax:

  • This example collects metrics from all DB2 subsystems with names starting with DA1 or DB2 (for example, DA1A or DB2A, but not DAT3):

    Insight.DB2.subsystem.name.list=DA1*,DB2*
    

  • This example collects metrics from DB2 subsystem DAT1 only if the subsystem is monitored through Xnet agent AGENT1:

    Insight.DB2.subsystem.name.list=DAT1&AGENT1
    

  • This example collects metrics from any DB2 subsystem that is monitored through Xnet agent AGENT1:

    Insight.DB2.subsystem.name.list=*&AGENT1
    

  • This example collects metrics from all DB2 data sharing groups that satisfy the following conditions:
    • Names ending with A or B
    • Monitored through the Xnet agents that have names containing string PROD

      Insight.DB2.group.name.list=*A&*PROD*,*B&*PROD*
      

• The remaining configuration properties in the Cross-Enterprise_APM_Dynamic.properties file that begin with the “Insight” prefix have default values that function properly for most installations.

  The following “Insight” configuration properties influence the collection performance of metrics from local DB2 subsystems:

  Insight.DB2.subsystem.refresh.interval

  Specifies how often the Cross-Enterprise APM Agent performs the following tasks:

  • Refresh the list of accessible DB2 subsystems.
  • Submit status queries to each subsystem.

  The default value is adequate for most situations, but this value can be changed if necessary.

  Default: Half the value of the Insight.update.interval parameter

  Insight.DB2.subsystem.refresh.threads

  Specifies how many operating system threads are used to process the tasks that are defined to run during the DB2 subsystem refresh interval. If you want the DB2 subsystem refresh interval to execute more quickly, increase the value. The increased value allows multiple tasks to execute simultaneously (at the cost of increased CPU consumption during the refresh interval).

  Default: 1, which means a single thread is used to issue status queries to each configured DB2 subsystem

  Insight.update.interval

  Specifies how often the Cross-Enterprise APM Agent retrieves updated metric values from each configured DB2 subsystem. The value can be increased, which decreases the rate configured DB2 subsystems have to process metric value queries.

  Default: Value of the SYSVIEW.update.interval property

  Insight.update.threads

  Specifies how many operating system threads are used to process the metric value queries for each configured DB2 subsystem. If you want the metric update interval to execute more quickly, increase the value. The increased value allows multiple queries to execute simultaneously (at the cost of increased CPU consumption during the metric update interval).

  Default: 1, which means the same thread is used to process sequentially each configured DB2 subsystem query

The properties file contains detail and examples, and lists the configuration options that help you determine what best suits your environment.

Follow these steps:

1. Open the Cross-Enterprise_APM_Dynamic.properties file, which is at /root/C7C4960/Cross-Enterprise_APM/config.
2. Edit and save the text file.

   The changes will be applied after the agent picks them up dynamically.