Line-by-line Monitoring Options

If you invoke ^%SYS.MONLBL while the monitor is running you have the following menu options:

Line-by-Line Monitor
 
1.) Stop Monitor
2.) Pause Monitor / Resume Monitor
3.) Clear Counters
4.) Report - Detail
5.) Report - Summary
6.) Report - Delimited (CSV) Output
7.) Report - Procedure Level
 
Enter the number of your choice:

The first three options are fairly self-explanatory:

Stop Monitor — Stops all ^%SYS.MONLBL monitoring; deallocates the counter memory and deletes collected data.
Pause Monitor — Pauses the collection and maintains any collected data. This may be useful when viewing collected data to ensure that counts are not changing as the report is displayed. This option only appears if the monitor is running.
Resume Monitor — Resumes collection after a pause. This option only appears if you paused the monitor.
Clear Counters — Clears any collected data, but continues monitoring and collecting new data.

The following subsections explain the four report options.

Report Line-by-line Statistics

When you choose to report the statistics of the metrics that have been collecting (options 4–7), you then provide information about how you want the routine to report the statistics.

You have four types of reports to choose from:

Detail — Generates a report of the selected metrics for each line in the selected routines. The report accumulates and displays totals for each of the performance columns.
Summary — Generates a report of summary information for each selected routine including coverage and time. The report orders the routines by coverage percentage.
Delimited (CSV) Output — Generates the same report information as the detail report, but presents it as comma-delimited output facilitating its import into a spreadsheet.
Procedure Level — Generates a report of selected metrics at a subroutine level within the selected routines. InterSystems IRIS allows you to profile usage at the level of individual subroutines, procedures, and functions. You can quickly see which subroutines are taking up the most time to run to analyze and improve performance.

Depending on which type of report you choose, you select how you want to display the information:

If you choose the detail or summary report, you can also choose if you want to include a coverage analysis for the lines executed in each routine you select. For example:
```
Enter the number of your choice: 4
Include Coverage Analysis summary (Y/N)? y
```

Next, for all but the summary report, select one or more routines from the list of monitored routines that have statistics available; enter an asterisk (*) for all available routines. For example:

The following routines have been executed during the run,
and have detail statistics available for them.
1) JRNDUMP
2) JRNOPTS
3) JRNSTART
4) JRNSWTCH
5) JRNUTIL
6) JRNUTIL2
 
Enter list of routines, or * for all
Routine number (*=All)? * - All

If you are entering routine names, after entering the last routine, press Enter again to end the list. For example:

Enter list of routines, or * for all
Routine number (*=All)? 1 - JRNDUMP
Routine number (*=All)? 2 - JRNOPTS
Routine number (*=All)? 5 - JRNUTIL
Routine number (*=All)?
FileName:

You can enter a file name or a full directory path for the output. You can instead enter nothing and press Enter to display the report on your terminal.
If you enter a file name but not a path, %SYS.MONLBL creates the file in the directory of the current namespace’s default database for globals. For example, if running %SYS.MONLBL in the USER namespace:
```
FileName: monlbl_JRN_dtl.txt
```
Creates a file for the report in install-dir\mgr\user named monlbl_JRN_dtl.txt.
Press Enter to initiate the reporting of the metrics you are collecting in the format you have chosen.

Sample Line-by-line Detail Report

Invoking the Line-by-line Monitoring Routine