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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
package Sys::CpuLoad;
# ABSTRACT: retrieve system load averages
# Copyright (c) 1999-2002 Clinton Wong. All rights reserved.
# This program is free software; you can redistribute it
# and/or modify it under the same terms as Perl itself.
use v5.6;
use strict;
use warnings;
use parent qw(Exporter);
use File::Which qw(which);
use IO::File;
use IPC::Run3 qw(run3);
use XSLoader;
our @EXPORT = qw();
our @EXPORT_OK = qw(load getloadavg proc_loadavg uptime);
our $VERSION = '0.32';
XSLoader::load 'Sys::CpuLoad', $VERSION;
our $LOAD;
sub load {
return getloadavg(@_) if $LOAD eq 'getloadavg';
return proc_loadavg(@_) if $LOAD eq 'proc_loadavg';
return uptime(@_) if $LOAD eq 'uptime';
die "Unknown function: $LOAD";
}
sub proc_loadavg {
if ( -r '/proc/loadavg' ) {
my $fh = IO::File->new( '/proc/loadavg', 'r' );
if ( defined $fh ) {
my $line = <$fh>;
$fh->close();
if ( $line =~ /^(\d+\.\d+)\s+(\d+\.\d+)\s+(\d+\.\d+)/ ) {
return ( $1, $2, $3 );
}
}
}
return undef;
}
our $UPTIME;
sub uptime {
local %ENV = %ENV;
$ENV{'LC_NUMERIC'} = 'POSIX'; # ensure that decimal separator is a dot
$UPTIME ||= which("uptime") or
return undef;
run3($UPTIME, \undef, \my $line);
return undef if $? || !defined($line);
if ( $line =~ /(\d+[,.]\d+)\s*,?\s+(\d+[,.]\d+)\s*,?\s+(\d+[,.]\d+)\s*$/m )
{
return ( map { my $n = $_; $n =~ tr/,/./; $n + 0 } ( $1, $2, $3 ) );
}
return undef;
}
sub BEGIN {
my $this = __PACKAGE__;
my $os = lc $^O;
if ( $os =~ /^(darwin|dragonfly|(free|net|open)bsd|linux|solaris|sunos)$/ ) {
$LOAD = 'getloadavg';
}
elsif ( -r '/proc/loadavg' && $os ne 'cygwin' ) {
$LOAD = 'proc_loadavg';
}
else {
$LOAD = 'uptime';
}
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Sys::CpuLoad - retrieve system load averages
=head1 VERSION
version 0.32
=head1 SYNOPSIS
use Sys::CpuLoad 'load';
print '1 min, 5 min, 15 min load average: ',
join(',', load()), "\n";
=head1 DESCRIPTION
This module retrieves the 1 minute, 5 minute, and 15 minute load average
of a machine.
=head1 EXPORTS
=head2 load
This method returns the load average for 1 minute, 5 minutes and 15
minutes as an array.
On Linux, Solaris, FreeBSD, NetBSD and OpenBSD systems, it will make a
call to L</getloadavg>.
If F</proc/loadavg> is available on non-Cygwin systems, it
will call L</proc_loadavg>.
Otherwise, it will attempt to parse the output of C<uptime>.
On error, it will return an array of C<undef> values.
As of v0.29, you can override the default function by changing
C<$Sys::CpuLoad::LOAD>:
use Sys::CpuLoad 'load';
no warnings 'once';
$Sys::CpuLoad::LOAD = 'uptimr';
@load = load();
If you are writing code to work on multiple systems, you should use
the C<load> function. But if your code is intended for specific systems,
then you should use the appropriate function.
=head2 getloadavg
This is a wrapper around the system call to C<getloadavg>.
If this call is unavailable, or it is fails, it will return C<undef>.
Added in v0.22.
=head2 proc_loadavg
If F</proc/loadavg> is available, it will be used.
If the data cannot be parsed, it will return C<undef>.
Added in v0.22.
=head2 uptime
Parse the output of uptime.
If the L<uptime> executable cannot be found, or the output cannot be
parsed, it will return C<undef>.
Added in v0.22.
As of v0.24, you can override the executable path by setting
C<$Sys::CpuLoad::UPTIME>, e.g.
use Sys::CpuLoad 'uptime';
no warnings 'once';
$Sys::CpuLoad::UPTIME = '/usr/bin/w';
@load = uptime();
=head1 SEE ALSO
L<Sys::CpuLoadX>
=head1 SOURCE
The development version is on github at L<https://github.com/robrwo/Sys-CpuLoad>
and may be cloned from L<git://github.com/robrwo/Sys-CpuLoad.git>
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website
L<https://github.com/robrwo/Sys-CpuLoad/issues>
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
=head1 AUTHORS
=over 4
=item *
Robert Rothenberg <rrwo@cpan.org>
=item *
Clinton Wong <clintdw@cpan.org>
=back
=head1 CONTRIBUTORS
=for stopwords Slaven Rezić Victor Wagner Dmitry Dorofeev Vincent Lefèvre
=over 4
=item *
Slaven Rezić <slaven@rezic.de>
=item *
Victor Wagner
=item *
Dmitry Dorofeev <dima@yasp.com>
=item *
Vincent Lefèvre <vincent@vinc17.net>
=back
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 1999-2002, 2020, 2025 by Clinton Wong <clintdw@cpan.org>.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|
