$SyStat: Difference between revisions
m (1 revision) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Retrieve system statistics into string<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Retrieve system statistics into string<section end="desc" /></span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $SyStat function.</p> | ||
This function allows retrieval of system statistics into a string. | This function allows retrieval of system statistics into a string. | ||
| Line 9: | Line 9: | ||
The first argument is a string of blank delimited words indicating the statistics to be returned. The length of each returned statistic is always a multiple of 4 bytes. This facilitates the use of $StatD with the returned string. For more information about available statistics, see the ''"SirMon User's Guide"''. | The first argument is a string of blank delimited words indicating the statistics to be returned. The length of each returned statistic is always a multiple of 4 bytes. This facilitates the use of $StatD with the returned string. For more information about available statistics, see the ''"SirMon User's Guide"''. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><section begin="syntax" /> %STRING = $SyStat(stat_list) | <p class="syntax"><section begin="syntax" /> %STRING = $SyStat(stat_list) | ||
| Line 16: | Line 17: | ||
<p class="caption">%STRING is made up of binary data, the first 4 bytes of which is an error code. If the error code is negative %STRING will only be 4 bytes long.</p> | <p class="caption">%STRING is made up of binary data, the first 4 bytes of which is an error code. If the error code is negative %STRING will only be 4 bytes long.</p> | ||
The data returned by $SyStat is binary with the first 4 bytes containing an error code. If the error code is negative, only 4 bytes are returned. If the error code is positive, it contains a number of milliseconds since the online region was brought up. This provides a convenient number for calculating rates for the statistics. When a positive error code is returned the next 10 bytes contain the blank padded word 'SYSTEM' followed by 2 bytes of binary 0. This means that the actual data starts at offset 16 (byte number 17) in the result string. | |||
<p class="code"> | |||
-5 - Required parameter not specified | |||
-12 - Invalid name in stat_list | -12 - Invalid name in stat_list | ||
-13 - STAT not linked in | -13 - STAT not linked in | ||
| Line 25: | Line 27: | ||
<p class="caption">$SyStat return codes | <p class="caption">$SyStat return codes | ||
</p> | </p> | ||
The following program displays some totals for system statistics. | The following program displays some totals for system statistics. | ||
| Line 35: | Line 35: | ||
%DATA = $SyStat('CPU DKIO SVIO') | %DATA = $SyStat('CPU DKIO SVIO') | ||
IF $LEN(%DATA) = 4 THEN | IF $LEN(%DATA) = 4 THEN | ||
PRINT '$SYSTAT ERROR... RC = ' WITH $UNBIN(%DATA) | |||
STOP | |||
END IF | END IF | ||
| Line 45: | Line 45: | ||
END | END | ||
</p> | </p> | ||
<ul> | <ul> | ||
<li>[[Sirius $Functions]] | |||
<li> | |||
</ul> | </ul> | ||
<p class="caption">Products authorizing $SyStat | <p class="caption">Products authorizing $SyStat | ||
</p> | </p> | ||
[[Category:$Functions|$SyStat]] | [[Category:$Functions|$SyStat]] | ||
Revision as of 20:29, 8 February 2011
<section begin="desc" />Retrieve system statistics into string<section end="desc" />
Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $SyStat function.
This function allows retrieval of system statistics into a string.
The $SyStat function accepts one argument and returns a string made up of an error code and returned statistics.
The first argument is a string of blank delimited words indicating the statistics to be returned. The length of each returned statistic is always a multiple of 4 bytes. This facilitates the use of $StatD with the returned string. For more information about available statistics, see the "SirMon User's Guide".
Syntax
<section begin="syntax" /> %STRING = $SyStat(stat_list) <section end="syntax" />
$SyStat Function
%STRING is made up of binary data, the first 4 bytes of which is an error code. If the error code is negative %STRING will only be 4 bytes long.
The data returned by $SyStat is binary with the first 4 bytes containing an error code. If the error code is negative, only 4 bytes are returned. If the error code is positive, it contains a number of milliseconds since the online region was brought up. This provides a convenient number for calculating rates for the statistics. When a positive error code is returned the next 10 bytes contain the blank padded word 'SYSTEM' followed by 2 bytes of binary 0. This means that the actual data starts at offset 16 (byte number 17) in the result string.
-5 - Required parameter not specified -12 - Invalid name in stat_list -13 - STAT not linked in -14 - Result string would be longer than 255 bytes
$SyStat return codes
The following program displays some totals for system statistics.
B %DATA IS STRING LEN 255 %DATA = $SyStat('CPU DKIO SVIO') IF $LEN(%DATA) = 4 THEN PRINT '$SYSTAT ERROR... RC = ' WITH $UNBIN(%DATA) STOP END IF PRINT 'CPU = ' WITH $UNBIN( $SUBSTR(%DATA, 17, 4) ) PRINT 'DKIO = ' WITH $UNBIN( $SUBSTR(%DATA, 21, 4) ) PRINT 'SVIO = ' WITH $UNBIN( $SUBSTR(%DATA, 25, 4) ) END
Products authorizing $SyStat