10. MODIFICATION › 10.2 Standard User Exits › 10.2.4 Analyzer Output Exits
10.2.4 Analyzer Output Exits
This section provides a description of the CA MICS VM and CMS
Analyzer standard user exits that are invoked during the
post-processing phases of the daily update processing flow.
Each exit description includes the name and title, a
description of its purpose, when it is invoked, and whether
it has an interface to the CA MICS Installation Accounting
Component. It also shows which data elements are available
and any special considerations that should be taken into
account.
USRSVXM VMCVXC - VM Exception Activity
Intermediate file
INVOCATION: Each exit is given control during the Input Raw
Monitor Data Phase, immediately prior to the observation
being written to the work file. At this point, no delta
values have been calculated for any element that originates
with a period-to-date counter. PRFMIDLE is an example of
this type of element.
ACCOUNTING INTERFACE: Not Applicable
USES: These exits may be used to drop the current
observation from the database.
ELEMENTS AVAILABLE: All elements in the file to which the
observation will be written.
CODING RESTRICTIONS:
This exit should not contain code that executes a LINK or
RETURN statement. A GOTO statement may only reference a
label defined within the exit.
SPECIAL NOTES:
+---------------+
| U S R S f f f | VMC File Output Exits for Account Data
+---------------+
DESCRIPTION: These exits are used to edit the current
observation before it is written to the DETAIL file, and to
invoke the Accounting Journal file code in CA MICS Accounting
and Chargeback.
exit: USRSCMU file: VMCCMU - User Resource Accting file
USRSDAC VMCDAC - Device Accounting file
USRSVRA VMCVRA - RSCS Accounting file
USRSNTU VMCNTU - Network Accounting file
USRSNDT VMCNDT - Network Data Transmissions
File
INVOCATION: These exits are invoked during the Account Data
Post-Processing Phase immediately before the observation is
passed to the Accounting Journal Interface routine, before
being written to the DETAIL file.
ACCOUNTING INTERFACE: These exits call the Accounting
Journal Interface.
USES: This exit may be used to drop the current observation
from the database and to set elements that are used in the
CA MICS Accounting and Chargeback structure.
ELEMENTS AVAILABLE: All elements in the file to which the
current observation will be written.
WRK_FILE - The name of the file to which the observation
will be written.
Values: VMCCMU, VMCDAC, VMCVRA, VMCNTU,
VMCNDT
CODING RESTRICTIONS: Not Applicable
SPECIAL NOTES: Each of these exits invokes two other exits
by default. These are the USRUfff exit for the file and the
USRUJff journal interface exit for the file.
SAMPLE USER EXIT:
MACRO _USRSCMU
_USRUCMU /* USER EXIT */
_USRUJCM /* JOURNAL INTERFACE */
SKIP_REC = YES; /* DROP ALL DETAIL DATA */
%
+---------------+
| U S R U f f f | VMC File Modification Exits for Account
+---------------+ Data
DESCRIPTION: These exits are used to allow installation-
specific processing prior to execution of CA MICS Accounting
and Chargeback interface code. This processing may include
creation of additional variables added to the file by the
installation.
exit: USRUCMU file: VMCCMU - User Resource Accting file
USRUDAC VMCDAC - Device Accounting file
USRUVRA VMCVRA - RSCS Accounting file
USRUNTU VMCNTU - Network Accounting file
USRUNDT VMCNDT - Network Data Transmissions
File
INVOCATION: These exits are invoked during the Account Data
Post-Processing Phase by the corresponding _USRSfff exit for
the file immediately before the observation is passed to the
Accounting Journal Interface routine, before being written to
the DETAIL file.
ACCOUNTING INTERFACE: These exits may modify or create
elements used by the Accounting Journal Interface.
USES: These exits may be used to determine the contents of
elements, which cannot be determined directly from the disk
itself.
ELEMENTS AVAILABLE: All elements in the file to which the
current observation will be written.
WRK_FILE - The name of the file to which the observation
will be written.
Values: VMCCMU, VMCDAC, VMCVRA, VMCNTU,
VMCNDT
CODING RESTRICTIONS:
This exit should not contain code that executes a LINK or
RETURN statement. A GOTO statement may only reference a
label defined within the exit.
SPECIAL NOTES: Not Applicable
SAMPLE USER EXIT:
MACRO _USRUCMU
/* ------ ASSIGN CMUXMODE FOR DVMS AND GUESTS ------- */
SELECT (USER);
WHEN ('MVS') CMUXMODE = 'GUEST';
WHEN ('RSCS') CMUXMODE = 'GUEST';
OTHERWISE; /* - USE DEFAULT VALUES - */
END;
%
+---------------+
| U S R S f f f | VMC File Output Exits for VM Monitor Data
+---------------+
DESCRIPTION: These exits are used to edit the current
observation before it is written to the work file. The name
of each exit corresponds to the name of the file for which
the observation is to be output:
exit: USRSSGP file: VMXSGP - System Global Performance
USRSSCF VMXSCF - System Configuration
USRSSPP VMXSPP - System Processor Performance
USRSPCF VMXPCF - Processor Configuration
USRSDCF VMXDCF - Device Configuration
USRSXDV VMXXDV - Device Activity
USRSXDS VMXXDS - Devices SEEKs data
USRSACF VMXACF - CPVOL Configuration
USRSCPV VMXCPV - CP Owned Volume Data
USRSVXF VMXVXF - User Data Configuration
USRSVXT VMXVXT - User Interaction Sample Data
USRS_VT VMX_VT - User Interaction Event Data
USRSVXU VMXVXU - User Activity Sample Data
USRS_VU VMX_VU - User Activity Event Data
USRSCHC VMXCHC - Channel Path Contention Data
USRSBPG VMXBPG - Block Paging Data
USRSXSF VMXXSF - Shared System Configuration
USRSXSS VMXXSS - Shared System Management
USRSCDI VMXCDI - DASD Cache Activity Data
USRSCDP VMXCDP - Paging Cache Activity Data
USRSLPR VMXLPR - LPAR Activity Data
USRSLCP VMXLCP - LPAR CPU Activity Data
USRSSCX VMXSCX - Scheduler Parameters
USRSASC VMXASC - Shared Address Spaces Work
file
USRSVXX VMCVXC - VM Exception Activity
Intermediate file
USRSLXP LNXLXP Linux Process Activity
Sample Data
USRTLXP Linux Process Activity
for Detail Tape
USRXLXP Linux Process Activity when
DETAIL on disk
USRDLXP Linux Process Activity in
DAYS
INVOCATION: Each exit is given control during the Input VM,
z/VM Monitor Data Phase, immediately prior to the observation
being written to the work file. At this point, no delta
values have been calculated for any element that originates
with a period-to-date counter. SGPCPUTM is an example of
this type of element.
ACTIVATION of the USRSLXP exit is invoked using the indirect
exit convention described in section 4.3.1.2 of the System
Modification Guide. See this section for a detailed
discussion of indirect exit coding.
ACCOUNTING INTERFACE: Not Applicable
USES: These exits may be used to drop the current
observation from the database.
ELEMENTS AVAILABLE: All elements in the file to which the
observation will be written.
CODING RESTRICTIONS:
This exit should not contain code that executes a LINK or
RETURN statement. A GOTO statement may only reference a
label defined within the exit.
SPECIAL NOTES:
USRSVXU: Elements in the VMXSGP file that are summed from
elements in the VMXVXU file will be understated if VMXVXU
observations are dropped. These elements include active
users and estimated working set size.
USRSCHC: The VMXCHC file can contain up to 256
observations per monitor interval, that is one per CHPID
available to the VM system. Many of the 256 CHPIDs will
have no devices attached to them. An array is constructed
in VMCMXAFI during input that contains the number of
devices attached to each channel path. This array can be
tested in USRSCHC to determine whether or not an
observation should be written to the work file when no
devices attached to the CHPID are represented by the
observation.
Example:
SKIP_REC = CHPID(CHCHPID+1) < 1;
An alternative method for bypassing these observations has
been provided. The SAS macro variable &CHP_SEL can be set
to cause all observations that represent CHPIDs without
attached devices to be dropped automatically. This
variable can be set in #VMCEXIT outside any macro. The
default setting is to keep these observations.
Example:
automatically drop observations:
%LET CHP_SEL = YES; ...or... %LET CHP_SEL = 1;
keep all observations (the default):
%LET CHC_SEL = NO; ...or... %LET CHP_SEL = 0;
SAMPLE USER EXITS:
MACRO _USRSSGP
IF ZONE NE 1 THEN SKIP_REC = YES; /* KEEP PRIME SHIFT */
%
MACRO _USRSCHC
SKIP_REC = CHPID(CHCHPID+1) < 1; /* drop unused CHPIDs */
%
+---------------+
| U S R D L X P | DAYS Linux Process Activity File Exit
+---------------+
DESCRIPTION: This exit allows access to the data elements
used to build records in the DAYS Linux Process Activity
(LNXLXP) File. This exit follows the same conventions as all
other input exits; therefore, any record subsetting affects
not only the DAYS timespan but all higher timespans as well.
INVOCATION: This exit gains control immediately prior to the
output of records to the DAYS Linux Process Activity
(LNXLXP).
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback.
USES: This exit is used to add or change data elements or to
delete observations from the DAYS Linux Process Activity
file. To exclude an observation, set SKIP_REC to one.
ELEMENTS AVAILABLE: All elements in the DAYS Linux Process
Activity File.
ACTIVATION: The USRDLXP exit is invoked using the indirect
exit convention described in section 4.3.1.2 of the System
Modification Guide. See this section for a detailed
discussion of indirect exit coding.
+---------------+
| U S R X L X P | DETAIL Only File Exits
+---------------+
DESCRIPTION: USRXfff exit is available for the Linux Process
Activity (LNXLXP) File.
- The USRXLXP exit is invoked during the initial output of
Linux Process Activity File.
User code in the USRXLXP exit only modifies observations that
are output to the DETAIL timespans for the LNXLXP file.
These modifications are not propagated to the DAYS and higher
timespans.
For example, using the USRXLXP exit to restrict output of
Linux process activity records, where the Linux USER name
begins with "LX1" to the DETAIL LNXLXP01 Linux Process
Activity file has no impact on the observations summarized in
the DAYS and higher timespan LNXLXP files.
INVOCATION: Exit gains control in the SAS data step that
creates the DETAIL timespan LNXLXP00 file in
sharedprefix.MICS.SOURCE(VMCLINXO).
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback.
USES: The USRXfff exits allow subsetting and data element
modification that is restricted to the DETAIL timespan LNXLXP
file.
If you choose to create a DETAIL timespan file for the LNXLXP
file on tape rather than on DASD, use the USRTfff exit.
ELEMENTS AVAILABLE: All elements in the Linux Process
Activity File.
ACTIVATION: The USRDLXP exit is invoked using the indirect
exit convention described in section 4.3.1.2 of the System
Modification Guide. See this section for a detailed
discussion of indirect exit coding.
SAMPLE USER EXIT - USRXLXP:
DESCRIPTION: This sample exit drops Linux processes with the
process name of 'ABC'.
/* */
/* Drop all Linux process with the process name of */
/* 'ABC'. */
/* */
/* */
IF LNXPNAME NE: 'ABC' THEN SKIP_REC=1 ;
+---------------+
| U S R T f f f | DETAIL Tape Data Selection Exit
+---------------+
DESCRIPTION: The USRTfff exits provide access to DETAIL file
records prior to their output to DETAIL tape data sets. See
Chapter 7 of this guide for information about DETAIL tape
processing and a list of eligible component files.
INVOCATION: The USRTfff exit is invoked prior to output to
DETAIL tape files.
ACCOUNTING INTERFACE: No interface is provided.
USES: Use this exit to limit the amount of data that is
written to DETAIL tape files, or to modify the contents of
data elements written to DETAIL tape files. Note that
USRTfff exit code only affects the DETAIL tape file content
for a particular file (fff). It has no impact on the normal
unit database content for the same file (fff).
ELEMENTS AVAILABLE: All elements in the DETAIL timespan of
the file.
ACTIVATION: The USRTfff exits are invoked using the indirect
exit convention described in section 4.3.1.2 of the System
Modification Guide. See this section for a detailed
discussion of indirect exit coding.
All of the USRTfff indirect exits are activated in
sharedprefix.MICS.SOURCE($cccEXIT). In $cccEXIT, you will
find the following statement for each file (fff) eligible for
DETAIL tape:
%LET USRTfff = ;
The exit is activated by providing a member name to the right
of the equal sign:
%LET USRTfff = exitname ;
If you code an exitname, you MUST create a member in each
unit's prefix.MICS.USER.SOURCE library with that name.
Provide valid SAS code in the member. This code will be
invoked prior to the output of records to the DETAIL tape
file.
Example:
sharedprefix.MICS.SOURCE($VMCEXIT):
%LET USRTLXP = LXPTEXIT ;
prefix.MICS.USER.SOURCE(LXPTEXIT):
IF LNXPNAME NE 'PRO1' THEN SKIP_REC=1 ;
In this example, LXPTEXIT was chosen as the name for the
DETAIL tape exit for the LNXLXP file. Member LXPTEXIT was
created in the unit level prefix.MICS.USER.SOURCE library for
each unit where DETAIL tape was activated for the LNXLXP
file.
The exit was coded to limit the records written to the DETAIL
tape file to those from a particular queue manager, QMN1.
Note: The exit member name must be identical in each unit's
prefix.MICS.USER.SOURCE library, but the contents of each
member can be different (or identical) for each unit.
CODING RESTRICTIONS: Ensure that you have activated DETAIL
tape processing for a file, and executed VMCPGEN prior to
activating and coding USRTfff exits.
