@broadcom/mat-analyze-for-zowe-cli

v3.0.0

Published

2 months ago

MAT Analyze Plug-in for Zowe CLI

Downloads

0High
0Medium
0Low

MAT Analyze Plug-in for Zowe CLI

The MAT Analyze plug-in for Zowe CLI provides access to Mainframe Application Tuner (MAT) functionality. The plug-in ensures interaction with MAT and enables you to measure your mainframe applications and get the analysis data in the form of MAT analysis views using Zowe command line interface.

You can use the MAT Analyze plug-in for Zowe CLI to perform the following tasks:

Manage monitor profiles.
Create and invoke monitor profiles, view the lists of available profiles, and retrieve the measurement history.
Analyze the measurement data.
Access the measurement data from Mainframe Application Tuner that is available to you in the CLI in the form of MAT analysis views.
Address performance issues.
With the source program listing registered with MAT, users of Visual Studio Code (VS Code) IDE can obtain the Histogram details and display specific source program locations that are associated with the most resource-consuming program modules and CSECTs. When you request the Histogram measurement details from your VS Code command line terminal, the MAT Analyze plug-in for Zowe CLI transfers the source code listing to your local machine and navigates you directly to the specific line and column number of the source code, which enables you to immediately inspect the program statement and identify possible tuning opportunities.

Installation

You can install the MAT Analyze Plug-in for Zowe CLI from the Zowe Package.

Prerequisites

Before starting the installation of the MAT Analyze Plug-in for Zowe CLI, verify that you have:

Zowe CLI installed.
MAT database and the REST API installed, configured, and running.
(Optional) To use the automated listing registration and retrieval option through Endevor® footprints, install and configure the Endevor® Web Services and specify the Endevor® web server details in the MAT database configuration.

Install the MAT Analyze Plug-in for Zowe CLI From Packages

Issue the following command:

$ zowe plugins install @broadcom/mat-analyze-for-zowe-cli

Note:
The latest npm tag installs a version of the product that is intended for public consumption. You can use different npm tags to install other versions of the product. For example, you can install with the @beta tag to try new features that have not been fully validated. For more information about tag usage, see NPM Tag Names.

Validate the Installation

To validate the installation, issue the following command:

$ zowe plugins validate @broadcom/mat-analyze-for-zowe-cli

Successful validation of the plug-in returns the response "This plugin was successfully validated. Enjoy the plugin."

Create a MAT Profile

To enable the interaction of the MAT Analyze plug-in for Zowe CLI with MAT, you need to specify the MAT profile details that include the protocol type, host, and port that you defined for the MAT REST API server, and your mainframe username and password. The details of the MAT profile are stored in the Zowe configuration file. To create a global Zowe configuration file, use the command zowe config init --global-config, then edit the configuration file and add a section with the MAT profile details:

"mat": {
            "type": "mat",
            "properties": {
                "host": "example.com",
                "protocol": "http",
                "port": "12345",
                "user": "johndoe",
                "password": "qwerty",
                "listingDir": "c:\listings",
                "rejectUnauthorized": false
            },
            "secure": []
        },

Use MAT Profile Options

--protocol | --o (string)
Specifies the protocol defined for the MAT REST API server (http or https).
Allowed values: http, https.

--host | --H (string)
Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).

--port | --P (number)
Specifies the server port (e.g. 8080).

--user | --u (string)
Your mainframe username.

--password | --pw (string)
Your mainframe password.

--base-path | --bp (string)
The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.

--reject-unauthorized | --ru (boolean)
Reject self-signed certificates. Default value: true

--listingDir | --ldir (string)
Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration. The --listingDir parameter is optional.

If the details are not specified or if you want to temporarily use different MAT profile settings, you can specify all or some MAT profile details with each command. The MAT profile details that are provided with a command have the highest priority and override all other values. For more information about using profiles in Zowe, see Using Global Profile Configuration in the Zowe documentation.

Use Cases and Commands

The MAT Analyze plug-in for Zowe CLI enables you to manage monitor profiles and get the measurement analysis data using Mainframe Application Tuner (MAT).

$ zowe mat <group>

The MAT Analyze plug-in for Zowe CLI commands are organized in the following command groups:

PROFILE

The commands from the PROFILE group enable you to create, invoke, and list MAT monitor profiles.

Usage

$ zowe mat profile <command>

The following commands are available for the PROFILE group:

create | cr

Create a MAT monitor profile.

Usage

$ zowe mat profile create [options]

Required Options
--profile (string)
Specifies the name of the profile that you create in MAT (e.g. PROFILE1).
Values: 1 to 8 characters, a combination of alphanumeric and national characters (A-Z, 0-9, and @), the first character must be an alphabetic or @. The profile name must not contain characters # and $.

--jobname (string)
Specifies the name of the job that you want to measure (e.g. JOB1).
Values: 1 to 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).

--targsys (string)
Specifies the target system in SYSPLEX.
Values: a comma separated list of up to 4 values is allowed, 1-8 characters each, a combination of alphanumeric (A-Z and 0-9) and national (@,#,$), the first character must be an alphabetic (A-Z) or a national (@, #, $), e.g. AA31,AA32).

Options
--batchreports (string)
Specifies the setting for the Batch report option upon monitor completion.
Default value: no.
Allowed values: yes, no.

--description (string)
Provide the monitor description (maximum 24 characters).

--mondsn (string)
Specifies the monitor data set name where MAT saves the measurement (e.g. DEMO.MAT.MONITOR).
Values: data set name pattern, maximum 46 characters. If not specified, your default MAT monitor DSN pattern is applied.

--stepname (string)
Specifies the name of the job step to monitor.
Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).

--mstep (string)
Indicates whether the multi-step monitoring option is enabled.
Default value: no.
Allowed values: yes, no.

--procstep (string)
Specifies the name of the procedure step.
Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).

--program (string)
Specifies the name of the program to monitor.
Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).

--elapstime (string)
Specifies the required monitor duration followed by s (seconds) or m (minutes) (e.g. 60s).
Values: maximum 6 characters total, number must be > 0.
Default value: 60s.

--smon (string)
Specifies whether to monitor the entire step.
Default value: no.
Allowed values: yes, no.

--tasklib (string)
Specifies an additional DD name for load modules.
Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).

--samplecnt (string)
Specifies the number of observations requested.
Values: maximum 6 characters, numbers between 10 and 999999.
Default value: 6000.

--succnt (string)
Specifies the maximum number of monitors to run per job execution. Values: maximum 4 characters, numbers between 1 and 9999.
Default value: 1.

--reccnt (string)
Specifies the number of times this job step will be monitored. Values: maximum 4 characters, numbers between 1 and 9999.
Default value: 1.

--sampdelay (string)
Specifies the delay monitoring time in seconds after the step start. Values: maximum 4 characters, numbers between 0 and 9999.
Default value: 0.

--userexit1 (string)
Specifies the name for the call user written Data Base.
Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. DBEXIT1).

--userexit2 (string)
Specifies the name 1 for the call user written 4GL exit programs for this monitor.
Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. UEXIT1).

--userexit3 (string)
Specifies the name 2 for the call user written 4GL exit programs for this monitor.
Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. UEXIT2).

--inctask (string)
Specifies the task name to define the tasks that you want to sample in a multitasking environment and restrict monitoring to the specific subtask within the address space.
Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. INC31,INC32).

--exctask (string)
Specifies the task name to omit from sampling in a multitasking environment.
Values: a comma separated list of up to 4 values is allowed, max. 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. EXC31,EXC32).

--tran (string)
Specifies the CICS transaction code name to monitor.
Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. TRAN1,TRAN2).

--term (string)
Specifies the CICS terminal IDs to monitor.
Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. TERM1,TERM2).

--userid (string)
Specifies the CICS user IDs to monitor.
Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. USER1,USER2).

--db2expl (string)
Indicates whether the Explain SQL option is enabled for DB2 SQL statements.
Default value: no.
Allowed values: yes, no.

--db2ctsql (string)
Indicates whether the Collect SQL from Catalog option is enabled for DB2 SQL statements. If you specify db2expl=yes, then db2ctsql must be also set to yes.
Default value: no.
Allowed values: yes, no.

--db2hvloc (string)
Indicates whether the Requestor Location option is enabled for DB2 measurements.
Default value: no.
Allowed values: yes, no.

--db2hvcor (string)
Indicates whether the Correlation ID option for SQL statements is enabled for DB2 measurements.
Default value: no.
Allowed values: yes, no.

--db2hviid (string)
Indicates whether the Operator ID option for SQL statements is enabled for DB2 measurements.
Default value: no.
Allowed values: yes, no.

--db2hvthd (string)
Indicates whether the Thread Address option for SQL statements is enabled for DB2 measurements.
Default value: no.
Allowed values: yes, no.

--wasexprt (string)
Indicates whether the Expert Mode is enabled for Java measurement.
Default value: no.
Allowed values: yes, no.

--urlfilt (string)
A filtering string to restrict monitoring to the specific application URL, transaction, or stored procedure for Java measurements.
Values: a comma separated list of up to 4 values is allowed, max. 64 characters (e.g. mypage1.html,mypage2.html).

--sysfilt (string)
A filtering string to include the specified system class for Java measurements. If you specify a value for sysfilt, the measurement includes only the classes that match the filtering string pattern.
Values: a comma separated list of up to 3 values is allowed, max. 64 characters (e.g. user1.class,user2.class).

--schedule (string)
Specifies the name of the schedule that you want to apply to the monitor profile (maximum 8 characters).

Profile Options
--mat-profile | --mat-p (string)
Specifies the name of a (mat) profile to load for this command execution.

Examples

Create the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system:

$ zowe mat profile create --profile PROFILE1 --jobname JOB1 --targsys AA31

Create the PROFILE1 monitor profile to measure for 90 seconds job JOB1 that runs on the AA31 and AA32 systems:

$ zowe mat profile create --profile PROFILE1 --jobname JOB1 --targsys AA31,AA32 --elapstime 90s

Create the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system, with the specific MAT profile details defined:

$ zowe mat profile create --profile PROFILE1 --jobname JOB1 --targsys AA31 --host "example.com" --port 12345 --user johndoe --password qwerty

invoke | ivk

Invoke a MAT monitor profile to start measurement. If you invoke a monitor profile that does currently exist, MAT creates the profile with the provided name and invokes the measurement for this profile.

Usage

$ zowe mat profile invoke [options]

Required Options
--profile (string)
Specifies the name of the profile in MAT that you invoke (e.g. PROFILE1).
Values: 1 to 8 characters, a combination of alphanumeric and national characters (A-Z, 0-9, and @), the first character must be an alphabetic or @. The profile name must not contain characters # and $.

--jobname (string)
Specifies the name of the job to be measured (e.g. JOB1).
Values: 1 to 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).

--targsys (string)
Specifies the target system in SYSPLEX.
Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, a combination of alphanumeric (A-Z and 0-9) and national (@,#,$), the first character must be an alphabetic (A-Z) or a national (@, #, $) (e.g. AA31,AA32).

Options
--mondsn (string)
Specifies the monitor data set name where MAT saves the measurement (e.g. DEMO.MAT.MONITOR).
Values: data set name pattern, maximum 46 characters. If not specified, your default MAT monitor DSN pattern is applied.

--moiuuid (string)
Specifies the MOI UUID.
Values: maximum 61 characters, alphanumeric (A-Z and 0-9). If you use this parameter for command execution, the value cannot be blank.

--moitimestamp (string)
Specifies the MOI timestamp.
Values: maximum 12 characters, numbers only (0-9). If you use this parameter for command execution, the value cannot be blank.

--listing (boolean)
Activates automated registration of Cobol, C/C++, and Assembler program listings through Endevor® footprints. After completion of the measurement that you invoke with the '--listing' parameter, the MAT Analyze plug-in for Zowe CLI automatically retrieves the program listing that is associated with the monitored job and registers the listing with MAT. A registered program listing enhances the analysis possibilities of the 'codeview histogram' command and enables you to inspect the source code statements that are associated with specific modules and CSECTs.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system:

$ zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31

Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system and save the measurement result in the DEMO.MAT.MONITOR.PROFILE1 data set:

$ zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31 --mondsn DEMO.MAT.MONITOR.PROFILE1

Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system and register the program listing:

$ zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31 --listing

Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system, with the specific MAT profile details defined:

$ zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31 --host "example.com" --port 12345 --user johndoe --password qwerty

list | lip

Get the list of available monitor profiles.

Usage

$ zowe mat profile list [options]

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

MONITOR

The commands from the MONITOR group enable you to get monitor history and measurement analysis data from MAT.

Usage

$ zowe mat monitor <command|group>

The following commands are available for the MONITOR group:

history | hs

Get the list of all available measurements that are stored in the history of the specific monitor profile.

Usage

$ zowe mat monitor history [options]

Options
--profile (string)
Specifies the name of the profile.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the list of all available measurements that are stored in the history of the monitor profile TESTPROF:

$ zowe mat monitor history --profile TESTPROF

Get the list of all available measurements that are stored in the history of the monitor profile TESTPROF, with the specific MAT profile details defined:

$ zowe mat monitor history --profile TESTPROF --host "example.com" --port 12345 --user johndoe --password qwerty

overview | ov

Get the Overview details of the measurement.

Usage

$ zowe mat monitor overview [options]

Options
--profile (string)
Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.

--mon_num (number)
Specifies the unique monitor number of the measurement.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the measurement overview details for monitor number 5:

$ zowe mat monitor overview --mon_num 5

Get the measurement overview details for the latest monitor in the TESTPROF profile:

$ zowe mat monitor overview --profile TESTPROF

Get the measurement overview details for monitor number 5, with the specific MAT profile details defined:

$ zowe mat monitor overview --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty

The following subgroups are available for the MONITOR command group:

delayview

The commands from the DELAYVIEW group enable you to get the DelayView measurement details.

Usage

$ zowe mat monitor delayview <command>

The following commands are available for the DELAYVIEW group:

delay | de

Get the delay details for the measurement.

Usage

$ zowe mat monitor delayview delay [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the DelayView measurement details for monitor number 5:

$ zowe mat monitor delayview delay --mon_num 5

Get the DelayView measurement details for the latest monitor in the TESTPROF profile:

$ zowe mat monitor delayview delay --profile TESTPROF

Get the DelayView measurement details for monitor number 5, with the specific MAT profile details defined:

$ zowe mat monitor delayview delay --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty

address | ad

Get the delay address details for the measurement.

Usage

$ zowe mat monitor delayview address [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

--majorcategory (string)
Specifies the major delay category name identified for the analysis item (e.g. –-majorcategory "PC routine delay"). You get the majorcategory value from the 'delayview delay' command response.

--minorcategory (string)
Specifies the minor delay category name identified for the analysis item (e.g. –-minorcategory "PC CALL"). You get the minorcategory value from the 'delayview delay' command response.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the delay address details for majorcategory "PC routine delay" and minorcategory "PC CALL" for monitor number 5:

$ zowe mat monitor delayview address --mon_num 5 –-majorcategory "PC routine delay" –-minorcategory "PC CALL"

Get the delay address details for majorcategory "PC routine delay" and minorcategory "PC CALL" for the latest monitor in the TESTPROF profile:

$ zowe mat monitor delayview address --profile TESTPROF –-majorcategory "PC routine delay" –-minorcategory "PC CALL"

Get the delay address details for majorcategory "PC routine delay" and minorcategory "PC CALL" for monitor number 5, with the specific MAT profile details defined:

$ zowe mat monitor delayview address --mon_num 5 –-majorcategory "PC routine delay" –-minorcategory "PC CALL" --host "example.com" --port 12345 --user johndoe --password qwerty

codeview

The commands from the CODEVIEW group enable you to get the CodeView measurement details.

Usage

$ zowe mat monitor codeview <command>

The following commands are available for the CODEVIEW group:

module | mod

Get the CodeView measurement details in Module mode.

Usage

$ zowe mat monitor codeview module [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the CodeView measurement details in Module mode for monitor number 5:

$ zowe mat monitor codeview module --mon_num 5

Get the CodeView measurement details in Module mode for the latest monitor in the TESTPROF profile:

$ zowe mat monitor codeview module --profile TESTPROF

Get the CodeView measurement details in Module mode for monitor number 5, with the specific MAT profile details defined:

$ zowe mat monitor codeview module --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty

csect | cs

Get the CodeView measurement details in Csect mode.

Usage

$ zowe mat monitor codeview csect [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the CodeView measurement details in Csect mode for monitor number 5:

$ zowe mat monitor codeview csect --mon_num 5

Get the CodeView measurement details in Csect mode for the latest monitor in the TESTPROF profile:

$ zowe mat monitor codeview csect --profile TESTPROF

Get the CodeView measurement details in Csect mode for monitor number 5, with the specific MAT profile details defined:

$ zowe mat monitor codeview csect --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty

histogram | hsg

Get the Histogram details for the measurement.

Usage

$ zowe mat monitor codeview histogram [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

--module (string)
Specifies the module name that you request the Histogram data for. You get the module value from the 'codeview csect' or from the 'codeview module' command response. The module name can be empty (e.g., --module "IGZCPAC" or --module '""').

--csect (string)
Specifies the CSECT name that you request the Histogram data for. You get the csect value from the 'codeview csect' command response. The CSECT name can be empty (e.g., --csect "TUNCOB01" or --module '""').

--top (number)
Specifies the maximum number of the top consuming CSECT activity locations that you want to obtain in the response (e.g., --top 5). If you specify --top 0, you get the list of all CSECT activity locations that MAT has detected during the measurement. The --top parameter is optional. Values: numbers between 0 and 300.

--group (number)
Specifies the histogram group size parameter that defines the resolution of the histogram. If you do not specify the group parameter, the group size defaults to 4 bytes (e.g., --group 32). If program listing is registered with MAT, the group parameter is ignored. The --group parameter is optional.

--listing (boolean)
Enables you to retrieve program listing details that pertain to the specific CSECT and statement. To use the listing retrieval option, you must install and configure the Endevor® Web Services and have the program listing for the specific measurement registered with MAT. The source code listing is retrieved through Endevor® footprints for Cobol, C/C++, and Assembler programs. The program listing file is downloaded to your local directory that you specified with the 'listingDir' parameter for your MAT configuration profile. When you request the histogram details with the '--listing' option, the 'histogram' command returns the additional 'listing' column that contains a reference to the program listing with the specific CSECT name, program type, line and column number that pertain to the requested CSECT and statement, for example, c:\listings\SA420LE.asm:382:51. If you use Visual Studio Code (VS Code) IDE, you can click on the reference in the command response in your VS Code terminal to navigate directly to the indicated source program location. The --listing parameter is optional.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the Histogram details with the group size defaulting to 4 bytes for monitor number 5, CSECT name TUNCOB01, module name RUNCOB:

$ zowe mat monitor codeview histogram --mon_num 5 --csect "TUNCOB01" --module "RUNCOB"

Get the Histogram details for the latest monitor in the TESTPROF profile for CSECT name TUNCOB01, empty module name, with the group size value set to 32 bytes, and limit the number of returned rows to 5 top consumers:

$ zowe mat monitor codeview histogram --profile TESTPROF --csect "TUNCOB01" --module '""' --top 5 --group 32

Get the Histogram details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB, limit the number of returned records to 5 top consumers, and request the listing details:

$ zowe mat monitor codeview histogram --mon_num 5 --csect "TUNCOB01" --module "RUNCOB" --top 5 --listing

Get the Histogram details with the group size defaulting to 4 bytes for monitor number 5, CSECT name TUNCOB01, module name RUNCOB, with the specific MAT profile details defined:

$ zowe mat monitor codeview histogram --mon_num 5 --csect "TUNCOB01" --module "RUNCOB" --host "example.com" --port 12345 --user johndoe --password qwerty

callerid | cil

Get the CodeView CallerID details for the specific CSECT and module.

Usage

$ zowe mat monitor codeview callerid [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

--module (string)
Specifies the module name that you request the CallerID details for. You get the module value from the 'codeview csect' or from the 'codeview module' command response. The module name can be empty (e.g., --module "IGZCPAC" or --module '""').

--csect (string)
Specifies the CSECT name that you request the CallerID details data for. You get the csect value from the 'codeview csect' command response. The CSECT name can be empty (e.g., --csect "TUNCOB01" or --csect '""').

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the CallerID details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB:

$ zowe mat monitor codeview callerid --mon_num 5 --csect "TUNCOB01" --module "RUNCOB"

Get the CallerID details for the latest monitor in the profile for CSECT name TUNCOB01, and empty module name:

$ zowe mat monitor codeview callerid --profile TESTPROF  --csect "TUNCOB01" --module '""'

Get the CallerID details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB, with the specific MAT profile details defined:

$ zowe mat monitor codeview callerid --mon_num 5 --csect "TUNCOB01" --module "RUNCOB" --host "example.com" --port 12345 --user johndoe --password qwerty

db2

The commands from the DB2 group enable you to get the DB2 measurement details.

Usage

$ zowe mat monitor db2 <command>

The following commands are available for the DB2 group:

db2view | db2

Get the DB2View details for the measurement.

Usage

$ zowe mat monitor db2 db2view [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

--top (number)
Specifies the maximum number of the top consuming DB2 statements that you want to obtain in the response (e.g., --top 5). If you specify --top 0, you get the list of of all DB2 statements that MAT has detected during the measurement. The --top parameter is optional. Values: numbers between 0 and 300.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the DB2View details for monitor number 5:

$ zowe mat monitor db2 db2view --mon_num 5

Get the DB2View details for the latest monitor in the profile, with the top consumer limitation set to 5 top consumers:

$ zowe mat monitor db2 db2view --profile TESTPROF --top 5

Get the DB2View details for monitor number 5, with the specific MAT profile details defined:

$ zowe mat monitor db2 db2view --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty

sqlstmt | sql

Get SQL details for the DB2 statement.

Usage

$ zowe mat monitor db2 sqlstmt [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

--dbrm (string)
Specifies the DBRM/Package name that the requested DB2 statement belongs to (e.g., --dbrm CUPBTSDY). You get the dbrm value from the 'db2 db2view' command response.

--stmtnum (number)
Specifies the statement number that you request the SQL details for (e.g., --stmtnum 464). You get the stmtnum value from the 'db2 db2view' command response.

--totalsamps (number)
Specifies the total number of samples taken for the requested statement (e.g., --totalsamps 1). You get the totalsamps value from the 'db2 db2view' command response.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the DB2 SQL statement details for monitor number 5 for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1:

$ zowe mat monitor db2 sqlstmt --mon_num 5 --dbrm CUPBTSDY --stmtnum 464 --totalsamps 1

Get the DB2 SQL statement details for the latest monitor in the profile, for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1:

$ zowe mat monitor db2 sqlstmt --profile TESTPROF  --dbrm CUPBTSDY --stmtnum 464 --totalsamps 1

Get the DB2 SQL statement details for monitor number 5 for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1, with the specific MAT profile details defined:

$ zowe mat monitor db2 sqlstmt --mon_num 5 --dbrm CUPBTSDY --stmtnum 464 --totalsamps 1 --host "example.com" --port 12345 --user johndoe --password qwerty

idms

The commands from the idms group enable you to get the IDMS measurement details in DML mode.

Usage

$ zowe mat monitor idms <command>

The following commands are available for the IDMS group:

dml | dml

Get the IDMS measurement details in DML mode.

Usage

$ zowe mat monitor idms dml [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the dml measurement details for the latest monitor in the TESTPROF profile:

$ zowe mat monitor idms dml --profile TESTPROF

Get the dml details of the measurement for monitor number 5:

$ zowe mat monitor idms dml --mon_num 5

module | mod

Get the IDMS measurement details.

Usage

$ zowe mat monitor idms module [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

--module (string)
Specifies the module name that you request the details for. The module name can be empty (e.g., --module "IGZCPAC" or --module '""').

--taskid (number)
Specifies the identifier of the Task that you request the details for.

--ruid (number)
Specifies the identifier of the Run Unit that you request the details for.

--linecmd (string)
Specifies the line command to be used for the row data.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the idms details of the measurement for the latest monitor in the profile:

$ zowe mat monitor idms module --profile TESTPROF

Get the module details of the measurement for monitor number 5:

$ zowe mat monitor idms module --mon_num 5

Specify the module taskid, ruid, and linecmd option of the measurement for the module mode for the TESTPROF profile:

$ zowe mat monitor idms module  --profile TESTPROF --module SQLA01D  --taskid 1  --ruid 33333  --linecmd dispatch

task | ts

Get the IDMS measurement details in Task mode.

Usage

$ zowe mat monitor idms task [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the idms measurement details in Task mode for monitor number 5:

$ zowe mat monitor idms task --mon_num 5

Get the idms measurement details in Task mode for the latest monitor in the profile:

$ zowe mat monitor idms task --profile TESTPROF

ims

The commands from the ims group enable you to get the IMS measurement details.

Usage

$ zowe mat monitor ims <command>

The following commands are available for the IMS group:

imsview | imsv

Get the IMS View details for the measurement.

Usage

$ zowe mat monitor ims imsview [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the IMS View details for monitor number 5:

$ zowe mat monitor ims imsview --mon_num 5

Get the IMS View details for the latest monitor in the profile:

$ zowe mat monitor ims imsview --profile TESTPROF

dbdname | dbd

Get the IMS View DBDName data.

Usage

$ zowe mat monitor ims dbdname [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the IMS View DBDName details for monitor number 5:

$ zowe mat monitor ims dbdname --mon_num 5

Get the IMS View DBDName details for the latest monitor in the profile:

$ zowe mat monitor ims dbdname --profile TESTPROF

psbname | psb

Get the IMS View PSBName measurement details.

Usage

$ zowe mat monitor ims psbname [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the IMS View PSBName details for monitor number 5:

$ zowe mat monitor ims psbname --mon_num 5

Get the IMS View PSBName details for the latest monitor in the profile:

$ zowe mat monitor ims psbname --profile TESTPROF

region | reg

Get the IMS View Region measurement details.

Usage

$ zowe mat monitor ims region [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the IMS View Region details for monitor number 5:

$ zowe mat monitor ims region --mon_num 5

Get the IMS View Region details for the latest monitor in the profile:

$ zowe mat monitor ims region --profile TESTPROF

ssa | ssa

Get the IMS View Region measurement details.

Usage

$ zowe mat monitor ims ssa [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

--call (string)
Specifies the call details for the specified monitor number or profile name.

--dbdname (string)
Specifies the database details for the specified monitor number or profile name.

--psbname (string)
Specifies the PSB name details for the specified monitor number or profile name.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the IMS View SSA details for monitor number 5 with the specific MAT profile details defined:

$ zowe mat monitor ims ssa --mon_num 5 --call TESTCALL --dbdname TESTDBDNAME --psbname TESTPSBNAME

Get the IMS View SSA details for the latest monitor in the TESTPROF profile with the specific MAT profile details defined:

$ zowe mat monitor ims ssa --profile TESTPROF --call TESTCALL --dbdname TESTDBDNAME --psbname TESTPSBNAME

statement | stat

Get the IMS View Statement measurement details.

Usage

$ zowe mat monitor ims statement [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

--trancode (string)
Specifies the transaction name for specified monitor number or profile name.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the IMS View Statement details for monitor number 5 with trancode:

$ zowe mat monitor ims statement --mon_num 5 --trancode TESTTRANCODE

Get the IMS View Statement details for the latest monitor in the profile with trancode:

$ zowe mat monitor ims statement --profile TESTPROF --trancode TESTTRANCODE

tranview

The commands from the tranview group enable you to get the TranView measurement details.

Usage

$ zowe mat monitor tranview <command>

The following commands are available for the TranView group:

all | all

Get the TranView measurement details in Module mode.

Usage

$ zowe mat monitor tranview all [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

--tran (string)
Specifies the transaction activity. Tran = N/A is displayed for the activity that could not be attributed to a particular transaction in the address space.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the TranView measurement details for monitor number 5:

$ zowe mat monitor tranview all --mon_num 5

Get the TranView measurement details for the latest monitor in the TESTPROF profile:

$ zowe mat monitor tranview all --profile TESTPROF

module | mod

Get the TranView measurement details.

Usage

$ zowe mat monitor tranview module [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

--tran (string)
Specifies the transaction activity. Tran = N/A is displayed for the activity that could not be attributed to a particular transaction in the address space.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the idms details of the measurement for the latest monitor in the profile:

$ zowe mat monitor tranview module --profile TESTPROF

Get the module details of the measurement for monitor number 5:

$ zowe mat monitor tranview module --mon_num 5

Specify the module taskid, ruid, and linecmd option of the measurement for the module mode for the TESTPROF profile:

$ zowe mat monitor tranview module  --tran MVGT

callerid | cid

Get the caller identifier details.

Usage

$ zowe mat monitor tranview callerid [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

--tran (string)
Specifies the transaction activity. Tran = N/A is displayed for the activity that could not be attributed to a particular transaction in the address space.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the caller details for monitor number 5:

$ zowe mat monitor tranview callerid --mon_num 5

Get the caller details for the latest monitor in the TESTPROF profile:

$ zowe mat monitor tranview callerid --profile TESTPROF

callstack | csk

Get CallStack data in Module mode.

Usage

$ zowe mat monitor tranview callstack [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

--tran (string)
Specifies the transaction activity. Tran = N/A is displayed for the activity that could not be attributed to a particular transaction in the address space.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the callstack details for monitor number 5:

$ zowe mat monitor tranview callstack --mon_num 5

Get the callstack details for the latest monitor in the TESTPROF profile:

$ zowe mat monitor tranview callstack --profile TESTPROF

csect | csd

Get the CodeView details for transaction in Csect mode.

Usage

$ zowe mat monitor tranview csect [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

--tran (string)
Specifies the transaction activity. Tran = N/A is displayed for the activity that could not be attributed to a particular transaction in the address space.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the CodeView details for transaction in Csect mode for monitor number 5:

$ zowe mat monitor tranview csect --mon_num 5

Get the CodeView details for transaction in Csect mode for the latest monitor in the TESTPROF profile:

$ zowe mat monitor tranview csect --profile TESTPROF

Get the CodeView details for transaction in Csect mode for the monitor number 5 with specific host:

$ zowe mat monitor tranview csect --mon_num 5 --host \"example.com\" --port 12345 --user User1 --password qwerty

delay | dl

Get the delay details for the measurement.

Usage

$ zowe mat monitor tranview delay [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

--tran (string)
Specifies the transaction activity. Tran = N/A is displayed for the activity that could not be attributed to a particular transaction in the address space.

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the DelayView measurement details of a transaction for monitor number 5:

$ zowe mat monitor tranview delay --mon_num 5

Get the DelayView measurement details for the latest monitor in the TESTPROF profile:

$ zowe mat monitor tranview delay --profile TESTPROF

Get the DelayView measurement details for monitor number 5, with the specific MAT profile details defined:

$ zowe mat monitor tranview delay --mon_num 5 --host \"example.com\" --port 12345 --user User1 --password qwerty

stat | cis

Get the CICS statistics details.

Usage

$ zowe mat monitor tranview stat [options]

--mon_num (number)
Specifies the unique monitor number of the measurement.

--tran (string)
Specifies the transaction activity. Tran = N/A is displayed for the activity that could not be attributed to a particular transaction in the address space.

--type (string)
Specifies the type of CICS Transaction. Default value: DISP

Profile Options
--mat-profile | --mat-p (string)
The name of a (mat) profile to load for this command execution.

Examples

Get the CICS statistic details for monitor number 5:

$ zowe mat monitor tranview stat --mon_num 5 --type DB

Get the CICS statistics details for the latest monitor in the TESTPROF profile:

$ zowe mat monitor tranview stat --profile TESTPROF

Uninstall the MAT Analyze Plug-in for Zowe CLI

To uninstall the MAT Analyze plug-in for Zowe CLI, issue the following command:

$ zowe plugins uninstall @broadcom/mat-analyze-for-zowe-cli

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

MAT Analyze Plug-in for Zowe CLI

Table of Contents

Installation

Prerequisites

Install the MAT Analyze Plug-in for Zowe CLI From Packages

Validate the Installation

Create a MAT Profile

Use MAT Profile Options

Use Cases and Commands

PROFILE

create | cr

invoke | ivk

list | lip

MONITOR

history | hs

overview | ov

delayview

delay | de

address | ad

codeview

module | mod

csect | cs

histogram | hsg

callerid | cil

db2

db2view | db2

sqlstmt | sql

idms

dml | dml

module | mod

task | ts

ims

imsview | imsv

dbdname | dbd

psbname | psb

region | reg

ssa | ssa

statement | stat

tranview

all | all

module | mod

callerid | cid

callstack | csk

csect | csd

delay | dl

stat | cis

Uninstall the MAT Analyze Plug-in for Zowe CLI