Get the Histogram measurement details in CSECT mode.
Usage
zowe mat monitor codeview histogram csect [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.
-
--module (string)
- Specifies the module name that you request the Histogram data for. You get the module value from the 'codeview csect' 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 --csect '""').
-
--group (string)
- Specifies the histogram group size parameter that defines the resolution of the histogram (e.g., --group 32). If you do not specify the group parameter, the group size value defaults to 4 bytes. If the source program listing is registered with MAT, the group size parameter is ignored. The --group parameter is optional. Lower values of the --group parameter result in more granular representation of the histogram data. Values: numbers between 2 and 999999.
-
--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.
-
--listing (boolean)
- Enables you to retrieve program listing details that pertain to the specific CSECT and statement. To use the listing retrieval option, ensure that the program listing for the specific measurement is registered with MAT, and that you have the Endevor® Web Services connection configured locally via the --endevor-* options below (or the ZOWE_OPT_ENDEVOR_* environment variable). 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 in 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:listingsSA420LE.asm:382:51. If you use Visual Studio Code (VS Code) IDE, you can click on the reference in the command responce in your VS Code terminal to navigate directly to the indicated source program location.The --listing parameter is optional.
MAT Endevor Listing Options
-
--endevor-host (string)
- Specifies the host of the Endevor Web Services used to retrieve program listings. Can also be configured via the ZOWE_OPT_ENDEVOR_HOST environment variable.
-
--endevor-port (number)
- Specifies the port of the Endevor Web Services used to retrieve program listings. Can also be configured via the ZOWE_OPT_ENDEVOR_PORT environment variable.
-
--endevor-base-path (string)
-
--endevor-reject-unauthorized (boolean)
-
--endevor-reuse-mat-credentials (boolean)
-
--endevor-user (string)
- Specifies the username for the Endevor Web Services connection. Not required if --endevor-reuse-mat-credentials is specified. Can also be configured via the ZOWE_OPT_ENDEVOR_USER environment variable.
-
--endevor-password (string)
- Specifies the password for the Endevor Web Services connection. Not required if --endevor-reuse-mat-credentials is specified. Can also be configured via the ZOWE_OPT_ENDEVOR_PASSWORD environment variable.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: 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)
-
--password | --pw (string)
-
--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)
-
--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.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file path)
-
The file path to a certificate file to use for authentication.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
-
--cert-account (string)
- The account name for PKCS 12 certificate stored in credential manager
Examples
-
Get the Histogram details in CSECT mode for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB:
zowe mat monitor codeview histogram csect --mon_num 5 --csect "TUNCOB01" --module "RUNCOB"
-
Get the Histogram details in CSECT mode for the latest monitor in the TESTPROF profile for CSECT name TUNCOB01, empty module name, limiting the group size to 32 bytes and the number of returned records to 5 top consumers:
zowe mat monitor codeview histogram csect --profile TESTPROF --csect "TUNCOB01" --module '""' --top 5 --group 32
-
Get the Histogram details for in CSECT mode 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 csect --mon_num 5 --csect "TUNCOB01" --module "RUNCOB" --top 5 --listing
-
Get the Histogram details in CSECT mode for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB, with the specific MAT profile details defined:
zowe mat monitor codeview histogram csect --mon_num 5 --csect "TUNCOB01" --module "RUNCOB" --host "example.com" --port 12345 --user johndoe --password qwerty
-
Get the Histogram details about listing retrieval with the re-used MAT profile credentials for a locally-configured Endevor host options:
zowe mat monitor codeview histogram csect --csect "TUNCOB01" --listing --endevor-host "endevor.example.com" --endevor-port 8080 --endevor-base-path "EndevorService/rest" --endevor-reuse-mat-credentials
-
Get the Histogram details about listing retrieval with Endevor-specific credential options:
zowe mat monitor codeview histogram csect --csect "TUNCOB01" --listing --endevor-host "endevor.example.com" --endevor-port 8080 --endevor-base-path "EndevorService/rest" --endevor-user janedoe --endevor-password qwerty