Debian Codegraph @

src/shared/metrics.c

raw
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2
3 #include "json-util.h"
4 #include "log.h"
5 #include "metrics.h"
6 #include "string-table.h"
7 #include "varlink-io.systemd.Metrics.h"
8 #include "varlink-util.h"
9
10 int metrics_setup_varlink_server(
11 sd_varlink_server **server, /* in and out param */
12 sd_varlink_server_flags_t flags,
13 sd_event *event,
14 int64_t priority,
15 sd_varlink_method_t vl_method_list_cb,
16 sd_varlink_method_t vl_method_describe_cb,
17 void *userdata) {
18
19 _cleanup_(sd_varlink_server_unrefp) sd_varlink_server *s = NULL;
20 int r;
21
22 assert(server);
23 assert(event);
24 assert(vl_method_list_cb);
25 assert(vl_method_describe_cb);
26
27 if (*server)
28 return 0;
29
30 r = varlink_server_new(&s, flags, userdata);
31 if (r < 0)
32 return log_error_errno(r, "Failed to allocate Varlink server: %m");
33
34 r = sd_varlink_server_add_interface(s, &vl_interface_io_systemd_Metrics);
35 if (r < 0)
36 return log_debug_errno(r, "Failed to add varlink metrics interface to varlink server: %m");
37
38 r = sd_varlink_server_bind_method_many(
39 s,
40 "io.systemd.Metrics.List", vl_method_list_cb,
41 "io.systemd.Metrics.Describe", vl_method_describe_cb);
42 if (r < 0)
43 return log_debug_errno(r, "Failed to register varlink metrics methods: %m");
44
45 r = sd_varlink_server_set_description(s, "varlink-metrics");
46 if (r < 0)
47 return log_debug_errno(r, "Failed to set varlink metrics server description: %m");
48
49 r = sd_varlink_server_attach_event(s, event, priority);
50 if (r < 0)
51 return log_debug_errno(r, "Failed to attach varlink metrics server to event loop: %m");
52
53 *server = TAKE_PTR(s);
54 return 1;
55 }
56
57 static const char * const metric_family_type_table[_METRIC_FAMILY_TYPE_MAX] = {
58 [METRIC_FAMILY_TYPE_COUNTER] = "counter",
59 [METRIC_FAMILY_TYPE_GAUGE] = "gauge",
60 [METRIC_FAMILY_TYPE_STRING] = "string",
61 };
62
63 DEFINE_STRING_TABLE_LOOKUP_TO_STRING(metric_family_type, MetricFamilyType);
64
65 static int metric_family_build_json(const MetricFamily *mf, sd_json_variant **ret) {
66 assert(mf);
67
68 return sd_json_buildo(
69 ret,
70 SD_JSON_BUILD_PAIR_STRING("name", mf->name),
71 SD_JSON_BUILD_PAIR_STRING("description", mf->description),
72 SD_JSON_BUILD_PAIR_STRING("type", metric_family_type_to_string(mf->type)));
73 }
74
75 int metrics_method_describe(
76 const MetricFamily mfs[],
77 sd_varlink *link,
78 sd_json_variant *parameters,
79 sd_varlink_method_flags_t flags,
80 void *userdata) {
81 int r;
82
83 assert(mfs);
84 assert(link);
85 assert(parameters);
86 assert(FLAGS_SET(flags, SD_VARLINK_METHOD_MORE));
87
88 r = sd_varlink_dispatch(link, parameters, /* dispatch_table= */ NULL, /* userdata= */ NULL);
89 if (r != 0)
90 return r;
91
92 r = sd_varlink_set_sentinel(link, "io.systemd.Metrics.NoSuchMetric");
93 if (r < 0)
94 return r;
95
96 for (const MetricFamily *mf = mfs; mf->name; mf++) {
97 _cleanup_(sd_json_variant_unrefp) sd_json_variant *v = NULL;
98
99 r = metric_family_build_json(mf, &v);
100 if (r < 0)
101 return log_debug_errno(r, "Failed to describe metric family '%s': %m", mf->name);
102
103 r = sd_varlink_reply(link, v);
104 if (r < 0)
105 return log_debug_errno(r, "Failed to send varlink reply: %m");
106 }
107
108 return 0;
109 }
110
111 int metrics_method_list(
112 const MetricFamily mfs[],
113 sd_varlink *link,
114 sd_json_variant *parameters,
115 sd_varlink_method_flags_t flags,
116 void *userdata) {
117 int r;
118
119 assert(mfs);
120 assert(link);
121 assert(parameters);
122 assert(FLAGS_SET(flags, SD_VARLINK_METHOD_MORE));
123
124 r = sd_varlink_dispatch(link, parameters, /* dispatch_table= */ NULL, /* userdata= */ NULL);
125 if (r != 0)
126 return r;
127
128 r = sd_varlink_set_sentinel(link, "io.systemd.Metrics.NoSuchMetric");
129 if (r < 0)
130 return r;
131
132 for (const MetricFamily *mf = mfs; mf->name; mf++)
133 /* Metrics without .generate are handled by the preceding entry with .generate.
134 * Call the generating functions that are defined. */
135 if (mf->generate) {
136 r = mf->generate(mf, link, userdata);
137 if (r < 0)
138 return log_debug_errno(r, "Failed to list metrics for metric family '%s': %m", mf->name);
139 }
140
141 return 0;
142 }
143
144 static int metric_build_send(
145 const MetricFamily *mf,
146 sd_varlink *link,
147 const char *object,
148 sd_json_variant *value,
149 sd_json_variant *fields) {
150
151 assert(mf);
152 assert(link);
153 assert(value);
154
155 if (fields) {
156 assert(sd_json_variant_is_object(fields));
157
158 _unused_ const char *k;
159 _unused_ sd_json_variant *e;
160 JSON_VARIANT_OBJECT_FOREACH(k, e, fields)
161 assert(sd_json_variant_is_string(e));
162 }
163
164 return sd_varlink_replybo(
165 link,
166 SD_JSON_BUILD_PAIR_STRING("name", mf->name),
167 JSON_BUILD_PAIR_STRING_NON_EMPTY("object", object),
168 SD_JSON_BUILD_PAIR_VARIANT("value", value),
169 JSON_BUILD_PAIR_VARIANT_NON_NULL("fields", fields));
170 }
171
172 int metric_build_send_string(
173 const MetricFamily *mf,
174 sd_varlink *link,
175 const char *object,
176 const char *value,
177 sd_json_variant *fields) {
178
179 _cleanup_(sd_json_variant_unrefp) sd_json_variant *v = NULL;
180 int r;
181
182 assert(mf);
183 assert(link);
184 assert(value);
185
186 r = sd_json_variant_new_string(&v, value);
187 if (r < 0)
188 return log_debug_errno(r, "Failed to allocate JSON string: %m");
189
190 return metric_build_send(mf, link, object, v, fields);
191 }
192
193 int metric_build_send_unsigned(
194 const MetricFamily *mf,
195 sd_varlink *link,
196 const char *object,
197 uint64_t value,
198 sd_json_variant *fields) {
199
200 _cleanup_(sd_json_variant_unrefp) sd_json_variant *v = NULL;
201 int r;
202
203 assert(mf);
204 assert(link);
205
206 r = sd_json_variant_new_unsigned(&v, value);
207 if (r < 0)
208 return log_debug_errno(r, "Failed to allocate JSON unsigned: %m");
209
210 return metric_build_send(mf, link, object, v, fields);
211 }