-
Notifications
You must be signed in to change notification settings - Fork 89
/
Copy pathprom__collector_8h.html
394 lines (367 loc) · 21.9 KB
/
prom__collector_8h.html
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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>prometheus-client-c: prom/include/prom_collector.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">prometheus-client-c
 <span id="projectnumber">0.1.1</span>
</div>
<div id="projectbrief">Prometheus client for the C programming language</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_2c63f04010e7ff462eba5e344f58cd21.html">prom</a></li><li class="navelem"><a class="el" href="dir_83821d63a26a6eb889c4977bd95ca990.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">prom_collector.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A Prometheus collector returns a collection of metrics.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "prom_map.h"</code><br />
<code>#include "<a class="el" href="prom__metric_8h_source.html">prom_metric.h</a>"</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for prom_collector.h:</div>
<div class="dyncontent">
<div class="center"><img src="prom__collector_8h__incl.png" border="0" usemap="#prom_2include_2prom__collector_8h" alt=""/></div>
<map name="prom_2include_2prom__collector_8h" id="prom_2include_2prom__collector_8h">
<area shape="rect" id="node2" href="prom__map_8h_source.html" title="prom_map.h" alt="" coords="5,80,109,107"/>
<area shape="rect" id="node3" href="prom__metric_8h.html" title="Functions for retrieving metric samples from metrics given an ordered set of labels. " alt="" coords="133,80,251,107"/>
<area shape="rect" id="node4" href="prom__metric__sample_8h.html" title="Functions for interfacting with metric samples directly. " alt="" coords="10,162,182,189"/>
<area shape="rect" id="node5" href="prom__metric__sample__histogram_8h.html" title="Functions for interacting with histogram metric samples directly. " alt="" coords="207,155,367,196"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="prom__collector_8h__dep__incl.png" border="0" usemap="#prom_2include_2prom__collector_8hdep" alt=""/></div>
<map name="prom_2include_2prom__collector_8hdep" id="prom_2include_2prom__collector_8hdep">
<area shape="rect" id="node2" href="prom_8h.html" title="Include prom.h to include the entire public API. " alt="" coords="5,169,163,196"/>
<area shape="rect" id="node3" href="prom__collector__registry_8h.html" title="The collector registry registers collectors for metric exposition. " alt="" coords="121,80,329,121"/>
<area shape="rect" id="node4" href="promhttp_8h.html" title="Provides a HTTP endpoint for metric exposition References: " alt="" coords="187,169,397,196"/>
</map>
</div>
</div>
<p><a href="prom__collector_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a28cf36f114f69a96508c044c44716f9c"><td class="memItemLeft" align="right" valign="top"><a id="a28cf36f114f69a96508c044c44716f9c"></a>
typedef struct prom_collector </td><td class="memItemRight" valign="bottom"><a class="el" href="prom__collector_8h.html#a28cf36f114f69a96508c044c44716f9c">prom_collector_t</a></td></tr>
<tr class="memdesc:a28cf36f114f69a96508c044c44716f9c"><td class="mdescLeft"> </td><td class="mdescRight">A prometheus collector calls collect to prepare metrics and return them to the registry to which it is registered. <br /></td></tr>
<tr class="separator:a28cf36f114f69a96508c044c44716f9c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af87330edd48cdb8e1074517e734b1e40"><td class="memItemLeft" align="right" valign="top">typedef prom_map_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="prom__collector_8h.html#af87330edd48cdb8e1074517e734b1e40">prom_collect_fn</a>(<a class="el" href="prom__collector_8h.html#a28cf36f114f69a96508c044c44716f9c">prom_collector_t</a> *self)</td></tr>
<tr class="memdesc:af87330edd48cdb8e1074517e734b1e40"><td class="mdescLeft"> </td><td class="mdescRight">The function responsible for preparing metric data and returning metrics for a given collector. <a href="#af87330edd48cdb8e1074517e734b1e40">More...</a><br /></td></tr>
<tr class="separator:af87330edd48cdb8e1074517e734b1e40"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a4300cf33b6f8e4457df385c3d2a51a4b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="prom__collector_8h.html#a28cf36f114f69a96508c044c44716f9c">prom_collector_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="prom__collector_8h.html#a4300cf33b6f8e4457df385c3d2a51a4b">prom_collector_new</a> (const char *name)</td></tr>
<tr class="memdesc:a4300cf33b6f8e4457df385c3d2a51a4b"><td class="mdescLeft"> </td><td class="mdescRight">Create a collector. <a href="#a4300cf33b6f8e4457df385c3d2a51a4b">More...</a><br /></td></tr>
<tr class="separator:a4300cf33b6f8e4457df385c3d2a51a4b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af50746bb4af87eda617fa08237e3834e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="prom__collector_8h.html#a28cf36f114f69a96508c044c44716f9c">prom_collector_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="prom__collector_8h.html#af50746bb4af87eda617fa08237e3834e">prom_collector_process_new</a> (const char *limits_path, const char *stat_path)</td></tr>
<tr class="memdesc:af50746bb4af87eda617fa08237e3834e"><td class="mdescLeft"> </td><td class="mdescRight">Construct a prom_collector_t* which includes the default process metrics. <a href="#af50746bb4af87eda617fa08237e3834e">More...</a><br /></td></tr>
<tr class="separator:af50746bb4af87eda617fa08237e3834e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a037b72b2edb81a477999a7dfc08758c7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="prom__collector_8h.html#a037b72b2edb81a477999a7dfc08758c7">prom_collector_destroy</a> (<a class="el" href="prom__collector_8h.html#a28cf36f114f69a96508c044c44716f9c">prom_collector_t</a> *self)</td></tr>
<tr class="memdesc:a037b72b2edb81a477999a7dfc08758c7"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a collector. <a href="#a037b72b2edb81a477999a7dfc08758c7">More...</a><br /></td></tr>
<tr class="separator:a037b72b2edb81a477999a7dfc08758c7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a875b72940cd578ee76c71f1f4853f139"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="prom__collector_8h.html#a875b72940cd578ee76c71f1f4853f139">prom_collector_free_generic</a> (void *gen)</td></tr>
<tr class="memdesc:a875b72940cd578ee76c71f1f4853f139"><td class="mdescLeft"> </td><td class="mdescRight">Frees a collector passed as a void pointer. <a href="#a875b72940cd578ee76c71f1f4853f139">More...</a><br /></td></tr>
<tr class="separator:a875b72940cd578ee76c71f1f4853f139"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a12c297cce0a30ee4149f2b486d9f0337"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="prom__collector_8h.html#a12c297cce0a30ee4149f2b486d9f0337">prom_collector_destroy_generic</a> (void *gen)</td></tr>
<tr class="memdesc:a12c297cce0a30ee4149f2b486d9f0337"><td class="mdescLeft"> </td><td class="mdescRight">Destroys a collector passed as a void pointer. <a href="#a12c297cce0a30ee4149f2b486d9f0337">More...</a><br /></td></tr>
<tr class="separator:a12c297cce0a30ee4149f2b486d9f0337"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abd87021bd63f759d55642685a74874ee"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="prom__collector_8h.html#abd87021bd63f759d55642685a74874ee">prom_collector_add_metric</a> (<a class="el" href="prom__collector_8h.html#a28cf36f114f69a96508c044c44716f9c">prom_collector_t</a> *self, <a class="el" href="prom__metric_8h.html#afd1bd014c48955d6c2c36aa8a8cbb889">prom_metric_t</a> *metric)</td></tr>
<tr class="memdesc:abd87021bd63f759d55642685a74874ee"><td class="mdescLeft"> </td><td class="mdescRight">Add a metric to a collector. <a href="#abd87021bd63f759d55642685a74874ee">More...</a><br /></td></tr>
<tr class="separator:abd87021bd63f759d55642685a74874ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9929cb81f4fb49ffca8aa880a4699650"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="prom__collector_8h.html#a9929cb81f4fb49ffca8aa880a4699650">prom_collector_set_collect_fn</a> (<a class="el" href="prom__collector_8h.html#a28cf36f114f69a96508c044c44716f9c">prom_collector_t</a> *self, <a class="el" href="prom__collector_8h.html#af87330edd48cdb8e1074517e734b1e40">prom_collect_fn</a> *fn)</td></tr>
<tr class="memdesc:a9929cb81f4fb49ffca8aa880a4699650"><td class="mdescLeft"> </td><td class="mdescRight">The collect function is responsible for doing any work involving a set of metrics and then returning them for metric exposition. <a href="#a9929cb81f4fb49ffca8aa880a4699650">More...</a><br /></td></tr>
<tr class="separator:a9929cb81f4fb49ffca8aa880a4699650"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A Prometheus collector returns a collection of metrics. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="af87330edd48cdb8e1074517e734b1e40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af87330edd48cdb8e1074517e734b1e40">◆ </a></span>prom_collect_fn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef prom_map_t* prom_collect_fn(<a class="el" href="prom__collector_8h.html#a28cf36f114f69a96508c044c44716f9c">prom_collector_t</a> *self)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The function responsible for preparing metric data and returning metrics for a given collector. </p>
<p>If you use the default collector registry, this should not concern you. If you are using a custom collector, you may set this function on your collector to do additional work before returning the contained metrics.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>The target prom_collector_t* </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The prom_map_t* containing the collected metrics </dd></dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="abd87021bd63f759d55642685a74874ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd87021bd63f759d55642685a74874ee">◆ </a></span>prom_collector_add_metric()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int prom_collector_add_metric </td>
<td>(</td>
<td class="paramtype"><a class="el" href="prom__collector_8h.html#a28cf36f114f69a96508c044c44716f9c">prom_collector_t</a> * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="prom__metric_8h.html#afd1bd014c48955d6c2c36aa8a8cbb889">prom_metric_t</a> * </td>
<td class="paramname"><em>metric</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a metric to a collector. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>The target prom_collector_t* </td></tr>
<tr><td class="paramname">metric</td><td>the prom_metric_t* to add to the prom_collector_t* passed as self. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A non-zero integer value upon failure. </dd></dl>
</div>
</div>
<a id="a037b72b2edb81a477999a7dfc08758c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a037b72b2edb81a477999a7dfc08758c7">◆ </a></span>prom_collector_destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int prom_collector_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="prom__collector_8h.html#a28cf36f114f69a96508c044c44716f9c">prom_collector_t</a> * </td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy a collector. </p>
<p>You MUST set self to NULL after destruction. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>The target prom_collector_t* </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A non-zero integer value upon failure. </dd></dl>
</div>
</div>
<a id="a12c297cce0a30ee4149f2b486d9f0337"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12c297cce0a30ee4149f2b486d9f0337">◆ </a></span>prom_collector_destroy_generic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int prom_collector_destroy_generic </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>gen</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys a collector passed as a void pointer. </p>
<p>You MUST set self to NULL after destruction. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">gen</td><td>The target prom_collector_t* represented as a void* </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A non-zero integer value upon failure. </dd></dl>
</div>
</div>
<a id="a875b72940cd578ee76c71f1f4853f139"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a875b72940cd578ee76c71f1f4853f139">◆ </a></span>prom_collector_free_generic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void prom_collector_free_generic </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>gen</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees a collector passed as a void pointer. </p>
<p>You MUST set self to NULL after destruction. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">gen</td><td>The target prom_collector_t* represented as a void* </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4300cf33b6f8e4457df385c3d2a51a4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4300cf33b6f8e4457df385c3d2a51a4b">◆ </a></span>prom_collector_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="prom__collector_8h.html#a28cf36f114f69a96508c044c44716f9c">prom_collector_t</a>* prom_collector_new </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a collector. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the collector. The name MUST NOT be default or process. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The constructed prom_collector_t* </dd></dl>
</div>
</div>
<a id="af50746bb4af87eda617fa08237e3834e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af50746bb4af87eda617fa08237e3834e">◆ </a></span>prom_collector_process_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="prom__collector_8h.html#a28cf36f114f69a96508c044c44716f9c">prom_collector_t</a>* prom_collector_process_new </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>limits_path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>stat_path</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a prom_collector_t* which includes the default process metrics. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">limits_path</td><td>Pass NULL to discover the path to the /proc/[pid]/limits file associated with process ID assigned by the host environment. Otherwise, pass a string to said path. </td></tr>
<tr><td class="paramname">stat_path</td><td>Pass NULL to discover the path to the /proc/[pid]/stat file associated with process ID assigned by the host environment. Otherwise, pass a string to said path. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The constructed prom_collector_t* </dd></dl>
</div>
</div>
<a id="a9929cb81f4fb49ffca8aa880a4699650"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9929cb81f4fb49ffca8aa880a4699650">◆ </a></span>prom_collector_set_collect_fn()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int prom_collector_set_collect_fn </td>
<td>(</td>
<td class="paramtype"><a class="el" href="prom__collector_8h.html#a28cf36f114f69a96508c044c44716f9c">prom_collector_t</a> * </td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="prom__collector_8h.html#af87330edd48cdb8e1074517e734b1e40">prom_collect_fn</a> * </td>
<td class="paramname"><em>fn</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The collect function is responsible for doing any work involving a set of metrics and then returning them for metric exposition. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>The target prom_collector_t* </td></tr>
<tr><td class="paramname">fn</td><td>The prom_collect_fn* which will be responsible for handling any metric collection operations before returning the collected metrics for exposition. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A non-zero integer value upon failure. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>