Debian Codegraph @

doc/SystemTap_Tapset_Reference/man3/macro::json_output_array_numeric_value.3stap

raw
1 '\" t
2 .\" Title: macro::json_output_array_numeric_value
3 .\" Author:
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: October 2025
6 .\" Manual: JSON Tapset
7 .\" Source: SystemTap Tapset Reference
8 .\" Language: English
9 .\"
10 .TH "MACRO::JSON_OUTPUT_A" "3stap" "October 2025" "SystemTap Tapset Reference" "JSON 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 macro::json_output_array_numeric_value \- Output a numeric value for metric in an array\&.
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 @json_output_array_numeric_value(array_name,array_index,metric_name,value)
36 .fi
37 .SH "ARGUMENTS"
38 .PP
39 \fIarray_name\fR
40 .RS 4
41 The name of the array\&.
42 .RE
43 .PP
44 \fIarray_index\fR
45 .RS 4
46 The array index (as a string) indicating where to store the numeric value\&.
47 .RE
48 .PP
49 \fImetric_name\fR
50 .RS 4
51 The name of the numeric metric\&.
52 .RE
53 .PP
54 \fIvalue\fR
55 .RS 4
56 The numeric value to output\&.
57 .RE
58 .SH "DESCRIPTION"
59 .PP
60 The json_output_array_numeric_value macro is designed to be called from the \*(Aqjson_data\*(Aq probe in the user\*(Aqs script to output a metric\*(Aqs numeric value that is in an array\&. This metric should have been added with
61 \fBjson_add_array_numeric_metric\fR\&.
62 .SH SEE ALSO\n
63 .IR tapset::json (3stap)