Skip to content

Commit ed9df17

Browse files
committed
First stab at documenting Telemetry::Instrument::Thread
1 parent 7f11360 commit ed9df17

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
2+
=begin pod
3+
4+
=TITLE class Telemetry::Instrument::Thread
5+
6+
=SUBTITLE Instrument for collecting Thread data
7+
8+
class Telemetry::Instrument::Thread { }
9+
10+
B<Note: > This class is a Rakudo-specific feature and not standard Perl 6.
11+
12+
Objects of this class are generally not created by themselves, but rather
13+
through making a L<snap|/type/Telemetry>shot.
14+
15+
This class provides the following datapoints (in alphabetical order):
16+
17+
=item tad
18+
19+
The number of threads that ended with an exception (B<t>hreads-B<a>borteB<d>).
20+
21+
=item tcd
22+
23+
The number of threads that completed without any problem
24+
(B<t>hreads-B<c>ompleteB<d>).
25+
26+
=item thid
27+
28+
Highest OS thread ID seen (B<t>hread-B<h>ighest-B<id>).
29+
30+
=item tjd
31+
32+
The number of threads that were joined (B<t>hreads-B<j>oineB<d>).
33+
34+
=item tsd
35+
36+
The number of threads that were started (B<t>hreads-B<s>tarteB<d>).
37+
38+
=item tyd
39+
40+
The number of times a thread was yielded (B<t>hreads-B<y>ieldeB<d>).
41+
42+
=end pod
43+
44+
# vim: expandtab softtabstop=4 shiftwidth=4 ft=perl6

0 commit comments

Comments
 (0)