Debian Codegraph @

doc/SystemTap_Tapset_Reference/man_pages/tapset::json.3stap

raw
1 .\" -*- nroff -*-
2 .TH TAPSET::JSON 3stap "October 2025" "SystemTap Tapset Reference"
3 .SH NAME
4 tapset::json \- systemtap json tapset
5
6 .SH DESCRIPTION
7
8 The JSON tapset provides probes, functions, and macros to generate
9 a JSON metadata and data file. The JSON metadata file is located in
10 /proc/systemtap/MODULE/metadata.json. The JSON data file is located
11 in /proc/systemtap/MODULE/data.json. The JSON data file is updated
12 with current data every time the file is read.
13
14 .TP
15 .P
16 .TP
17 .B json_set_prefix
18 Set the metric prefix.
19 .IP
20 See
21 .IR function::json_set_prefix (3stap)
22 for details.
23 .P
24 .TP
25 .B json_add_numeric_metric
26 Add a numeric metric
27 .IP
28 See
29 .IR function::json_add_numeric_metric (3stap)
30 for details.
31 .P
32 .TP
33 .B json_add_string_metric
34 Add a string metric
35 .IP
36 See
37 .IR function::json_add_string_metric (3stap)
38 for details.
39 .P
40 .TP
41 .B json_add_array
42 Add an array
43 .IP
44 See
45 .IR function::json_add_array (3stap)
46 for details.
47 .P
48 .TP
49 .B json_add_array_numeric_metric
50 Add a numeric metric to an array
51 .IP
52 See
53 .IR function::json_add_array_numeric_metric (3stap)
54 for details.
55 .P
56 .TP
57 .B json_add_array_string_metric
58 Add a string metric to an array
59 .IP
60 See
61 .IR function::json_add_array_string_metric (3stap)
62 for details.
63 .P
64 .TP
65 .B json_data
66 Fires whenever JSON data is wanted by a reader.
67 .IP
68 See
69 .IR probe::json_data (3stap)
70 for details.
71 .P
72 .TP
73 .B @json_output_data_start
74 Start the json output.
75 .IP
76 See
77 .IR macro::json_output_data_start (3stap)
78 for details.
79 .P
80 .TP
81 .B @json_output_string_value
82 Output a string value.
83 .IP
84 See
85 .IR macro::json_output_string_value (3stap)
86 for details.
87 .P
88 .TP
89 .B @json_output_numeric_value
90 Output a numeric value.
91 .IP
92 See
93 .IR macro::json_output_numeric_value (3stap)
94 for details.
95 .P
96 .TP
97 .B @json_output_array_string_value
98 Output a string value for metric in an array.
99 .IP
100 See
101 .IR macro::json_output_array_string_value (3stap)
102 for details.
103 .P
104 .TP
105 .B @json_output_array_numeric_value
106 Output a numeric value for metric in an array.
107 .IP
108 See
109 .IR macro::json_output_array_numeric_value (3stap)
110 for details.
111 .P
112 .TP
113 .B @json_output_data_end
114 End the json output.
115 .IP
116 See
117 .IR macro::json_output_data_end (3stap)
118 for details.
119
120 .SH SEE ALSO
121 .BR
122 .IR \%function::json_set_prefix (3stap),
123 .BR
124 .IR \%function::json_add_numeric_metric (3stap),
125 .BR
126 .IR \%function::json_add_string_metric (3stap),
127 .BR
128 .IR \%function::json_add_array (3stap),
129 .BR
130 .IR \%function::json_add_array_numeric_metric (3stap),
131 .BR
132 .IR \%function::json_add_array_string_metric (3stap),
133 .BR
134 .IR \%probe::json_data (3stap),
135 .BR
136 .IR \%macro::json_output_data_start (3stap),
137 .BR
138 .IR \%macro::json_output_string_value (3stap),
139 .BR
140 .IR \%macro::json_output_numeric_value (3stap),
141 .BR
142 .IR \%macro::json_output_array_string_value (3stap),
143 .BR
144 .IR \%macro::json_output_array_numeric_value (3stap),
145 .BR
146 .IR \%macro::json_output_data_end (3stap),
147 .BR
148 .IR \%stap (1),
149 .IR \%stapprobes (3stap)