Application Performance Analyzer for z/OS, Version 11.1, Customization Guide

Started task configuration settings

This section describes how to configure the Application Performance Analyzer Listener started task to suit your installation.

The Application Performance Analyzer Listener started task obtains the configuration settings from a file allocated to DDname CONFIG. The file is a SYSIN-type member that you edit in order to change the settings. The member CAZCNFGL in hlq.SCAZSAMP contains the initial settings. A group of configuration settings is specified by a CONFIG statement. Settings are organized into categories or classes. Each CONFIG statement defines settings for a particular class. The general syntax for a CONFIG statement is illustrated here:

CONFIG class
keyword1=value1
keyword2=value2	// this is a comment
...
keywordn=valuen
; 			// end with semicolon

You must code a single keyword/value pair expression within a single line. It cannot span two lines. Separate keyword/value pair expressions from each other using one or more blanks. A CONFIG statement, including all its keyword/value pair expressions, must be terminated by a semicolon.

A CONFIG statement might be coded anywhere within columns 1 to 71 inclusive. An asterisk in column 1 denotes a comment line. A double slash (//) anywhere in the line indicates the remaining text in the line is a comment.

The following CONFIG BASIC statement, which is supplied in the predefined CAZCNFGL member, illustrates the CONFIG syntax.

  CONFIG BASIC             // Basic settings:
    ListenerID=CAZL        //  . ID
    HLQ=#yourhlq           //  . DSN HLQ for diagnostic
                           //    trace datasets
    PORT=8001              //  . Listener's port#
    UNIT=SYSALLDA          //  . unit name for new data set
    SECURITY=DISABLED      //  . no security checking
    MsgLevel=I             //  message level
    SessionTimeOut=0000    //  Session time out (never)
    KeepConnected=0000     //  ping interval    (never)

CONFIG statement parameters

Class
Specifies the category of settings that the CONFIG statement is to modify. The allowable values for class are:
keywordn
Specifies the name of the setting variable and is paired with a value expression in keyword=value format. The name is not case sensitive.
valuen
This is paired with a keyword name and specifies the value to be set.

CONFIG BASIC statement

BASIC settings allow you specify values for basic characteristics of the Application Performance Analyzer Listener installation. The following settings can be specified:

LISTENERID
Required. This is the Application Performance Analyzer Listener ID, a four-character value that uniquely identifies the Application Performance Analyzer Listener started task.
HLQ
Required. Specifies the high-level qualifier for data sets created by the Application Performance Analyzer Listener started task as part of its normal operation. The value that you specify for HLQ must comply with the JCL rule for specifying a data set name. It can be no more than 17 characters long.

Currently HLQ is used to allocate trace data sets used for diagnostic purposes.

Default: None.

PORT
Required. Specifies the 1 to 5 digit TCP/IP port number on which the Application Performance Analyzer Listener listens for client connections. The port number can be between 1 and 65,535 and must be unique to a single instance of the Application Performance Analyzer Listener. No other product is allowed to use the same port number. Application Performance Analyzer supports both secure and unsecure ports. Secure ports are required to enforce SSL communication in the Application Performance Analyzer GUI.

Avoid using ‘Well-Known' (privileged) port numbers as well as registered port numbers. Refer to the Internet Assigned Numbers Authority (IANA) at: www.iana.org for more information on assigned port numbers.

When the ListenTo setting is not specified, the Application Performance Analyzer Listener will listen on this port for every active TCP/IP stack that is defined on the z/OS image.

Default: None.

ListenTo
Optional. Specifies 1 to 9 specific TCP/IP stacks and port numbers on which the Application Performance Analyzer Listener listens for client connections. When not specified, the Application Performance Analyzer Listener will listen on the port specified in the PORT setting, of every active TCP/IP stack defined on the z/OS image. Application Performance Analyzer supports both secure and unsecure ports. Secure ports are required to enforce SSL communication in the Application Performance Analyzer GUI.

The syntax is ListenTo=(STACK=(procname,port) ... STACK=(procname,port))

STACK=(procname,port) is a unique TCP/IP stack and port number combination that may be repeated up to 9 times where:

Example:

PORT=8000
ListenTo=(STACK=TCPIP STACK=(TCPIP1,8001) STACK=(TCPIP2,8002) STACK=(TCPIP3,8003))

In this example, because the first STACK entry TCPIP has no port specified, the Application Performance Analyzer Listener will listen on port 8000, as specified on the PORT setting. TCPIP1 will listen on port 8001, TCPIP2 will listen on port 8002, and TCPIP3 will listen on port 8003.

UNIT
Optional. Specifies the unit name to be used when allocating all new trace data sets.

Default: SYSDA

Unit can be either a device type such as 3390, or esoteric such as SYSDA. A mount status of STORAGE or PUBLIC is non-specific and does not require a VOLSER. Application Performance Analyzer Listener does not allow a VOLSER to be specified.

On a non-SMS-managed system, you must ensure that the UNIT name you specified contains one or more volumes mounted as either STORAGE or PUBLIC. If there are no such volumes mounted, then Application Performance Analyzer Listener is unable to allocate critical files and terminates.

On an SMS-managed system, SMS ignores the unit parameter. To ensure SMS control over all data sets allocated by Application Performance Analyzer Listener, specify an HLQ value that is recognized and managed by SMS.

SECURITY
Optional. Specifies whether workstation users will have their user ID and password verified by the external security system, for example, RACF®. ENABLED and DISABLED are the only two valid choices.

Default: ENABLED

MSGLEVEL
Optional. Specifies the severity level of messages to be written to the log data sets. MsgLevel=I writes all messages.

Default: I

SESSIONTIMEOUT
Optional.

Specifies the length of time a workstation session is allowed to remain connected to the Application Performance Analyzer Listener until it is disconnected. In order for the session to remain connected, the workstation user must cause Application Performance Analyzer GUI to initiate activity with the Application Performance Analyzer Listener within the SESSIONTIMEOUT interval. This is to prevent the Application Performance Analyzer GUI users from monopolizing Application Performance Analyzer Listener sessions.

It must be specified as a four digit number. The value is in the form of: HHMM. Where HH is the number hours in the range of 00-99, and MM is the number of minutes in the range of 00-59. The maximum allowed connection time is 9959 or 4 days 3 hours and 59 minutes. The minimum allowed value is 5 minutes, except for a value of 0000 which indicates that session timeout will not be applied.

Note:
This value is not affected by the KEEPCONNECTED value if it also set.

Default: 0000

KEEPCONNECTED
Optional.

Specifies an interval in minutes. This a heart beat or pulse interval used by the Application Performance Analyzer GUI to ping the Application Performance Analyzer Listener once per interval. The purpose of this value is to keep the connection active. It is common when you are behind a NAT proxy or a firewall to be disconnected due to inactivity.

The maximum interval is 99 minutes. The minimum allowed value is 4 minutes, except for a value of 00 which indicates that no pings will be sent.

Note:
This value does not affect the SESSIONTIMEOUT value if it is also set.

Default: 00

DataHLQ
Optional.

Specifies the high-level qualifier used for data sets created by GUI requests to export observation files. The value that you specify for DataHLQ must comply with the JCL rule for specifying a data set name. It can be no more than 17 characters long.

Default: None.

CONFIG LOGFILE statement

Logging records activity within the Application Performance Analyzer Listener started task. Log data is always written to SYSOUT, but you have the option of also writing this data to log data sets. LOGFILE settings allow you manage these data sets. The following settings might be specified:

LogGDG
Optional. If you have specified LogToFile=YES, then LogGDG allows you to specify whether the log data sets are allocated as GDGs or normal sequential data sets. If you specify LogGDG=YES, you must first create the Generation Data Group Index using an index name of yourhlq.LLG (or LogHLQ.LLG if you choose to use LogHLQ). YES and NO are the only valid values.

Default: NO.

Note:
A GDG log file cannot be shared by multiple instances of Application Performance Analyzer Listener. A second started task with the same GDG log file fails on start up with messages IKJ56225I and CAZL034S. A unique GDG log file must be defined for each instance of Application Performance Analyzer Listener.
LogHLQ
Specifies the high-level qualifier to be used when creating log data sets. LogHLQ must comply with the JCL rule for specifying a data set name. It can be no more than 17 characters long. A data set is only created if LogToFile=YES is specified.

If this parameter is not specified, the value that you specify for HLQ on the CONFIG BASIC statement is used.

Default: None.

LogPRIM
Optional. If you have specified LogToFile=YES, then LogPRIM allows you to specify the size of each log data set that is allocated. No secondary specification is permitted. Therefore, when the log data set has filled, it is closed and a new log data set is allocated.

Default: 15.

LogToFile
Optional. Specifies whether you want log data to be written to permanent data sets. YES and NO are the only valid values.

Default: NO.

Note:
It is recommended that LogToFile be set to YES. The log can be used to help diagnose problems.
LogUNIT
Optional. If you have specified LogToFile=YES, then LogUNIT allows you to specify whether you want the log data set to be allocated in Tracks or Cylinders. T and C are the only valid values.

Default: T.

CONFIG APPL_WSFE statement

This statement defines configurable parameters for the Application Performance Analyzer Workstation Front-End application (GUI). The following parameter can be specified:

EnableEmail
Optional. Specifies whether the Application Performance Analyzer GUI is to enable its report email feature or not. YES and NO are the only valid values.

Default: YES

MAXOPENOBS
Optional. Specifies the maximum number of concurrent observations that each workstation connection is permitted to have open at any one time. Acceptable values are in the range of 2-9.

Default: 5.

CONFIG OPER statement

These settings pertain to operational parameters and should not be changed by the user. These should only be changed on the advice of IBM®. Application Performance Analyzer ships with only one parameter specified, which is DiagLevel=1.




Rate this page

[ Top of Page | Previous Page | Next Page | Contents | Index ]