SirTune introduction: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (minor cleanup)
m (use template for installation info)
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
<!--Page automatically generated by CMSTOWIK EXEC and will be
The primary function of <var class="product">SirTune</var> is to provide information to User Language ([[SOUL]]) programmers to make it easy for them to
** automatically replaced ** -- any manual edits will be lost.
You've been warned.  ..  (Page built by JAL at the SIRIUS VM; file: FUNPGNEW SYSUT2) -->
<!-- Page name: SirTune introduction-->
 
The primary function of <var class="product">SirTune</var> is to provide information
to User Language (SOUL) programmers to make it easy for them to
improve the performance of their programs.
improve the performance of their programs.
This is accomplished in two stages:
This is accomplished in two stages:
Line 11: Line 5:
<li>Data is collected in a running Online region.
<li>Data is collected in a running Online region.
This data is obtained by "polling."
This data is obtained by "polling."
That is, at regular intervals <var class="product">SirTune</var> examines the state of the Online.
That is, at regular intervals <var class="product">SirTune</var> examines the state of the Online region and records data pertinent to this state.
region and records data pertinent to this state.
<p>
<p></p>
The part of <var class="product">SirTune</var> that collects this data is called the
The part of <var class="product">SirTune</var> that collects this data is called the
<b><i>data collection</i></b> portion, which
<b>data collection</b> portion, which was integrated with the [[Sirius Mods]] prior to version 7.5 of <var class="product">Model&nbsp;204</var>.</p>
was integrated with the [[Sirius Mods]] prior to version 7.5 of <var class="product">Model 204</var>.
<p>
<p></p>
Occasionally in the SirTune documentation, the product name "<var class="product">SirTune</var>" is also used to refer to just the data collection portion of the product.</p></li>
Occasionally in this document, the product name "<var class="product">SirTune</var>" is also
 
used to refer to just the data collection portion of the product.
<li>After this data is collected, it is summarized and presented in a set of reports that indicate to a SOUL programmer the potential performance problem areas.
<li>After this data is collected, it is summarized and presented
in a set of reports that indicate to a User Language programmer the
potential performance problem areas.
These problem areas can generally be refined to an arbitrary level of
These problem areas can generally be refined to an arbitrary level of
detail (for example, individual lines of code in a procedure).
detail (for example, individual lines of code in a procedure).
<p></p>
<p>
The part of <var class="product">SirTune</var> that summarizes and produces reports is called the
The part of <var class="product">SirTune</var> that summarizes and produces reports is called the <b>reporting</b> portion, the <code>SIRTUNEREPORT</code> SOUL program, distributed in the <var class="product">[[RKTools]]</var> <code>SIRIUS</code> file (prior to RKTools 7.7) or the <code>M204PROC</code> file (as of RKTools 7.7).</p></li>
<b><i>reporting</i></b> portion, which consists of a User Language program
named SIRTUNEREPORT, distributed in the SIRIUS file as part of <var class="product">UL/SPF</var>.
</ol>
</ol>
==Versions==
The SirTune documentation assumes that a site is running <var class="product">SirTune</var> version 7.4 or later.
Any documented feature or facility that requires a later version
of <var class="product">SirTune</var> will be clearly marked to indicate this.
<p></p>
For example, a statement that is only available in versions 7.5 and
later of <var class="product">SirTune</var> will have a sentence in its documentation
such as, "This statement
is only available in version 7.5 or later of <var class="product">SirTune</var>."
If a feature or parameter is not
indicated as requiring any specific version of the <var class="product">SirTune</var>, it can
be assumed that it is available in all versions covered by this
document: that is, versions 7.4 and later of <var class="product">SirTune</var>.


==System requirements==
==System requirements==
<var class="product">SirTune</var> requires the following components to run:
<var class="product">SirTune</var> requires the following components to run:
<ul>
<ul>
<li>Mainframe operating systems &mdash; one of the following:</li>
<li>Mainframe operating systems &mdash; one of the following:
<ul>
<ul>
<li>z/OS</li>
<li>z/OS</li>
Line 56: Line 30:
<li><var class="product">Model 204</var> V6R1 or later, running
<li><var class="product">Model 204</var> V6R1 or later, running
in its Online or IFAM4 configuration.</li>
in its Online or IFAM4 configuration.</li>
</ul>


<li>For versions of <var class="product">SirTune</var> after 7.0:</li>
==Installation==
<ul>
{{Template:SirTune installation}}
<li>The <var class="product">SirTune</var> data collector is integrated with the [[Sirius Mods]],
and you <b>must</b> install the Sirius Mods.</li>
 
<li>The <var class="product">UL/SPF</var> file SIRIUS must be downloaded to make the SIRTUNEREPORT
program available for reporting.</li>
</ul></li>
</ul>


==SirTune topics==
==SirTune topics==
Line 73: Line 41:
For information about product changes and Model&nbsp;204 feature
For information about product changes and Model&nbsp;204 feature
support per <var class="product">SirTune</var> version, see
support per <var class="product">SirTune</var> version, see
the [[M204wiki main page#Release notes, wishlists, and punch lists|release notes]].
the [[M204wiki main page#Release notes|release notes]].


For information about product error messages, see [[:Category:SirTune data collector messages|SirTune data collector messages]].
For information about product error messages, see [[:Category:SirTune data collector messages|SirTune data collector messages]].

Latest revision as of 19:43, 11 August 2017

The primary function of SirTune is to provide information to User Language (SOUL) programmers to make it easy for them to improve the performance of their programs. This is accomplished in two stages:

  1. Data is collected in a running Online region. This data is obtained by "polling." That is, at regular intervals SirTune examines the state of the Online region and records data pertinent to this state.

    The part of SirTune that collects this data is called the data collection portion, which was integrated with the Sirius Mods prior to version 7.5 of Model 204.

    Occasionally in the SirTune documentation, the product name "SirTune" is also used to refer to just the data collection portion of the product.

  2. After this data is collected, it is summarized and presented in a set of reports that indicate to a SOUL programmer the potential performance problem areas. These problem areas can generally be refined to an arbitrary level of detail (for example, individual lines of code in a procedure).

    The part of SirTune that summarizes and produces reports is called the reporting portion, the SIRTUNEREPORT SOUL program, distributed in the RKTools SIRIUS file (prior to RKTools 7.7) or the M204PROC file (as of RKTools 7.7).

System requirements

SirTune requires the following components to run:

  • Mainframe operating systems — one of the following:
    • z/OS
    • CMS (releases currently supported by IBM) under z/VM
  • Model 204 V6R1 or later, running in its Online or IFAM4 configuration.

Installation

SirTune consists of an object file (for data collecting) as well as SOUL files (for reporting). As of SirTune 7.1, the object code was integrated into Sirius Mods, and as of Model 204 7.5, Sirius Mods was integrated into the Model 204 nucleus. Thus, if you are running Model 204 7.5 or later and you are authorized to use SirTune, the necessary object code is already installed into Model 204.

In addition to the object code, you need to download and install the SirTune SOUL files to run SirTune reports, and this is covered in the following section.

SirTune object file

If you are running a pre-7.5 version of Model 204 and want to refresh the SirTune object file, you can download the "Sirius Mods" object file from the Rocket Software website "Rocket M204 Customer Care" page (http://m204.rocketsoftware.com).

The SirTune object file is integrated into the Sirius Mods object file until Model 204 7.5; thereafter it is part of the Model 204 object. The download process requires a Model 204 user ID and password.

  1. On the "Rocket M204 Customer Care" page, go to the "Downloads and Uploads" section and click the "Download object files" link.

    After providing Model 204 login credentials, you access the "Download object files" page, which contains a dynamically-generated list of the various Model 204 object files that you are authorized to download.

  2. Select the Sirius Mods row for the version you require, and click the "Download object file" link.

SirTune SOUL files

SirTune report generation is performed by a SOUL program that is distributed as part of the RKTools product family in the SIRIUS file (for versions of RKTools prior to 7.7) or the M204PROC file (as of RKTools 7.7).

  • If your site uses RKTools, verify that file SIRIUS or M204PROC contains the program SIRTUNEREPORT. If the RKTools version is 7.7 or higher, you can use the RKWeb interface to view SirTune report output on your browser. RKTools installation has information about RKTools and RKWeb installation.
  • If your site is not licensed for RKTools, you are still authorized (as a user of SirTune) to download the SIRIUS or M204PROC file. You can download the file from the Rocket website:
    1. On the "SOUL files" page, click the "SOUL files" link in the "Downloads and Uploads" section.
    2. On the Rocket M204 Customer Care page, find the appropriate row for your version of RKTools, and click the "Download Procfile" link.

    You don't need to do the entire RKTools installation: just download and restore the SIRIUS or M204PROC file, and make it available to your SirTune report jobs.

SirTune topics

The SirTune documentation consists of the pages listed below. This list is also available as a "See also" link from each of the pages.

For information about product changes and Model 204 feature support per SirTune version, see the release notes.

For information about product error messages, see SirTune data collector messages.

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=SirTune_introduction&oldid=104097"