Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Unbust doc build
  • Loading branch information
zoffixznet committed Nov 4, 2017
1 parent b558e09 commit 1dcf12a
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 19 deletions.
24 changes: 10 additions & 14 deletions doc/Type/Telemetry.pod6
Expand Up @@ -20,9 +20,9 @@ standalone subroutines.
use Telemetry; # imports default subroutines: T, snap, snapper, periods, report
use Telemetry :COLUMNS; # imports all of the possible columns of report
use Telemetry < cpu wallclock snap >; # only imports cpu, wallclock and snap
=end
=end code
=for available data
=head2 available data
=item affinity-tasks-completed
Expand Down Expand Up @@ -65,11 +65,11 @@ name: C<gtq>.
The number of general worker threads. Column name: C<gw>.
=head2 max-rss
=item max-rss
Maximum resident set size (in Kbytes).
=head2 supervisor
=item supervisor
The number of supervisor threads running, usually C<0> or C<1>. Column name:
C<s>.
Expand All @@ -91,8 +91,6 @@ The number of timer worker threads. Column name: C<tw>.
The time the program has been executing (in microseconds).
=back
Apart from this data, other fields in the POSIX C<getrusage> struct are also
collected, but are probably not in use on most operating systems and will thus
always give 0. These are (column names in parenthesis):
Expand All @@ -109,7 +107,7 @@ fields.
use Telemetry;
my $t = Telemetry.new;
say "Used $t (cpu / wallclock) microseconds to execute so far";
=end
=end code
=head1 Additional subroutines
Expand All @@ -122,7 +120,7 @@ interpolate multiple values in a single statement:
=begin code
use Telemetry;
say "Used {T<max-rss cpu>} (KBytes CPU) so far";
=end
=end code
=head2 routine snap
Expand All @@ -137,7 +135,7 @@ for ^5 {
# do some stuff
LAST snap(@t);
}
=end
=end code
If no array is specified, it will use an internal array for convenience.
Expand Down Expand Up @@ -167,7 +165,7 @@ by default.
17 / 17
15 / 16
29 / 28
=end
=end code
If no array is specified, it will use the internal array of C<snap> without
parameters B<and> will reset that array upon completion (so that new C<snap>s
Expand All @@ -186,7 +184,7 @@ for ^5 {
17 / 18
17 / 16
27 / 27
=end
=end code
If only one C<snap> was done, another C<snap> will be done to create at least
one C<Telemetry::Period> object.
Expand All @@ -199,7 +197,7 @@ calling C<snap>, or by having a L<snapper> running. If no positional parameter
is used, it will assume the internal array to which the parameterless C<snap>
pushes.
=for additional named parameters
=head3 additional named parameters
=item :columns
Expand All @@ -224,8 +222,6 @@ Specifies whether a legend should be added to the report. If not specified,
defaults to what is specified in the C<RAKUDO_REPORT_LEGEND> environment variable.
If that is not set either, defaults to True.
=back
If there are C<snap>s available in the internal array at the end of the
program, then C<report> will be automatically generated and printed on C<STDERR>.
Expand Down
8 changes: 3 additions & 5 deletions doc/Type/Telemetry/Period.pod6
Expand Up @@ -18,9 +18,9 @@ my $t0 = Telemetry.new;
my $t1 = Telemetry.new;
my $period = $t1 - $t0; # creates Telemetry::Period object
say "Code took $period (cpu / wallclock) microseconds to execute";
=end
=end code
=for Data Methods
=head2 Data Methods
=item method affinity-tasks-completed
Expand Down Expand Up @@ -89,13 +89,11 @@ The number of timer worker threads that were added in this period.
=item method utilization
Returns the % of CPUs that were used on average in this period.
=item method wallclock
Returns the length of the period (in microseconds).
=back
Apart from these data methods, other fields in the POSIX C<getrusage> struct
are also available, but are probably not in use on most operating systems and
will thus always give 0. These are:
Expand Down

0 comments on commit 1dcf12a

Please sign in to comment.