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
|
#pragma once
#include <stdio.h>
#include <time.h>
#include "fieldstat.h"
#ifdef __cplusplus
extern "C"
{
#endif
/* -------------------------------------------------------------------------- */
/* fieldstat_json_exporter */
/* -------------------------------------------------------------------------- */
struct fieldstat_json_exporter;
struct fieldstat_json_exporter *fieldstat_json_exporter_new();
void fieldstat_json_exporter_set_global_tag(struct fieldstat_json_exporter *exporter, const struct field tag_list[], size_t n_field);
void fieldstat_json_exporter_set_name(struct fieldstat_json_exporter *exporter, const char *name);
void fieldstat_json_exporter_free(struct fieldstat_json_exporter *exporter);
/*
Output the fieldstat instance to json string array. User must free the output string.
format:
[
{
"name":"exporter_name",
"tags":[
{"device ID":123},
{"CLIENT IP":"123.1.1.1"}
],
"fields":[
{"in_bytes":1024},
{"in_pkts":123},
{"sessions":<hll blob base64-encoded string>}
]
"timestamp_ms":123456789
}.
{
"name":"exporter_name",
"tags":[
{"device ID":123},
{"CLIENT IP":"1.2.3.4"}
],
"fields":[
{"in_bytes":1},
{"in_pkts":2},
]
"timestamp_ms":123456789
}
]
*/
char *fieldstat_json_exporter_export(const struct fieldstat_json_exporter *exporter, const struct fieldstat *instance, const struct timeval *timestamp);
/*
after call fieldstat_json_exporter_export_array, user must free the output array and each string. output[0] =
"{"name":"exporter_name", "tags":[{"device ID":123}, {"CLIENT IP":"1.2.3.4"}],"fields":[{"in_bytes":1}, {"in_pkts":2},]"timestamp_ms":123456789}"
The same as every object in the array output by `fieldstat_json_exporter_export`.
*/
void fieldstat_json_exporter_export_array(const struct fieldstat_json_exporter *exporter, const struct fieldstat *instance, const struct timeval *timestamp, char ***output, size_t *output_size);
/*
the content is the same, but no nested format. flat format :
{
"name":"exporter_name",
"device ID":123,
"in_bytes":1,
"timestamp_ms":123456789
}
do not support fieldstat_json_exporter_enable_delta.
if a cell has no metric record, the cell will not be exported. (The same as fieldstat_json_exporter_export_array)
*/
void fieldstat_json_exporter_export_flat_array(const struct fieldstat_json_exporter *exporter, const struct fieldstat *instance, const struct timeval *timestamp, char ***output, size_t *output_size);
char *fieldstat_json_exporter_export_flat(const struct fieldstat_json_exporter *exporter, const struct fieldstat *instance, const struct timeval *timestamp);
/*
let json exporter output delta value by the side of the original value(accumulated). If a cell / metric is new, the delta value is the same as the original value.
Outputting delta value is disabled by default.
When the exporter name or exporter global tags are changed, or the fieldstat instance is reset, or one of the cube is deleted, the delta value will be reset. (next output will be the original value)
it is recommended to call this function after fieldstat_json_exporter_set_name and fieldstat_json_exporter_set_global_tag.
Only affects the metrics of counter type.
Outputting delta value is time-consuming.
*/
void fieldstat_json_exporter_enable_delta(struct fieldstat_json_exporter *exporter);
/*
let json exporter output delta value by the side of the original value(accumulated). Instead of let exporter record the delta value, user can provide the delta value by this function.
All the delta metrics are provided through argument `instance_delta`.
`instance` and `instance_delta` must has exactly the same configurations, including the metrics and cubes.
since this function is only used by fieldstat_easy, users are not expected to use this function directly. As a result, the configuration check is not implemented.
return NULL when instance has no cell records.
*/
char *fieldstat_json_exporter_export_with_delta(const struct fieldstat_json_exporter *exporter, const struct fieldstat *instance, const struct fieldstat *instance_delta, const struct timeval *timestamp, const struct timeval *timestamp_delta);
#ifdef __cplusplus
}
#endif
|
