$StatLD - Revision history

JALWiccan: Automatically generated page update

2018-09-20T23:28:48Z

Automatically generated page update

← Older revision		Revision as of 23:28, 20 September 2018
Line 2:		Line 2:
	<span class="pageSubtitle">Calculate differences and rates for statistics $lists</span>		<span class="pageSubtitle">Calculate differences and rates for statistics $lists</span>

	<p class="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $StatLD function is the [[UserStatistics class]].</p>		<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $StatLD function is the [[UserStatistics class]].</p>

	This function allows calculation of differences and rates for statistics $lists. These statistics $lists must be in a format identical to $lists produced by <var>$CfStatL</var>, <var>$FiStatL</var>, <var>$TkStatL</var>, <var>$SsStatL</var>, <var>$UsStatL</var>, and <var>$JpStatL</var>.		This function allows calculation of differences and rates for statistics $lists. These statistics $lists must be in a format identical to $lists produced by <var>$CfStatL</var>, <var>$FiStatL</var>, <var>$TkStatL</var>, <var>$SsStatL</var>, <var>$UsStatL</var>, and <var>$JpStatL</var>.

JAL: typo

2017-11-27T22:26:38Z

typo

← Older revision		Revision as of 22:26, 27 November 2017
Line 4:		Line 4:
	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $StatLD function is the [[UserStatistics class]].</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $StatLD function is the [[UserStatistics class]].</p>

	This function allows calculation of differences and rates for statistics $lists. These statistics $lists must be in a format identical to $lists produced by <var>$~~CFStatL~~</var>, <var>$FiStatL</var>, <var>$TkStatL</var>, <var>$SsStatL</var>, <var>$UsStatL</var>, and <var>$JpStatL</var>.		This function allows calculation of differences and rates for statistics $lists. These statistics $lists must be in a format identical to $lists produced by <var>$CfStatL</var>, <var>$FiStatL</var>, <var>$TkStatL</var>, <var>$SsStatL</var>, <var>$UsStatL</var>, and <var>$JpStatL</var>.

	The <var>$StatLD</var> function accepts six arguments and returns a numeric error code.		The <var>$StatLD</var> function accepts six arguments and returns a numeric error code.

JAL: typo

2017-11-27T20:36:15Z

typo

← Older revision		Revision as of 20:36, 27 November 2017
Line 4:		Line 4:
	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $StatLD function is the [[UserStatistics class]].</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $StatLD function is the [[UserStatistics class]].</p>

	This function allows calculation of differences and rates for statistics $lists. These statistics $lists must be in a format identical to $lists produced by <var>$CFStatL</var>, <var>$FiStatL</var>, <var>$TkStatL</var>, <var>$SsStatL</var>, <var>$UsStatL</var>, and <var>$~~JPStatL~~</var>.		This function allows calculation of differences and rates for statistics $lists. These statistics $lists must be in a format identical to $lists produced by <var>$CFStatL</var>, <var>$FiStatL</var>, <var>$TkStatL</var>, <var>$SsStatL</var>, <var>$UsStatL</var>, and <var>$JpStatL</var>.

	The <var>$StatLD</var> function accepts six arguments and returns a numeric error code.		The <var>$StatLD</var> function accepts six arguments and returns a numeric error code.

JAL: minor cleanup

2016-04-18T17:57:09Z

minor cleanup

← Older revision		Revision as of 17:57, 18 April 2016
Line 22:		Line 22:

	<tr><th>list2_id</th>		<tr><th>list2_id</th>
	<td>The identifier of a $list where each item contains an EBCDIC identifier in bytes 1-10, a binary number in bytes 11-12 and data in bytes 13 to the end of the $list item. </td></tr>		<td>The identifier of a $list where each item contains an EBCDIC identifier in bytes 1-10, a binary number in bytes 11-12, and data in bytes 13 to the end of the $list item. </td></tr>

	<tr><th>list3_id</th>		<tr><th>list3_id</th>
	<td>The identifier of an output $list. The contents of this $list are deleted and replaced by the differences between the <var class="term">list1_id</var> ~~argument~~ $list and the <var class="term">list2_id</var> $list. </td></tr>		<td>The identifier of an output $list. The contents of this $list are deleted and replaced by the differences between the <var class="term">list1_id</var> $list and the <var class="term">list2_id</var> $list. </td></tr>

	<tr><th>action_list</th>		<tr><th>action_list</th>
	<td>A control string containing blank delimited tokens describing the action to be performed for each 4-byte chunk of the input $list items. The available actions are:		<td>A control string containing blank-delimited tokens describing the action to be performed for each 4-byte chunk of the input $list items. The available actions are:
	<ul>		<ul>
	<li>'N' - ~~stands for number~~. Simply copy 4 bytes from the <var class="term">list2_id</var> argument.		<li>'N' - Number. Simply copy 4 bytes from the <var class="term">list2_id</var> argument. </li>
	<li>'D' - ~~stands for difference~~. Calculate binary difference between 4 bytes in <var class="term">list2_id</var> and <var class="term">list1_id</var>.
	<li>'R' - ~~stands for rate~~. Calculate binary difference between 4 bytes in argument 2 and argument 1, multiply by 1,000,000 ~~and~~ then divide by ~~argument 4. The~~ <var class="term">divisor</var>argument ~~is required if an R is included in the control string~~.		<li>'D' - Difference. Calculate binary difference between 4 bytes in <var class="term">list2_id</var> and <var class="term">list1_id</var>. </li>

			<li>'R' - Rate. Calculate binary difference between 4 bytes in argument 2 and argument 1, multiply by 1,000,000, then divide by the <var class="term">divisor</var> argument. </li>
	</ul></td></tr>		</ul></td></tr>

	<tr><th>divisor</th>		<tr><th>divisor</th>
	<td>A number to be used as a divisor in calculating rates. This optional argument is required if there is an 'R' in the <var class="term">action_list</var> argument. This would ordinarily be the elapsed time between calculation of the <var class="term">list1_id</var> argument and the <var class="term">list2_id</var> argument.</td></tr>		<td>A number to be used as a divisor in calculating rates. This optional argument is required if there is an <code>R</code> in the <var class="term">action_list</var> argument. This would ordinarily be the elapsed time between calculation of the <var class="term">list1_id</var> argument and the <var class="term">list2_id</var> argument.</td></tr>

	<tr><th>pre_len</th>		<tr><th>pre_len</th>
Line 48:		Line 50:

	===Return codes===		===Return codes===
	<p class="code"> -3 - CCATEMP is full		<p class="code"> -3 - CCATEMP is full (if LISTFC <var>$SirParm</var> parameter not set)
	(if LISTFC <var>$SirParm</var> parameter not set)
	-5 - Required parameter not specified		-5 - Required parameter not specified
	-6 - Invalid $list identifier		-6 - Invalid $list identifier
Line 57:		Line 58:
	</p>		</p>

	==~~Example~~==		==Examples==
	The following program displays every user's CPU usage as a rate over one second interval and as a total over the whole run.		<ol>
			<li>The following program displays every user's CPU usage as a rate over one second interval and as a total over the whole run.

	<p class="code">Begin		<p class="code">Begin

	%i is float		%i is float
	%list1 is float		%list1 is float
Line 89:		Line 90:
	End Text		End Text
	End For		End For

	End		End
	</p>		</p></li>

	The ~~stat~~ collection functions ($~~FIStatL~~, $SSStatL, etc.) have a parameter that ~~allows the user to~~ subset the list of entities to be viewed. But those functions ~~will~~ always return the full list of entities. To view the subsetted list, the collected ~~stats~~ need to be run through $StatLD. This example demonstrates the technique:		<li>The statistics collection functions (<var>$FiStatL</var>, <var>$SSStatL</var>, etc.) have a parameter that lets you subset the list of entities to be viewed. But those functions always return the full list of entities. To view the subsetted list, the collected statistics need to be run through <var>$StatLD</var>. This example demonstrates the technique:

	<p class="code">begin		<p class="code">begin
Line 124:		Line 124:
	end		end
	</p>		</p>
			<p>
	The example shows a set of ~~Subsystem stats~~ collected by $~~SSStatL~~, limited to only those ~~Subsystems~~ with file SIRLOCAL open. The ~~stats~~ are collected twice, into lists %al1 and %al2, and then run through $StatLD to produce list %al3. $List %al3 shows the selected subset.		The example shows a set of subsystem statistics collected by <var>$SsStatL</var>, limited to only those subsystems with file <code>SIRLOCAL</code> open. The statistics are collected twice, into lists <code>%al1</code> and <code>%al2</code>, and then run through <var>$StatLD</var> to produce list <code>%al3</code>. $List <code>%al3</code> shows the selected subset. </p></li>
			</ol>

	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==
	<ul ~~class="smallAndTightList"~~>		<ul>
	<li>[[SirMon]]		<li>[[SirMon]]
	</ul>		</ul>


	[[Category:$Functions\|$StatLD]]		[[Category:$Functions\|$StatLD]]

Alan: /* Example */

2016-04-15T16:40:35Z

Example

← Older revision		Revision as of 16:40, 15 April 2016
Line 93:		Line 93:
	</p>		</p>

	The stat collection functions ($FIStatL, $SSStatL, etc.) have a parameter that allows the user to subset the list of entities to be viewed. But those functions will always return the full list of entities. To view the subsetted list, the collected stats need to be run through $StatLD. This ~~sample shows~~ the technique:		The stat collection functions ($FIStatL, $SSStatL, etc.) have a parameter that allows the user to subset the list of entities to be viewed. But those functions will always return the full list of entities. To view the subsetted list, the collected stats need to be run through $StatLD. This example demonstrates the technique:

	<p class="code">begin		<p class="code">begin
Line 125:		Line 125:
	</p>		</p>

	The ~~sample~~ shows a set of Subsystem stats, collected by $SSStatL, limited to only those Subsystems with file SIRLOCAL open. The stats are collected twice, into lists %al1 and %al2, and then run through $StatLD to produce list %al3~~, which only~~ shows the selected subset.		The example shows a set of Subsystem stats collected by $SSStatL, limited to only those Subsystems with file SIRLOCAL open. The stats are collected twice, into lists %al1 and %al2, and then run through $StatLD to produce list %al3. $List %al3 shows the selected subset.

	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==

Alan: /* Example */

2016-04-15T15:29:56Z

Example

@@ Line 92: / Line 92: @@
 End
 </p>
 ==Products authorizing {{PAGENAMEE}}==

JAL at 20:38, 24 July 2013

2013-07-24T20:38:47Z

← Older revision		Revision as of 20:38, 24 July 2013
Line 4:		Line 4:
	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $StatLD function is the [[UserStatistics class]].</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $StatLD function is the [[UserStatistics class]].</p>

	This function allows calculation of differences and rates for statistics $lists. These statistics $lists must be in a format identical to $lists produced by $CFStatL, $FiStatL, $TkStatL, $SsStatL, $UsStatL and $JPStatL.		This function allows calculation of differences and rates for statistics $lists. These statistics $lists must be in a format identical to $lists produced by <var>$CFStatL</var>, <var>$FiStatL</var>, <var>$TkStatL</var>, <var>$SsStatL</var>, <var>$UsStatL</var>, and <var>$JPStatL</var>.

	The $StatLD function accepts six arguments and returns a numeric error code.		The <var>$StatLD</var> function accepts six arguments and returns a numeric error code.

	~~The first argument is the identifier of a $list where each item contains an EBCDIC identifier in bytes 1-10, a binary number in bytes 11-12 and data in bytes 13 to the end of the $list item.~~

	~~The second argument is the identifier of a~~ $~~list where each item contains an EBCDIC identifier in bytes 1-10~~, ~~a binary number in bytes 11-12 and data in bytes 13 to the end of the $list item.~~		==Syntax==
			<p class="syntax"><span class="term">%result</span> = <span class="literal">$StatLD</span>(<span class="term">list1_id</span>, <span class="term">list2_id</span>, <span class="term">list3_id</span>, <span class="term">action_list</span>, <span class="term">divisor</span>, <span class="term">prelen</span>)
			</p>

	~~The third argument is the identifier of an output $list. The contents of this $list are deleted and replaced by the differences between the argument 1 $list and the argument 2 $list~~.		===Syntax terms===
			<table>
			<tr><th>%result</th>
			<td>Either 0 or a negative error code.</td></tr>

	The ~~fourth argument is~~ a ~~control string containing blank delimited tokens describing~~ the ~~action to be performed for each 4 byte chunk~~ of the ~~input~~ $list ~~items~~. ~~The available actions are~~		<tr><th>list1_id</th>
			<td>The identifier of a $list where each item contains an EBCDIC identifier in bytes 1-10, a binary number in bytes 11-12, and data in bytes 13 to the end of the $list item. </td></tr>

	<ul>		<tr><th>list2_id</th>
	<li>~~'N' - stands for number. Simply copy 4 bytes from argument 2.~~		<td>The identifier of a $list where each item contains an EBCDIC identifier in bytes 1-10, a binary number in bytes 11-12 and data in bytes 13 to the end of the $list item. </td></tr>
	<li>~~'D' - stands for difference. Calculate binary difference between 4~~ bytes ~~in argument 2 and argument~~ 1.
	~~<li>'R'~~ - ~~stands for rate. Calculate~~ binary ~~difference between 4~~ bytes ~~in argument 2~~ and ~~argument 1, multiply by 1,000,000 and then divide by argument 4. The fifth argument is required if an R is included~~ in the ~~control string~~.
	</ul>

	The ~~fifth argument is a number to be used as a divisor in calculating rates. This is an optional argument but is required if there is~~ an ~~'R' in the control string (argument 4)~~. ~~This would ordinarily be~~ the ~~elapsed time~~ between ~~calculation of~~ the ~~first~~ argument and the ~~second~~.		<tr><th>list3_id</th>
			<td>The identifier of an output $list. The contents of this $list are deleted and replaced by the differences between the <var class="term">list1_id</var> argument $list and the <var class="term">list2_id</var> $list. </td></tr>

	~~The sixth argument is a number of characters at~~ the ~~beginning~~ of the ~~output~~ list ~~(parameter 3) reserved~~ for the ~~name of the monitored entity~~. ~~Should be set to 30 when monitoring Janus ports~~ and ~~10 (~~the ~~default) for all other entities~~.		<tr><th>action_list</th>
			<td>A control string containing blank delimited tokens describing the action to be performed for each 4-byte chunk of the input $list items. The available actions are:
			<ul>
			<li>'N' - stands for number. Simply copy 4 bytes from the <var class="term">list2_id</var> argument.
			<li>'D' - stands for difference. Calculate binary difference between 4 bytes in <var class="term">list2_id</var> and <var class="term">list1_id</var>.
			<li>'R' - stands for rate. Calculate binary difference between 4 bytes in argument 2 and argument 1, multiply by 1,000,000 and then divide by argument 4. The <var class="term">divisor</var>argument is required if an R is included in the control string.
			</ul></td></tr>

	~~==Syntax==~~		<tr><th>divisor</th>
	<~~p class="syntax"~~><~~span class="term"~~>~~%result~~</~~span~~> = <~~span class="literal"~~>~~$StatLD~~<~~/span>(<span~~ class="term">~~list1_id~~</~~span~~>, <~~span~~ class="term">~~list2_id~~</~~span~~>, <~~span~~ class="term">~~list3_id~~</~~span~~>~~, -~~		<td>A number to be used as a divisor in calculating rates. This optional argument is required if there is an 'R' in the <var class="term">action_list</var> argument. This would ordinarily be the elapsed time between calculation of the <var class="term">list1_id</var> argument and the <var class="term">list2_id</var> argument.</td></tr>
	~~<span class="term">action_list</span>, <span class="term">divisor~~</~~span~~>~~, <span class="term">prelen</span>)~~
	</p>

	<p>		<tr><th>pre_len</th>
	<~~var class="term"~~>~~%result~~</~~var~~> ~~is either 0 or a negative error code~~.</p>		<td>A number of characters at the beginning of the output list (parameter 3) reserved for the name of the monitored entity. Should be set to 30 when monitoring Janus ports, and to 10 (the default) for all other entities.
			</table>

	The data returned into the output $list by <var>$StatLD</var> is binary with the first 12 bytes matching the first 12 bytes of an item in the second $list that matches one in the first list. Any item in the second $list that has the high order bit of byte 11 on (set to flag exclusion by a selection criterion on <var>$FistatL</var>, <var>$TkstatL</var>, <var>$SsStatL</var>, or <var>$UsStatL</var>) is excluded from the new $list. The actual difference data starts at offset 12 (byte number 13) in the result $list items.		==Usage notes==
			<ul>
			<li>The data returned into the output $list by <var>$StatLD</var> is binary, with the first 12 bytes matching the first 12 bytes of an item in the second $list that matches one in the first list. Any item in the second $list that has the high order bit of byte 11 on (set to flag exclusion by a selection criterion on <var>$FistatL</var>, <var>$TkstatL</var>, <var>$SsStatL</var>, or <var>$UsStatL</var>) is excluded from the new $list. The actual difference data starts at offset 12 (byte number 13) in the result $list items.
			</ul>

	===Return codes===		===Return codes===
	<p class="code"> -3 - CCATEMP is full		<p class="code"> -3 - CCATEMP is full
	(if LISTFC <var>$SirParm</var> parameter not set)		(if LISTFC <var>$SirParm</var> parameter not set)
	-5 - Required parameter not specified		-5 - Required parameter not specified
	-6 - Invalid $list identifier		-6 - Invalid $list identifier
Line 86:		Line 97:
	<li>[[SirMon]]		<li>[[SirMon]]
	</ul>		</ul>
	~~<p>~~
	~~</p>~~

	[[Category:$Functions\|$StatLD]]		[[Category:$Functions\|$StatLD]]

JALWiccan: Automatically generated page update

2013-07-19T18:59:31Z

Automatically generated page update

← Older revision		Revision as of 18:59, 19 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Calculate differences and rates for statistics $lists</span>		<span class="pageSubtitle">Calculate differences and rates for statistics $lists</span>

	<p class="~~warning~~">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $StatLD function is the [[UserStatistics class]].</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $StatLD function is the [[UserStatistics class]].</p>

	This function allows calculation of differences and rates for statistics $lists. These statistics $lists must be in a format identical to $lists produced by $CFStatL, $FiStatL, $TkStatL, $SsStatL, $UsStatL and $JPStatL.		This function allows calculation of differences and rates for statistics $lists. These statistics $lists must be in a format identical to $lists produced by $CFStatL, $FiStatL, $TkStatL, $SsStatL, $UsStatL and $JPStatL.

JAL at 21:00, 20 June 2013

2013-06-20T21:00:24Z

← Older revision		Revision as of 21:00, 20 June 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Calculate differences and rates for statistics $lists</span>		<span class="pageSubtitle">Calculate differences and rates for statistics $lists</span>

	<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. ~~There is no~~ OO equivalent for the $StatLD function.</p>		<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $StatLD function is the [[UserStatistics class]].</p>

	This function allows calculation of differences and rates for statistics $lists. These statistics $lists must be in a format identical to $lists produced by $CFStatL, $FiStatL, $TkStatL, $SsStatL, $UsStatL and $JPStatL.		This function allows calculation of differences and rates for statistics $lists. These statistics $lists must be in a format identical to $lists produced by $CFStatL, $FiStatL, $TkStatL, $SsStatL, $UsStatL and $JPStatL.

JALWiccan: Automatically generated page update

2013-04-12T18:43:42Z

Automatically generated page update

← Older revision		Revision as of 18:43, 12 April 2013
Line 27:		Line 27:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = <span class="literal">$StatLD</span>(<span class="term">list1_id</span>, ~~<span class="term"></span>~~<span class="term">list2_id</span>, ~~<span class="term"></span>~~<span class="term">list3_id</span>, ~~<span class="term"></span>~~-		<p class="syntax"><span class="term">%result</span> = <span class="literal">$StatLD</span>(<span class="term">list1_id</span>, <span class="term">list2_id</span>, <span class="term">list3_id</span>, -
	<span class="term">action_list</span>, ~~<span class="term"></span>~~<span class="term">divisor</span>, ~~<span class="term"></span>~~<span class="term">prelen</span>)		<span class="term">action_list</span>, <span class="term">divisor</span>, <span class="term">prelen</span>)
	</p>		</p>