Debian Codegraph @

doc/SystemTap_Tapset_Reference/man3/function::get_loadavg_index.3stap

raw
1 '\" t
2 .\" Title: function::get_loadavg_index
3 .\" Author:
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: October 2025
6 .\" Manual: Kernel Process Tapset
7 .\" Source: SystemTap Tapset Reference
8 .\" Language: English
9 .\"
10 .TH "FUNCTION::GET_LOADAV" "3stap" "October 2025" "SystemTap Tapset Reference" "Kernel Process Tapset"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 function::get_loadavg_index \- Get the load average for a specified interval
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 get_loadavg_index:long(indx:long)
36 .fi
37 .SH "ARGUMENTS"
38 .PP
39 \fIindx\fR
40 .RS 4
41 The load average interval to capture\&.
42 .RE
43 .SH "DESCRIPTION"
44 .PP
45 This function returns the load average at a specified interval\&. The three load average values 1, 5 and 15 minute average corresponds to indexes 0, 1 and 2 of the avenrun array \- see linux/sched\&.h\&. Please note that the truncated\-integer portion of the load average is returned\&. If the specified index is out\-of\-bounds, then an error message and exception is thrown\&.
46 .SH SEE ALSO\n
47 .IR tapset::loadavg (3stap)