The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

PEVANS / Future-AsyncAwait-Metrics-0.01 / lib / Future / AsyncAwait / Metrics.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
—
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
—
93
94
95
96
97
98
99
100

              
#  You may distribute under the terms of either the GNU General Public License
#  or the Artistic License (the same terms as Perl itself)
#
#  (C) Paul Evans, 2022 -- leonerd@leonerd.org.uk
package Future::AsyncAwait::Metrics 0.01;
use v5.14;
use warnings;
use Metrics::Any 0.09 '$metrics',
   name_prefix => [ 'asyncawait' ],
   strict      => 1;
require XSLoader;
XSLoader::load( __PACKAGE__, our $VERSION );
=head1 NAME
C<Future::AsyncAwait::Metrics> - report metrics from C<Future::AsyncAwait> to C<Metrics::Any>
=head1 SYNOPSIS
   use Future::AsyncAwait::Metrics;
   # Additional metrics will now be reported
=head1 DESCRIPTION
This module provides no functions or other import symbols. Instead, by simply
loading it somewhere in the program, additional metrics are created and
reported to L<Metrics::Any> about the operation of L<Future::AsyncAwait>.
=cut
=head1 METRICS
The following metrics are reported:
=head2 asyncawait_suspends
A counter of the number of times an C<async sub> has been suspended.
=head2 asyncawait_resumes
A counter of the number of times an C<async sub> has been resumed.
=head2 asyncawait_current_subs
A gauge giving the current count of C<async sub> instances currently
suspended.
=head2 asyncawait_states_created
A counter of the number of times that C<async sub> context storage has been
created. This may be less than C<asyncawait_suspends> because storage is
reused for multiple C<await> calls within any one function invocation.
=head2 asyncawait_states_destroyed
A counter giving the number of times that C<async sub> context storage has
been destroyed.
=head2 asyncawait_current_states
A gauge giving the current count of C<async sub> context storage instances.
This may be less than C<asyncawait_current_subs> because not all of them may
be currently suspended.
=cut
$metrics->make_counter( suspends =>
   description => "Count of the number of times an async sub has been suspended",
);
$metrics->make_counter( resumes =>
   description => "Count of the number of times an async sub has been resumed",
);
$metrics->make_gauge( current_subs =>
   description => "Current number of suspended async subs",
);
$metrics->make_counter( states_created =>
   description => "Count of the number of times async sub state storage has been created",
);
$metrics->make_counter( states_destroyed =>
   description => "Count of the number of times async sub state storage has been destroyed",
);
$metrics->make_gauge( current_states =>
   description => "Current number of async sub state storage instances",
);
=head1 AUTHOR
Paul Evans <leonerd@leonerd.org.uk>
=cut
0x55AA;