SirAud parameters: Difference between revisions

Revision as of 20:12, 12 October 2016

SirAud has a set of parameters you can use to restrict the size of some reports or otherwise configure the SirAud run. These parameters must be provided in either of these ways:

As a PARM on the EXEC card in MVS, for example:
//SIRAUD EXEC PGM=SIRAUD,PARM='NSUBS=10 ALLPR'
As options on the M204CMS command in CMS, for example:
M204CMS SIRAUD ( NSUBS 10 ALLPR %

Under MVS, parameters are specified either by a parameter name alone or by a parameter name followed by an equal sign (=) followed by the parameter value. Under CMS, parameters are specified by a parameter name followed by a space and a percent sign (%), or by a parameter name followed by a space and a parameter value.

This page describes the parameter settings that are available for SirAud.

Note: You can change the default setting for some of the parameters; see SirAud default customization.

ALLPR and NOPR

These are two of the report selection parameters. The report selection parameters determine which reports are produced. They also direct all of the report output of SirAud to be written to the SYSPRINT output file, rather than having each of SirAud's reports written to a separate output file. If any report selection parameter is specified, all of the SirAud report output is written to SYSPRINT, and only to there.

The report selection parameters are ALLPR, NOPR, and the following:

FILERP and NOFILERP
PERFRP and NOPERFRP
PROCRP and NOPROCRP
SUBRP and NOSUBRP
UTBLRP and NOUTBLRP
UTBLSM and NOUTBLSM

Any of the above individual report parameters beginning with NO is called the "negative" form of the parameter, and it indicates that the given report should not be produced The form without NO is called the "positive" form, and it indicates the given report should be produced.

ALLPR is a shorthand for a list of all of the positive forms of the individual report parameters. NOPR is a shorthand for a list of all of the negative forms of the individual report parameters.

The effect of the report selection parameters is cumulative, and the specification of any of them can override the effect of a preceding specification. If the first report selection parameter specified is a positive individual report parameter, an implicit NOPR precedes that. If the first report selection parameter specified is a negative individual report parameter, an implicit ALLPR precedes that.

Thus, for example, the following produces all reports except PERFREPT and FILEREPT:

PARM=(NOPERFRP,NOFILERP)

The following produces only the UTBLSUMM and SUBREPT reports:

PARM=(UTBLSM,SUBRP)

And the following produces all reports except PROCREPT (the UTBLRP in this example is superfluous):

PARM=(NOPROCRP,UTBLRP)

You may customize your SirAud load module so that ALLPR is the default; see ALLPR parameter customization.

FROM parameter

This parameter is used to restrict the analysis of the journal to those journal blocks that contain records that are at or after the indicated date and time. If the time on the journal block's trailer is greater than or equal to the FROM specification, the records in that block are included in the report analysis. Consequently, some records that are earlier than the FROM setting may be included.

The FROM syntax is:

FROM = yyddd | time | yyddd time

The FROM parameter options are:

yyddd

Indicates the date, in Julian format, where the FROM century is such that the start of the time period is within 40 years of the start date of the journal.

The analysis starts at the first journal record in the first journal block on or after the indicated day.

time

Indicates the 24-hour time in the format hh:mm[:ss]; ss defaults to 00.

The analysis starts at the first journal record in the first journal block on or after the indicated time of the first day of the journal. If the time value is less than the time of the first journal block, the analysis starts at the first journal record in the first journal block on or after the indicated time of the day after the first day of the journal.

yyddd time

Indicates the date, in Julian format, where the FROM century is such that the start of the time period is within 40 years of the start date of the journal, and the 24-hour time in the format hh:mm[:ss] (where ss defaults to 00).

The analysis starts at the first journal record in the first journal block on or after the indicated time of the indicated day.

Note: This format cannot be passed as a command line program parameter under CMS, although it may be used in a SYSIN file record (see SYSIN). Under MVS, the format is:
...,PARM=' ... FROM=yyddd time ... '

Also see the TO parameter, which can be used to specify the end of the date/time range for analysis.

Regardless of any date range restriction specified by FROM or TO, SirAud examines the beginning part of the journal, through the following message: M204.0075: INITIALIZATION COMPLETED. BUFFERS = n. The histogram of journal record types will include totals from this initialization section of the journal as well as from the date range selected for analysis.

A date range can be useful to provide a reference for interpreting other measures of Model 204 activity. For example, SirTune can show ratios for running procedure A versus other procedures: Assume that a SirTune report over some busy time period shows procedure A using 11% of the CPU in that period, and then you change the procedure. After the changes, SirTune on a new busy period might show procedure A CPU goes up to 12%. One way to check the effectiveness of your changes is to use SirAud PROCREPT reports with date/time ranges to see if this increase in CPU correlates to an increased number of invocations between the two busy times.

FILERP and NOFILERP

The FILERP and NOFILERP parameters have two effects:

Forcing all report output to the SYSPRINT file
Producing (FILERP) or suppressing (NOFILERP) the FILEREPT report.

See ALLPR and NOPR for a discussion of these and the other report selection parameters.

MAXBLK parameter

Syntax:

MAXBLK = n

This parameter is used to specify the number of journal blocks to process.

NAMEOFF parameter

Syntax:

NAMEOFF = n

This can be used, under the direction of Technical Support, to facilitate running SirAud with newer releases of Model 204, compensating for changes in the journal format.

NFILES parameter

Syntax:

NFILES = n

This parameter is used to restrict the number of files summarized in FILEREPT to the top n files by total disk I/O.

NPROCS parameter

Syntax:

NPROCS = n

This parameter is used to restrict the number of procedures summarized in PROCREPT to the top n procedures by total CPU.

NSUBS parameter

Syntax:

NSUBS = n

This parameter is used to restrict the number of subsystems summarized in SUBREPT to the top n subsystems by total CPU.

NUTBLS parameter

Syntax:

NUTBLS = n

This parameter is used to restrict the number of subsystems summarized in UTBLREPT to the top n subsystems by server size.

NUSUMM parameter

Syntax:

NUSUMM = n

This parameter is used to restrict the number of subsystems summarized in UTBLSUMM to the top n subsystems by server size.

PERFRP and NOPERFRP parameters

The PERFRP and NOPERFRP parameters have two effects:

Forcing all report output to the SYSPRINT file
Producing (PERFRP) or suppressing (NOPERFRP) the PERFREPT report.

See ALLPR and NOPR for a discussion of these and the other report selection parameters.

PROCRP and NOPROCRP parameters

The PROCRP and NOPROCRP parameters have two effects:

Forcing all report output to the SYSPRINT file
Producing (PROCRP) or suppressing (NOPROCRP) the PROCREPT report.

See ALLPR and NOPR for a discussion of these and the other report selection parameters.

SKIPBLK parameter

Syntax:

SKIPBLK = n

This parameter is used to specify a number of journal blocks to skip.

SUBRP and NOSUBRP parameters

The SUBRP and NOSUBRP parameters have two effects:

Forcing all report output to the SYSPRINT file
Producing (SUBRP) or suppressing (NOSUBRP) the SUBREPT report.

See ALLPR and NOPR for a discussion of these and the other report selection parameters.

TO parameter

Syntax:

TO = yyddd | time | yyddd time

This parameter is used to restrict the analysis of the journal to those journal blocks that contain records that are at the indicated date and time. If the time on the journal block's header is less than or equal to the TO specification, the records in that block are included in the report analysis. Consequently, some records that are later than the TO setting may be included.

The TO parameter options are:

yyddd

Indicates the date, in Julian format, where the TO century is such that the end of the time period is within 40 years of the start date of the journal.

The analysis ends with the last journal record in the last journal block on or before the indicated day.

time

Indicates the 24-hour time in the hh:mm[:ss] format; ss defaults to 59.

The analysis ends with the last journal record in the last journal block on or before the indicated time of the starting day of analysis. If the time value is less than the starting time of analysis, the analysis ends with the last journal record in the last journal block on or before the indicated time of the day after the starting day of analysis.

The starting date and time of analysis is specified by the FROM parameter, if present, and otherwise is the date and time at the start of the journal.

yyddd time

Indicates the date, in Julian format, where the TO century is such that the end of the time period is within 40 years of the start date of the journal, and the 24-hour time in the format hh:mm[:ss]; ss defaults to 59.

The analysis ends with the last journal record in the last journal block on or before the indicated time of the indicated day.

Note: This format cannot be passed as a command line program parameter under CMS, although it may be used in a SYSIN file record (see SYSIN).
Under MVS, the format is:

...,PARM=' ... TO=yyddd time ... '

Also see the FROM parameter, which can be used to specify the start of the date/time range for analysis. The description there also provides an example of one benefit of date/time range selection with SirAud.

UTBLRANG parameter

Syntax:

UTBLRANG = n

This parameter is used to specify the number of standard deviations a server table highwater mark for an individual procedure is allowed to vary from the mean for the subsystem before the procedure is flagged for UTBLREPT.

The default is 2.

UTBLRP and NOUTBLRP parameters

The UTBLRP and NOUTBLRP parameters have two effects:

Forcing all report output to the SYSPRINT file
Producing (UTBLRP) or suppressing (NOUTBLRP) the UTBLREPT report.

See ALLPR and NOPR for a discussion of these and the other report selection parameters.

UTBLSM and NOUTBLSM parameters

The UTBLSM and NOUTBLSM parameters have two effects:

Forcing all report output to the SYSPRINT file
Producing (UTBLSM) or suppressing (NOUTBLSM) the UTBLSUMM report.

See ALLPR and NOPR for a discussion of these and the other report selection parameters.

@@ Line 18: / Line 18: @@
 This page describes the parameter settings that are available for <var class="product">SirAud</var>.
-<p class="note"><b>Note:</b> You can change the default setting for some of the parameters; see [[Customization of defaults]]. </p>
+<p class="note"><b>Note:</b> You can change the default setting for some of the parameters; see [[SirAud default customization]]. </p>
 ==<b id="allpr"></b>ALLPR and NOPR==
@@ Line 25: / Line 25: @@
 They also direct all of the report output of <var class="product">SirAud</var> to be written to the SYSPRINT output file, rather than
 having each of <var class="product">SirAud</var>'s reports written to a separate output file.
-If any report selection parameter is specified, all of the <var class="product">SirAud</var>
+If any report selection parameter is specified, all of the <var class="product">SirAud</var> report output is written to SYSPRINT, and only to there.
-report output is written to SYSPRINT, and only to there.
-The report selection parameters are ALLPR, NOPR, and the following:
+The report selection parameters are <var>ALLPR</var>, <var>NOPR</var>, and the following:
 <ul>
-<li>FILERP and NOFILERP
+<li><var>FILERP</var> and <var>NOFILERP</var>
-<li>PERFRP and NOPERFRP
+<li><var>PERFRP</var> and <var>NOPERFRP</var>
-<li>PROCRP and NOPROCRP
+<li><var>PROCRP</var> and <var>NOPROCRP</var>
-<li>SUBRP and NOSUBRP
+<li><var>SUBRP</var> and <var>NOSUBRP</var>
-<li>UTBLRP and NOUTBLRP
+<li><var>UTBLRP</var> and <var>NOUTBLRP</var>
-<li>UTBLSM and NOUTBLSM
+<li><var>UTBLSM</var> and <var>NOUTBLSM</var>
 </ul>
 Any of the above individual report parameters beginning with <code>NO</code> is called the "negative" form of
@@ Line 41: / Line 40: @@
 The form <i>without</i> <code>NO</code> is called the "positive" form, and it indicates the given report should be produced.
-ALLPR is a shorthand for a list of all of the positive forms of the
+<var>ALLPR</var> is a shorthand for a list of all of the positive forms of the
 individual report parameters.
-NOPR is a shorthand for a list of all of the negative forms of the
+<var>NOPR</var> is a shorthand for a list of all of the negative forms of the
 individual report parameters.
-The effect of the report selection parameters is cumulative, and the specification of any
+The effect of the report selection parameters is cumulative, and the specification of any of them can override the effect of a preceding specification.
-of them can override the effect of a preceding specification.
 If the first report selection parameter specified is a positive individual
-report parameter, an implicit NOPR precedes that.
+report parameter, an implicit <code>NOPR</code> precedes that.
 If the first report selection parameter specified is a negative individual
-report parameter, an implicit ALLPR precedes that.
+report parameter, an implicit <code>ALLPR</code> precedes that.
 Thus, for example, the following produces all reports except PERFREPT and FILEREPT:
@@ Line 61: / Line 59: @@
 </p>
-And the following produces all reports except PROCREPT (the UTBLR in this example is superfluous):
+And the following produces all reports except PROCREPT (the <code>UTBLRP</code> in this example is superfluous):
 <p class="code">PARM=(NOPROCRP,UTBLRP)
 </p>
-You may customize your <var class="product">SirAud</var> load module so that ALLPR is the default; see
+You may customize your <var class="product">SirAud</var> load module so that <var>ALLPR</var> is the default; see
-[[Customization of defaults#cszallp|ALLPR parameter customization]].
+[[SirAud default customization#cszallp|ALLPR parameter customization]].
 ==<b id="from"></b>FROM parameter==
@@ Line 73: / Line 71: @@
 are at or after the indicated date and time.
 If the time on the journal block's trailer is greater than or equal to
-the FROM specification, the records in that block are included in the
+the <var>FROM</var> specification, the records in that block are included in the
 report analysis.
-Consequently, some records that are earlier than the FROM setting may be included.
+Consequently, some records that are earlier than the <var>FROM</var> setting may be included.
-The FROM syntax is:
+The <var>FROM</var> syntax is:
 <p class="syntax">FROM = <span class="term">yyddd</span> | <span class="term">time</span> | <span class="term">yyddd time</span>  </p>
-The FROM parameter options are:
+The <var>FROM</var> parameter options are:
 <table>
 <tr><th>yyddd</th>
-<td>Indicates the date, in Julian format, where the FROM century is such that the start of the time period is within 40 years of the start date of the journal.
+<td>Indicates the date, in Julian format, where the <var>FROM</var> century is such that the start of the time period is within 40 years of the start date of the journal.
 <p>
 The analysis starts at the first journal record in the first journal block on or after the indicated day.</p></td></tr>
-<tr><th>time</th><td>Indicates the 24-hour time in the format hh:mm[:ss]; <i>ss</i> defaults to 00.
+<tr><th>time</th>
+<td>Indicates the 24-hour time in the format <i>hh</i>:<i>mm</i>[:<i>ss</i>]; <i>ss</i> defaults to 00.
 <p>
 The analysis starts at the first journal record in the first journal block on or after the indicated time of the first day of the journal.
-If the <code>time</code> value is less than the time of the first journal block, the analysis starts at the first journal record in the first journal block on or after the indicated time of the day after the first day of the journal.</p></td></tr>
+If the <var class="term">time</var> value is less than the time of the first journal block, the analysis starts at the first journal record in the first journal block on or after the indicated time of the day after the first day of the journal.</p></td></tr>
 <tr><th nowrap>yyddd time</th>
-<td>Indicates the date, in Julian format, where the FROM century is such that the start of the time period is within 40 years of the start date of the journal, and the 24-hour time in the format <i>hh</i>:<i>mm</i>[:<i>ss</i>] (where <i>ss</i> defaults to 00).
+<td>Indicates the date, in Julian format, where the <var>FROM</var> century is such that the start of the time period is within 40 years of the start date of the journal, and the 24-hour time in the format <i>hh</i>:<i>mm</i>[:<i>ss</i>] (where <i>ss</i> defaults to 00).
 <p>
 The analysis starts at the first journal record in the first journal block on or after the indicated time of the indicated day.</p>
-<blockquote class="note"><b>Note:</b> This format cannot be passed as a command line program parameter under CMS, although it may be used in a SYSIN file record (see [[Additional SirAud files#sysin|SYSIN]]). Under MVS, the format is:
+<blockquote class="note"><b>Note:</b> This format cannot be passed as a command line program parameter under CMS, although it may be used in a SYSIN file record (see [[SirAud#sysin|SYSIN]]). Under MVS, the format is:
 <p class="code">...,PARM=' ... FROM=<i>yyddd time</i> ... '
 </p>
@@ Line 104: / Line 103: @@
 Also see the [[#toparm|TO parameter]], which can be used to specify the end of the date/time range for analysis.
-Regardless of any date range restriction specified by FROM or
+Regardless of any date range restriction specified by <var>FROM</var> or
-TO, <var class="product">SirAud</var> examines the beginning part of the journal, through the following message:
+<var>TO</var>, <var class="product">SirAud</var> examines the beginning part of the journal, through the following message:
 <code>M204.0075: INITIALIZATION COMPLETED.  BUFFERS = n</code>.
 The histogram of journal record types will include totals from this
@@ Line 118: / Line 117: @@
 After the changes, <var class="product">SirTune</var> on a new busy period might show procedure A CPU goes up to 12%.
 One way to check the effectiveness of your changes is to use
-<var class="product">SirAud</var> PROCREPT reports with date/time ranges to see if this increase in CPU
+<var class="product">SirAud</var> PROCREPT reports with date/time ranges to see if this increase in CPU correlates to an increased number of invocations between the two busy times.
-correlates to an increased number of invocations between the two busy times.
 ==FILERP and NOFILERP==
-The FILERP and NOFILERP parameters have two effects:
+The <var>FILERP</var> and <var>NOFILERP</var> parameters have two effects:
 <ul>
 <li>Forcing all report output to the SYSPRINT file
-<li>Producing (FILERP) or suppressing (NOFILERP) the FILEREPT report.
+<li>Producing (<var>FILERP</var>) or suppressing (<var>NOFILERP</var>) the FILEREPT report.
 </ul>
@@ Line 149: / Line 147: @@
 This parameter is used to restrict the number of files summarized in FILEREPT
-to the top <i>n</i> files by total disk I/O.
+to the top <var class="term">n</var> files by total disk I/O.
 ==NPROCS parameter==
@@ Line 156: / Line 154: @@
 This parameter is used to restrict the number of procedures summarized in
-PROCREPT to the top n procedures by total CPU.
+PROCREPT to the top <var class="term">n</var> procedures by total CPU.
 ==NSUBS parameter==
@@ Line 163: / Line 161: @@
 This parameter is used to restrict the number of subsystems summarized in
-SUBREPT to the top n subsystems by total CPU.
+SUBREPT to the top <var class="term">n</var> subsystems by total CPU.
 ==NUTBLS parameter==
@@ Line 170: / Line 168: @@
 This parameter is used to restrict the number of subsystems summarized in
-UTBLREPT to the top n subsystems by server size.
+UTBLREPT to the top <var class="term">n</var> subsystems by server size.
 ==NUSUMM parameter==
@@ Line 180: / Line 178: @@
 ==PERFRP and NOPERFRP parameters==
-The PERFRP and NOPERFRP parameters have two effects:
+The <var>PERFRP</var> and <var>NOPERFRP</var> parameters have two effects:
 <ul>
 <li>Forcing all report output to the SYSPRINT file
-<li>Producing (PERFRP) or suppressing (NOPERFRP) the PERFREPT report.
+<li>Producing (<var>PERFRP</var>) or suppressing (<var>NOPERFRP</var>) the PERFREPT report.
 </ul>
@@ Line 189: / Line 187: @@
 ==PROCRP and NOPROCRP parameters==
-The PROCRP and NOPROCRP parameters have two effects:
+The <var>PROCRP</var> and <var>NOPROCRP</var> parameters have two effects:
 <ul>
 <li>Forcing all report output to the SYSPRINT file
-<li>Producing (PROCRP) or suppressing (NOPROCRP) the PROCREPT report.
+<li>Producing (<var>PROCRP</var>) or suppressing (<var>NOPROCRP</var>) the PROCREPT report.
 </ul>
@@ Line 204: / Line 202: @@
 ==SUBRP and NOSUBRP parameters==
-The SUBRP and NOSUBRP parameters have two effects:
+The <var>SUBRP</var> and <var>NOSUBRP</var> parameters have two effects:
 <ul>
 <li>Forcing all report output to the SYSPRINT file
-<li>Producing (SUBRP) or suppressing (NOSUBRP) the SUBREPT report.
+<li>Producing (<var>SUBRP</var>) or suppressing (<var>NOSUBRP</var>) the SUBREPT report.
 </ul>
@@ Line 218: / Line 216: @@
 This parameter is used to restrict the analysis of the journal
 to those journal blocks that contain records that are at the indicated date and time.
-If the time on the journal block's header is less than or equal to the TO specification, the records in that block are included in the report analysis.
+If the time on the journal block's header is less than or equal to the <var>TO</var> specification, the records in that block are included in the report analysis.
-Consequently, some records that are later than the TO setting may be included.
+Consequently, some records that are later than the <var>TO</var> setting may be included.
-The TO parameter options are:
+The <var>TO</var> parameter options are:
 <table>
 <tr><th>yyddd</th>
-<td>Indicates the date, in Julian format, where the TO century is such that the end of the time period is within 40 years of the start date of the journal.
+<td>Indicates the date, in Julian format, where the <var>TO</var> century is such that the end of the time period is within 40 years of the start date of the journal.
 <p>
 The analysis ends with the last journal record in the last journal block on or before the indicated day.</p></td></tr>
@@ Line 234: / Line 232: @@
 If the <code>time</code> value is less than the starting time of analysis, the analysis ends with the last journal record in the last journal block on or before the indicated time of the day after the starting day of analysis. </p>
 <p>
-The starting date and time of analysis is specified by the FROM parameter, if present, and otherwise is the date and time at the start of the journal.</p></td></tr>
+The starting date and time of analysis is specified by the <var>FROM</var> parameter, if present, and otherwise is the date and time at the start of the journal.</p></td></tr>
 <tr><th nowrap>yyddd time</th>
-<td>Indicates the date, in Julian format, where the TO century is such that the end of the time period is within 40 years of the start date of the journal, and the 24-hour time in the format <i>hh</i>:<i>mm</i>[:<i>ss</i>]; <i>ss</i> defaults to 59.
+<td>Indicates the date, in Julian format, where the <var>TO</var> century is such that the end of the time period is within 40 years of the start date of the journal, and the 24-hour time in the format <i>hh</i>:<i>mm</i>[:<i>ss</i>]; <i>ss</i> defaults to 59.
 <p>
 The analysis ends with the last journal record in the last journal block on or before the indicated time of the indicated day.</p>
-<blockquote class="note"><b>Note:</b> This format cannot be passed as a command line program parameter under CMS, although it may be used in a SYSIN file record (see [[Additional SirAud files#sysin|SYSIN]]).
+<blockquote class="note"><b>Note:</b> This format cannot be passed as a command line program parameter under CMS, although it may be used in a SYSIN file record (see [[SirAud#sysin|SYSIN]]).
 Under MVS, the format is:
 <p class="syntax">...,PARM=' ... TO=<span class="term">yyddd time</span> ... '
@@ Line 262: / Line 260: @@
 ==UTBLRP and NOUTBLRP parameters==
-The UTBLRP and NOUTBLRP parameters have two effects:
+The <var>UTBLRP</var> and <var>NOUTBLRP</var> parameters have two effects:
 <ul>
 <li>Forcing all report output to the SYSPRINT file
-<li>Producing (UTBLRP) or suppressing (NOUTBLRP) the UTBLREPT report.
+<li>Producing (<var>UTBLRP</var>) or suppressing (<var>NOUTBLRP</var>) the UTBLREPT report.
 </ul>
@@ Line 272: / Line 270: @@
 ==UTBLSM and NOUTBLSM parameters==
-The UTBLSM and NOUTBLSM parameters have two effects:
+The <var>UTBLSM</var> and <var>NOUTBLSM</var> parameters have two effects:
 <ul>
 <li>Forcing all report output to the SYSPRINT file
-<li>Producing (UTBLSM) or suppressing (NOUTBLSM) the UTBLSUMM report.
+<li>Producing (<var>UTBLSM</var>) or suppressing (<var>NOUTBLSM</var>) the UTBLSUMM report.
 </ul>

SirAud parameters: Difference between revisions

Revision as of 20:12, 12 October 2016

Contents

ALLPR and NOPR

FROM parameter

FILERP and NOFILERP

MAXBLK parameter

NAMEOFF parameter

NFILES parameter

NPROCS parameter

NSUBS parameter

NUTBLS parameter

NUSUMM parameter

PERFRP and NOPERFRP parameters

PROCRP and NOPROCRP parameters

SKIPBLK parameter

SUBRP and NOSUBRP parameters

TO parameter

UTBLRANG parameter

UTBLRP and NOUTBLRP parameters

UTBLSM and NOUTBLSM parameters

See also

Navigation menu