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
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
|
/* $OpenBSD: ometric.c,v 1.2 2023/01/06 13:22:00 deraadt Exp $ */
/*
* Copyright (c) 2022 Claudio Jeker <claudio@openbsd.org>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#include <sys/queue.h>
#include <sys/time.h>
#include <err.h>
#include <stdarg.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "ometric.h"
struct olabel {
STAILQ_ENTRY(olabel) entry;
const char *key;
char *value;
};
struct olabels {
STAILQ_HEAD(, olabel) labels;
struct olabels *next;
int refcnt;
};
enum ovalue_type {
OVT_INTEGER,
OVT_DOUBLE,
OVT_TIMESPEC,
};
struct ovalue {
STAILQ_ENTRY(ovalue) entry;
struct olabels *labels;
union {
unsigned long long i;
double f;
struct timespec ts;
} value;
enum ovalue_type valtype;
};
STAILQ_HEAD(ovalues, ovalue);
struct ometric {
STAILQ_ENTRY(ometric) entry;
struct ovalues vals;
const char *name;
const char *help;
const char *const *stateset;
size_t setsize;
enum ometric_type type;
};
STAILQ_HEAD(, ometric) ometrics = STAILQ_HEAD_INITIALIZER(ometrics);
static const char *suffixes[] = { "_total", "_created", "_count",
"_sum", "_bucket", "_gcount", "_gsum", "_info",
};
/*
* Return true if name has one of the above suffixes.
*/
static int
strsuffix(const char *name)
{
const char *suffix;
size_t i;
suffix = strrchr(name, '_');
if (suffix == NULL)
return 0;
for (i = 0; i < sizeof(suffixes) / sizeof(suffixes[0]); i++) {
if (strcmp(suffix, suffixes[i]) == 0)
return 1;
}
return 0;
}
static void
ometric_check(const char *name)
{
struct ometric *om;
if (strsuffix(name))
errx(1, "reserved name suffix used: %s", name);
STAILQ_FOREACH(om, &ometrics, entry)
if (strcmp(name, om->name) == 0)
errx(1, "duplicate name: %s", name);
}
/*
* Allocate and return new ometric. The name and help string need to remain
* valid until the ometric is freed. Normally constant strings should be used.
*/
struct ometric *
ometric_new(enum ometric_type type, const char *name, const char *help)
{
struct ometric *om;
ometric_check(name);
if ((om = calloc(1, sizeof(*om))) == NULL)
err(1, NULL);
om->name = name;
om->help = help;
om->type = type;
STAILQ_INIT(&om->vals);
STAILQ_INSERT_TAIL(&ometrics, om, entry);
return om;
}
/*
* Same as above but for a stateset. The states is an array of constant strings
* with statecnt elements. The states, name and help pointers need to remain
* valid until the ometric is freed.
*/
struct ometric *
ometric_new_state(const char * const *states, size_t statecnt, const char *name,
const char *help)
{
struct ometric *om;
ometric_check(name);
if ((om = calloc(1, sizeof(*om))) == NULL)
err(1, NULL);
om->name = name;
om->help = help;
om->type = OMT_STATESET;
om->stateset = states;
om->setsize = statecnt;
STAILQ_INIT(&om->vals);
STAILQ_INSERT_TAIL(&ometrics, om, entry);
return om;
}
void
ometric_free_all(void)
{
struct ometric *om;
struct ovalue *ov;
while ((om = STAILQ_FIRST(&ometrics)) != NULL) {
STAILQ_REMOVE_HEAD(&ometrics, entry);
while ((ov = STAILQ_FIRST(&om->vals)) != NULL) {
STAILQ_REMOVE_HEAD(&om->vals, entry);
olabels_free(ov->labels);
free(ov);
}
free(om);
}
}
static struct olabels *
olabels_ref(struct olabels *ol)
{
struct olabels *x = ol;
while (x != NULL) {
x->refcnt++;
x = x->next;
}
return ol;
}
/*
* Create a new set of labels based on keys and values arrays.
* keys must end in a NULL element. values needs to hold as many elements
* but the elements can be NULL. values are copied for the olabel but
* keys needs to point to constant memory.
*/
struct olabels *
olabels_new(const char * const *keys, const char **values)
{
struct olabels *ol;
struct olabel *l;
if ((ol = malloc(sizeof(*ol))) == NULL)
err(1, NULL);
STAILQ_INIT(&ol->labels);
ol->refcnt = 1;
ol->next = NULL;
while (*keys != NULL) {
if (*values && **values != '\0') {
if ((l = malloc(sizeof(*l))) == NULL)
err(1, NULL);
l->key = *keys;
if ((l->value = strdup(*values)) == NULL)
err(1, NULL);
STAILQ_INSERT_TAIL(&ol->labels, l, entry);
}
keys++;
values++;
}
return ol;
}
/*
* Free olables once nothing uses them anymore.
*/
void
olabels_free(struct olabels *ol)
{
struct olabels *next;
struct olabel *l;
for ( ; ol != NULL; ol = next) {
next = ol->next;
if (--ol->refcnt == 0) {
while ((l = STAILQ_FIRST(&ol->labels)) != NULL) {
STAILQ_REMOVE_HEAD(&ol->labels, entry);
free(l->value);
free(l);
}
free(ol);
}
}
}
/*
* Add one extra label onto the label stack. Once no longer used the
* value needs to be freed with olabels_free().
*/
static struct olabels *
olabels_add_extras(struct olabels *ol, const char **keys, const char **values)
{
struct olabels *new;
new = olabels_new(keys, values);
new->next = olabels_ref(ol);
return new;
}
/*
* Output function called last.
*/
static const char *
ometric_type(enum ometric_type type)
{
switch (type) {
case OMT_GAUGE:
return "gauge";
case OMT_COUNTER:
return "counter";
case OMT_STATESET:
/* return "stateset"; node_exporter does not like this type */
return "gauge";
case OMT_HISTOGRAM:
return "histogram";
case OMT_SUMMARY:
return "summary";
case OMT_INFO:
/* return "info"; node_exporter does not like this type */
return "gauge";
default:
return "unknown";
}
}
static int
ometric_output_labels(FILE *out, const struct olabels *ol)
{
struct olabel *l;
const char *comma = "";
if (ol == NULL)
return fprintf(out, " ");
if (fprintf(out, "{") < 0)
return -1;
while (ol != NULL) {
STAILQ_FOREACH(l, &ol->labels, entry) {
if (fprintf(out, "%s%s=\"%s\"", comma, l->key,
l->value) < 0)
return -1;
comma = ",";
}
ol = ol->next;
}
return fprintf(out, "} ");
}
static int
ometric_output_value(FILE *out, const struct ovalue *ov)
{
switch (ov->valtype) {
case OVT_INTEGER:
return fprintf(out, "%llu", ov->value.i);
case OVT_DOUBLE:
return fprintf(out, "%g", ov->value.f);
case OVT_TIMESPEC:
return fprintf(out, "%lld.%09ld",
(long long)ov->value.ts.tv_sec, ov->value.ts.tv_nsec);
}
return -1;
}
static int
ometric_output_name(FILE *out, const struct ometric *om)
{
const char *suffix;
switch (om->type) {
case OMT_COUNTER:
suffix = "_total";
break;
case OMT_INFO:
suffix = "_info";
break;
default:
suffix = "";
break;
}
return fprintf(out, "%s%s", om->name, suffix);
}
/*
* Output all metric values with TYPE and optional HELP strings.
*/
int
ometric_output_all(FILE *out)
{
struct ometric *om;
struct ovalue *ov;
STAILQ_FOREACH(om, &ometrics, entry) {
if (om->help)
if (fprintf(out, "# HELP %s %s\n", om->name,
om->help) < 0)
return -1;
if (fprintf(out, "# TYPE %s %s\n", om->name,
ometric_type(om->type)) < 0)
return -1;
STAILQ_FOREACH(ov, &om->vals, entry) {
if (ometric_output_name(out, om) < 0)
return -1;
if (ometric_output_labels(out, ov->labels) < 0)
return -1;
if (ometric_output_value(out, ov) < 0)
return -1;
if (fprintf(out, "\n") < 0)
return -1;
}
}
if (fprintf(out, "# EOF\n") < 0)
return -1;
return 0;
}
/*
* Value setters
*/
static void
ometric_set_int_value(struct ometric *om, uint64_t val, struct olabels *ol)
{
struct ovalue *ov;
if ((ov = malloc(sizeof(*ov))) == NULL)
err(1, NULL);
ov->value.i = val;
ov->valtype = OVT_INTEGER;
ov->labels = olabels_ref(ol);
STAILQ_INSERT_TAIL(&om->vals, ov, entry);
}
/*
* Set an integer value with label ol. ol can be NULL.
*/
void
ometric_set_int(struct ometric *om, uint64_t val, struct olabels *ol)
{
if (om->type != OMT_COUNTER && om->type != OMT_GAUGE)
errx(1, "%s incorrect ometric type", __func__);
ometric_set_int_value(om, val, ol);
}
/*
* Set a floating point value with label ol. ol can be NULL.
*/
void
ometric_set_float(struct ometric *om, double val, struct olabels *ol)
{
struct ovalue *ov;
if (om->type != OMT_COUNTER && om->type != OMT_GAUGE)
errx(1, "%s incorrect ometric type", __func__);
if ((ov = malloc(sizeof(*ov))) == NULL)
err(1, NULL);
ov->value.f = val;
ov->valtype = OVT_DOUBLE;
ov->labels = olabels_ref(ol);
STAILQ_INSERT_TAIL(&om->vals, ov, entry);
}
/*
* Set an timespec value with label ol. ol can be NULL.
*/
void
ometric_set_timespec(struct ometric *om, const struct timespec *ts,
struct olabels *ol)
{
struct ovalue *ov;
if (om->type != OMT_GAUGE)
errx(1, "%s incorrect ometric type", __func__);
if ((ov = malloc(sizeof(*ov))) == NULL)
err(1, NULL);
ov->value.ts = *ts;
ov->valtype = OVT_TIMESPEC;
ov->labels = olabels_ref(ol);
STAILQ_INSERT_TAIL(&om->vals, ov, entry);
}
/*
* Add an info value (which is the value 1 but with extra key-value pairs).
*/
void
ometric_set_info(struct ometric *om, const char **keys, const char **values,
struct olabels *ol)
{
struct olabels *extra = NULL;
if (om->type != OMT_INFO)
errx(1, "%s incorrect ometric type", __func__);
if (keys != NULL)
extra = olabels_add_extras(ol, keys, values);
ometric_set_int_value(om, 1, extra != NULL ? extra : ol);
olabels_free(extra);
}
/*
* Set a stateset to one of its states.
*/
void
ometric_set_state(struct ometric *om, const char *state, struct olabels *ol)
{
struct olabels *extra;
size_t i;
int val;
if (om->type != OMT_STATESET)
errx(1, "%s incorrect ometric type", __func__);
for (i = 0; i < om->setsize; i++) {
if (strcasecmp(state, om->stateset[i]) == 0)
val = 1;
else
val = 0;
extra = olabels_add_extras(ol, OKV(om->name),
OKV(om->stateset[i]));
ometric_set_int_value(om, val, extra);
olabels_free(extra);
}
}
/*
* Set a value with an extra label, the key should be a constant string while
* the value is copied into the extra label.
*/
void
ometric_set_int_with_labels(struct ometric *om, uint64_t val,
const char **keys, const char **values, struct olabels *ol)
{
struct olabels *extra;
extra = olabels_add_extras(ol, keys, values);
ometric_set_int(om, val, extra);
olabels_free(extra);
}
void
ometric_set_timespec_with_labels(struct ometric *om, struct timespec *ts,
const char **keys, const char **values, struct olabels *ol)
{
struct olabels *extra;
extra = olabels_add_extras(ol, keys, values);
ometric_set_timespec(om, ts, extra);
olabels_free(extra);
}
|