UserStatistics class: Difference between revisions
mNo edit summary |
m (link repair) |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
Intended for performance work, the <var>UserStatistics</var> class | Intended for performance work, the <var>UserStatistics</var> class | ||
is designed to replace $ | is designed to replace <var>[[$Stat]]</var> and similar tools that return the | ||
values for selected <var class="product">Model 204</var> User statistics. | values for selected <var class="product">Model 204</var> User statistics. | ||
The <var>[[New_(UserStatistics_constructor)|New]]</var> constructor takes a snapshot of the user stat block at the time the constructor is invoked. | The <var>[[New_(UserStatistics_constructor)|New]]</var> constructor takes a snapshot of the user stat block at the time the constructor is invoked. You then use the <var>UserStatistics</var> methods to extract the statistical data from the instantiated object. | ||
to extract the statistical data from the instantiated object | |||
__TOC__ | __TOC__ | ||
| Line 13: | Line 10: | ||
The object holds two types of user statistics: '''Login''' and '''Request'''. | The object holds two types of user statistics: '''Login''' and '''Request'''. | ||
<ul> | <ul> | ||
<li><div id="login"></div>Login statistics (also called | <li><div id="login"></div>Login statistics (also called "Final") are those that keep data per user since the user's most recent login. The statistics available to the <var class="product">Model 204</var> <var>$Stat</var> function, as well as the <var>OBJSWAP</var> statistic for [[Object oriented programming in SOUL|SOUL objects]], are valid. | ||
<li><div id="request"></div>Request statistics are a combination of: | <li><div id="request"></div>Request statistics are a combination of: | ||
<ul> | <ul> | ||
<li>Statistics that keep the | <li>Statistics that keep the current highwater marks for some work tables per user. | ||
current | <var class="product">Model 204</var> documentation includes these with "since last" statistics. | ||
<var class="product">Model 204</var> documentation includes these with | |||
<li>Since last statistics, which keep data per user comprising | <li>Since last statistics, which keep data per user comprising | ||
| Line 27: | Line 23: | ||
</ul> | </ul> | ||
Login and Request statistics are not mutually exclusive. | Login and Request statistics are not mutually exclusive. Both Login and Request data are kept for some activities, so many | ||
Both Login and Request data are kept for some activities, so many | |||
statistics appear in lists of both types and are valid in all methods | statistics appear in lists of both types and are valid in all methods | ||
that are restricted to one type or the other. | that are restricted to one type or the other. | ||
The | The [[Using system statistics]] topic and the <var class="product">[[SirMon]]</var> documentation are good sources of information about the | ||
available statistics | available statistics (note that not all <var class="product">SirMon</var> statistics are included in a <var>UserStatistics</var> object). | ||
are included in a <var>UserStatistics</var> object. | |||
Where they occasionally differ in spelling the name of a statistic, | Where they occasionally differ in spelling the name of a statistic, | ||
"Using system statistics" is more likely to have what the <var>UserStatistics</var> | |||
methods require. | methods require. | ||
| Line 44: | Line 38: | ||
</p> | </p> | ||
This displays all of | This displays all of the Login statistics followed by all the Request statistics. | ||
the Login statistics followed by all the Request statistics. | <p class="note">'''Note:''' | ||
< | |||
The <var>ToString</var> method shown above can be applied implicitly: | The <var>ToString</var> method shown above can be applied implicitly: | ||
simply | simply <var>Print</var> or <var>Audit</var> an object variable, and | ||
the <var>ToString</var> method is automatically applied to the object. | the <var>ToString</var> method is automatically applied to the object. | ||
<code>Print %statObject</code> is equivalent to <code>Print %statObject:ToString</code>. | <code>Print %statObject</code> is equivalent to <code>Print %statObject:ToString</code>. </p> | ||
==Example== | ==Example== | ||
The following is a simple example that | The following is a simple example that shows how much CPU a request uses and how many <var>DKRD</var>s it did: | ||
shows how much CPU a request uses and how many | |||
<p class="code">b | <p class="code">b | ||
%statStart is object userStatistics | %statStart is object userStatistics | ||
| Line 71: | Line 63: | ||
==List of UserStatistics methods== | ==List of UserStatistics methods== | ||
The [[List of UserStatistics methods | The [[List of UserStatistics methods]] shows all the class methods. | ||
[[Category:System classes]] | [[Category:System classes]] | ||
Latest revision as of 18:12, 13 September 2016
Intended for performance work, the UserStatistics class is designed to replace $Stat and similar tools that return the values for selected Model 204 User statistics.
The New constructor takes a snapshot of the user stat block at the time the constructor is invoked. You then use the UserStatistics methods to extract the statistical data from the instantiated object.
About the UserStatistics statistics
The object holds two types of user statistics: Login and Request.
- Login statistics (also called "Final") are those that keep data per user since the user's most recent login. The statistics available to the Model 204 $Stat function, as well as the OBJSWAP statistic for SOUL objects, are valid.
- Request statistics are a combination of:
- Statistics that keep the current highwater marks for some work tables per user. Model 204 documentation includes these with "since last" statistics.
- Since last statistics, which keep data per user comprising only the user's most recent work unit (like compilation or evaluation); they are not accumulated.
Login and Request statistics are not mutually exclusive. Both Login and Request data are kept for some activities, so many statistics appear in lists of both types and are valid in all methods that are restricted to one type or the other.
The Using system statistics topic and the SirMon documentation are good sources of information about the available statistics (note that not all SirMon statistics are included in a UserStatistics object). Where they occasionally differ in spelling the name of a statistic, "Using system statistics" is more likely to have what the UserStatistics methods require.
You can also view all the individual statistics contained in a UserStatistics object by applying the ToString method to it, as follows:
Print %statObject:ToString(Zeros=true)
This displays all of the Login statistics followed by all the Request statistics.
Note:
The ToString method shown above can be applied implicitly:
simply Print or Audit an object variable, and
the ToString method is automatically applied to the object.
Print %statObject is equivalent to Print %statObject:ToString.
Example
The following is a simple example that shows how much CPU a request uses and how many DKRDs it did:
b %statStart is object userStatistics %statEnd is object userStatistics %statStart = new ... processing %statEnd = new printText CPU: {%statEnd:difference(%statStart, 'CPU')} printText DKRDs: {%statEnd:difference(%statStart, 'DKRD')} end
Specifying a statistic that is not a User statistic, or that is not the type of statistic (Login or Request) that a method calls for, triggers an UnknownStatistic exception.
List of UserStatistics methods
The List of UserStatistics methods shows all the class methods.