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
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
|
/*
** Zabbix
** Copyright (C) 2001-2019 Zabbix SIA
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**/
#include "common.h"
#include "zbxalgo.h"
#include "zbxregexp.h"
#include "log.h"
#include "zbxjson.h"
/* Defines maximum row length to be written in error message in the case of parsing failure */
#define ZBX_PROMEHTEUS_ERROR_MAX_ROW_LENGTH 50
#define ZBX_PROMETHEUS_HINT_HELP 0
#define ZBX_PROMETHEUS_HINT_TYPE 1
#define ZBX_PROMETHEUS_TYPE_UNTYPED "untyped"
typedef enum
{
ZBX_PROMETHEUS_CONDITION_OP_EQUAL,
ZBX_PROMETHEUS_CONDITION_OP_REGEX,
ZBX_PROMETHEUS_CONDITION_OP_EQUAL_VALUE,
}
zbx_prometheus_condition_op_t;
/* key-value matching data */
typedef struct
{
/* the key to match, optional - can be NULL */
char *key;
/* the pattern to match */
char *pattern;
/* the condition operations */
zbx_prometheus_condition_op_t op;
}
zbx_prometheus_condition_t;
/* the prometheus pattern filter */
typedef struct
{
/* metric filter, optional - can be NULL */
zbx_prometheus_condition_t *metric;
/* value filter, optional - can be NULL */
zbx_prometheus_condition_t *value;
/* label filters */
zbx_vector_ptr_t labels;
}
zbx_prometheus_filter_t;
/* the prometheus label */
typedef struct
{
char *name;
char *value;
}
zbx_prometheus_label_t;
/* the prometheus data row */
typedef struct
{
char *metric;
char *value;
zbx_vector_ptr_t labels;
char *raw;
}
zbx_prometheus_row_t;
/* the prometheus metric HELP, TYPE hints in comments */
typedef struct
{
char *metric;
char *type;
char *help;
}
zbx_prometheus_hint_t;
/* TYPE, HELP hint hashset support */
static zbx_hash_t prometheus_hint_hash(const void *d)
{
const zbx_prometheus_hint_t *hint = (zbx_prometheus_hint_t *)d;
return ZBX_DEFAULT_STRING_HASH_FUNC(hint->metric);
}
static int prometheus_hint_compare(const void *d1, const void *d2)
{
const zbx_prometheus_hint_t *hint1 = (zbx_prometheus_hint_t *)d1;
const zbx_prometheus_hint_t *hint2 = (zbx_prometheus_hint_t *)d2;
return strcmp(hint1->metric, hint2->metric);
}
/******************************************************************************
* *
* Function: str_loc_dup *
* *
* Purpose: allocates and copies substring at the specified location *
* *
* Parameters: src - [IN] the source string *
* loc - [IN] the substring location *
* *
* Return value: The copied substring. *
* *
******************************************************************************/
static char *str_loc_dup(const char *src, const zbx_strloc_t *loc)
{
char *str;
size_t len;
len = loc->r - loc->l + 1;
str = zbx_malloc(NULL, len + 1);
memcpy(str, src + loc->l, len);
str[len] = '\0';
return str;
}
/******************************************************************************
* *
* Function: str_loc_unquote_dyn *
* *
* Purpose: unquotes substring at the specified location *
* *
* Parameters: src - [IN] the source string *
* loc - [IN] the substring location *
* *
* Return value: The unquoted and copied substring. *
* *
******************************************************************************/
static char *str_loc_unquote_dyn(const char *src, const zbx_strloc_t *loc)
{
char *str, *ptr;
src += loc->l + 1;
str = ptr = zbx_malloc(NULL, loc->r - loc->l);
while ('"' != *src)
{
if ('\\' == *src)
{
switch (*(++src))
{
case '\\':
*ptr++ = '\\';
break;
case 'n':
*ptr++ = '\n';
break;
case '"':
*ptr++ = '"';
break;
}
}
else
*ptr++ = *src;
src++;
}
*ptr = '\0';
return str;
}
/******************************************************************************
* *
* Function: str_loc_op *
* *
* Purpose: parses condition operation at the specified location *
* *
* Parameters: src - [IN] the source string *
* loc - [IN] the substring location *
* *
* Return value: The condition operation. *
* *
******************************************************************************/
static zbx_prometheus_condition_op_t str_loc_op(const char *data, const zbx_strloc_t *loc)
{
/* the operation has been already validated during parsing, */
/*so there are only three possibilities: */
/* '=' - the only sinle character operation */
/* '==' - ends with '=' */
/* '=~' - ends with '~' */
if (loc->l == loc->r)
return ZBX_PROMETHEUS_CONDITION_OP_EQUAL;
if ('~' == data[loc->r])
return ZBX_PROMETHEUS_CONDITION_OP_REGEX;
return ZBX_PROMETHEUS_CONDITION_OP_EQUAL_VALUE;
}
/******************************************************************************
* *
* Function: skip_spaces *
* *
* Purpose: skips spaces *
* *
* Parameters: src - [IN] the source string *
* pos - [IN] the starting position *
* *
* Return value: The position of the next non space character. *
* *
******************************************************************************/
static size_t skip_spaces(const char *data, size_t pos)
{
while (' ' == data[pos] || '\t' == data[pos])
pos++;
return pos;
}
/******************************************************************************
* *
* Function: skip_row *
* *
* Purpose: skips until beginning of the next row *
* *
* Parameters: src - [IN] the source string *
* pos - [IN] the starting position *
* *
* Return value: The position of the next row space character. *
* *
******************************************************************************/
static size_t skip_row(const char *data, size_t pos)
{
const char *ptr;
if (NULL == (ptr = strchr(data + pos, '\n')))
return strlen(data + pos) + pos;
return ptr - data + 1;
}
/******************************************************************************
* *
* Function: parse_metric *
* *
* Purpose: parses metric name *
* *
* Parameters: data - [IN] the source string *
* pos - [IN] the starting position *
* loc - [OUT] the metric location in the source string *
* *
* Return value: SUCCEED - the metric name was parsed out successfully *
* FAIL - otherwise *
* *
******************************************************************************/
static int parse_metric(const char *data, size_t pos, zbx_strloc_t *loc)
{
const char *ptr = data + pos;
if (0 == isalpha(*ptr) && ':' != *ptr && '_' != *ptr)
return FAIL;
while ('\0' != *(++ptr))
{
if (0 == isalnum(*ptr) && ':' != *ptr && '_' != *ptr)
break;
}
loc->l = pos;
loc->r = ptr - data - 1;
return SUCCEED;
}
/******************************************************************************
* *
* Function: parse_label *
* *
* Purpose: parses label name *
* *
* Parameters: data - [IN] the source string *
* pos - [IN] the starting position *
* loc - [OUT] the label location in the source string *
* *
* Return value: SUCCEED - the label name was parsed out successfully *
* FAIL - otherwise *
* *
******************************************************************************/
static int parse_label(const char *data, size_t pos, zbx_strloc_t *loc)
{
const char *ptr = data + pos;
if (0 == isalpha(*ptr) && '_' != *ptr)
return FAIL;
while ('\0' != *(++ptr))
{
if (0 == isalnum(*ptr) && '_' != *ptr)
break;
}
loc->l = pos;
loc->r = ptr - data - 1;
return SUCCEED;
}
/******************************************************************************
* *
* Function: parse_label_op *
* *
* Purpose: parses label operation *
* *
* Parameters: data - [IN] the source string *
* pos - [IN] the starting position *
* loc - [OUT] the operation location in the source string *
* *
* Return value: SUCCEED - the label operation was parsed out successfully *
* FAIL - otherwise *
* *
******************************************************************************/
static int parse_label_op(const char *data, size_t pos, zbx_strloc_t *loc)
{
const char *ptr = data + pos;
if ('=' != *ptr)
return FAIL;
loc->l = loc->r = pos;
if ('~' == ptr[1])
loc->r++;
return SUCCEED;
}
/******************************************************************************
* *
* Function: parse_label_value *
* *
* Purpose: parses label value *
* *
* Parameters: data - [IN] the source string *
* pos - [IN] the starting position *
* loc - [OUT] the value location in the source string *
* *
* Return value: SUCCEED - the label value was parsed out successfully *
* FAIL - otherwise *
* *
******************************************************************************/
static int parse_label_value(const char *data, size_t pos, zbx_strloc_t *loc)
{
const char *ptr;
ptr = data + pos;
if ('"' != *ptr)
return FAIL;
loc->l = pos;
while ('"' != *(++ptr))
{
if ('\\' == *ptr)
ptr++;
if ('\0' == *ptr)
return FAIL;
}
loc->r = ptr - data;
return SUCCEED;
}
/******************************************************************************
* *
* Function: parse_metric_op *
* *
* Purpose: parses metric operation *
* *
* Parameters: data - [IN] the source string *
* pos - [IN] the starting position *
* loc - [OUT] the operation location in the source string *
* *
* Return value: SUCCEED - the metric operation was parsed out successfully *
* FAIL - otherwise *
* *
******************************************************************************/
static int parse_metric_op(const char *data, size_t pos, zbx_strloc_t *loc)
{
const char *ptr = data + pos;
if ('=' != *ptr)
return FAIL;
if ('=' != ptr[1])
return FAIL;
loc->l = pos;
loc->r = pos + 1;
return SUCCEED;
}
/******************************************************************************
* *
* Function: parse_metric_value *
* *
* Purpose: parses metric value *
* *
* Parameters: data - [IN] the source string *
* pos - [IN] the starting position *
* loc - [OUT] the value location in the source string *
* *
* Return value: SUCCEED - the metric value was parsed out successfully *
* FAIL - otherwise *
* *
******************************************************************************/
static int parse_metric_value(const char *data, size_t pos, zbx_strloc_t *loc)
{
const char *ptr = data + pos;
int digit = 0;
if ('\0' == *ptr || '\n' == *ptr)
return FAIL;
loc->l = pos;
if (0 == strncmp(ptr, "Nan", 3))
{
loc->r = pos + 2;
return SUCCEED;
}
if ('-' == *ptr || '+' == *ptr)
ptr++;
if (0 == strncmp(ptr, "Inf", 3))
{
loc->r = ptr - data + 2;
return SUCCEED;
}
while (0 != isdigit(*ptr))
{
digit = 1;
ptr++;
}
if ('.' == *ptr)
ptr++;
while (0 != isdigit(*ptr))
{
digit = 1;
ptr++;
}
if (0 == digit)
return FAIL;
if ('e' == *ptr || 'E' == *ptr)
{
ptr++;
if ('-' == *ptr || '+' == *ptr)
ptr++;
if (0 == isdigit(*ptr))
return FAIL;
while (0 != isdigit(*ptr))
ptr++;
}
loc->r = ptr - data - 1;
return SUCCEED;
}
/******************************************************************************
* *
* Function: prometheus_condition_free *
* *
******************************************************************************/
static void prometheus_condition_free(zbx_prometheus_condition_t *condition)
{
zbx_free(condition->key);
zbx_free(condition->pattern);
zbx_free(condition);
}
/******************************************************************************
* *
* Function: prometheus_condition_create *
* *
* Purpose: allocates and initializes conditionect *
* *
* Parameters: key - [IN] the key to match *
* pattern - [IN] the matching pattern *
* op - [IN] the matching operation *
* *
* Return value: the created condition object *
* *
******************************************************************************/
static zbx_prometheus_condition_t *prometheus_condition_create(char *key, char *pattern,
zbx_prometheus_condition_op_t op)
{
zbx_prometheus_condition_t *condition;
condition = (zbx_prometheus_condition_t *)zbx_malloc(NULL, sizeof(zbx_prometheus_condition_t));
condition->key = key;
condition->pattern = pattern;
condition->op = op;
return condition;
}
/******************************************************************************
* *
* Function: prometheus_filter_clear *
* *
* Purpose: clears resources allocated by prometheus filter *
* *
* Parameters: filter - [IN] the filter to clear *
* *
******************************************************************************/
static void prometheus_filter_clear(zbx_prometheus_filter_t *filter)
{
if (NULL != filter->metric)
prometheus_condition_free(filter->metric);
if (NULL != filter->value)
prometheus_condition_free(filter->value);
zbx_vector_ptr_clear_ext(&filter->labels, (zbx_clean_func_t)prometheus_condition_free);
zbx_vector_ptr_destroy(&filter->labels);
}
/******************************************************************************
* *
* Function: parse_condition *
* *
* Purpose: parses condition data - key, pattern and operation *
* *
* Parameters: data - [IN] the filter data *
* pos - [IN] the starting position in filter data *
* loc_key - [IN] the condition key location *
* loc_op - [IN] the condition operation location *
* loc_pattern - [IN] the condition pattern location *
* *
* Return value: SUCCEED - the condition data was parsed successfully *
* FAIL - otherwise *
* *
******************************************************************************/
static int parse_condition(const char *data, size_t pos, zbx_strloc_t *loc_key, zbx_strloc_t *loc_op,
zbx_strloc_t *loc_pattern)
{
if (SUCCEED != parse_label(data, pos, loc_key))
return FAIL;
pos = skip_spaces(data, loc_key->r + 1);
if (SUCCEED != parse_label_op(data, pos, loc_op))
return FAIL;
pos = skip_spaces(data, loc_op->r + 1);
if (SUCCEED != parse_label_value(data, pos, loc_pattern))
return FAIL;
return SUCCEED;
}
/******************************************************************************
* *
* Function: prometheus_filter_parse_labels *
* *
* Purpose: parses label conditions *
* *
* Parameters: filter - [IN/OUT] the filter *
* data - [IN] the filter data *
* pos - [IN] the starting position in filter data *
* loc - [IN] the location of label conditions *
* error - [IN] the error message *
* *
* Return value: SUCCEED - the label conditions were parsed successfully *
* FAIL - otherwise *
* *
******************************************************************************/
static int prometheus_filter_parse_labels(zbx_prometheus_filter_t *filter, const char *data, size_t pos,
zbx_strloc_t *loc, char **error)
{
zbx_strloc_t loc_key, loc_value, loc_op;
loc->l = pos;
pos = skip_spaces(data, pos + 1);
if ('}' != data[pos])
{
while (1)
{
zbx_prometheus_condition_op_t op;
if (FAIL == parse_condition(data, pos, &loc_key, &loc_op, &loc_value))
{
*error = zbx_dsprintf(*error, "cannot parse label condition at \"%s\"", data + pos);
return FAIL;
}
op = str_loc_op(data, &loc_op);
if (0 == strncmp(data + loc_key.l, "__name__", loc_key.r - loc_key.l + 1))
{
if (NULL != filter->metric)
{
*error = zbx_strdup(*error, "duplicate metric condition specified");
return FAIL;
}
filter->metric = prometheus_condition_create(NULL,
str_loc_unquote_dyn(data, &loc_value), op);
}
else
{
zbx_prometheus_condition_t *condition;
condition = prometheus_condition_create(str_loc_dup(data, &loc_key),
str_loc_unquote_dyn(data, &loc_value), op);
zbx_vector_ptr_append(&filter->labels, condition);
}
pos = skip_spaces(data, loc_value.r + 1);
if (',' != data[pos])
{
if ('}' == data[pos])
break;
*error = zbx_strdup(*error, "missing label condition list terminating character \"}\"");
return FAIL;
}
pos = skip_spaces(data, pos + 1);
}
}
loc->r = pos;
return SUCCEED;
}
/******************************************************************************
* *
* Function: prometheus_filter_init *
* *
* Purpose: intializes prometheus pattern filter from the specified data *
* *
* Parameters: filter - [IN/OUT] the filter *
* data - [IN] the filter data *
* error - [IN] the error message *
* *
* Return value: SUCCEED - the filter was initialized successfully *
* FAIL - otherwise *
* *
******************************************************************************/
static int prometheus_filter_init(zbx_prometheus_filter_t *filter, const char *data, char **error)
{
int ret = FAIL;
size_t pos = 0;
zbx_strloc_t loc;
memset(filter, 0, sizeof(zbx_prometheus_filter_t));
zbx_vector_ptr_create(&filter->labels);
if (SUCCEED == parse_metric(data, pos, &loc))
{
filter->metric = prometheus_condition_create(NULL, str_loc_dup(data, &loc),
ZBX_PROMETHEUS_CONDITION_OP_EQUAL);
pos = skip_spaces(data, loc.r + 1);
}
if ('{' == data[pos])
{
if (SUCCEED != prometheus_filter_parse_labels(filter, data, pos, &loc, error))
goto out;
pos = loc.r + 1;
}
pos = skip_spaces(data, pos);
/* parse metric value condition */
if ('\0' != data[pos])
{
zbx_strloc_t loc_op, loc_value;
zbx_prometheus_condition_op_t op;
if (SUCCEED != parse_metric_op(data, pos, &loc_op))
{
*error = zbx_dsprintf(*error, "cannot parse metric comparison operator at \"%s\"", data + pos);
goto out;
}
op = str_loc_op(data, &loc_op);
pos = skip_spaces(data, loc_op.r + 1);
if (SUCCEED != parse_metric_value(data, pos, &loc_value))
{
*error = zbx_dsprintf(*error, "cannot parse metric comparison value at \"%s\"", data + pos);
goto out;
}
pos = skip_spaces(data, loc_value.r + 1);
if ('\0' != data[pos])
{
*error = zbx_dsprintf(*error, "unexpected data after metric comparison value at \"%s\"",
data + pos);
goto out;
}
filter->value = prometheus_condition_create(NULL, str_loc_dup(data, &loc_value), op);
}
ret = SUCCEED;
out:
if (FAIL == ret)
prometheus_filter_clear(filter);
return ret;
}
/******************************************************************************
* *
* Function: prometheus_label_free *
* *
******************************************************************************/
static void prometheus_label_free(zbx_prometheus_label_t *label)
{
zbx_free(label->name);
zbx_free(label->value);
zbx_free(label);
}
/******************************************************************************
* *
* Function: prometheus_row_free *
* *
******************************************************************************/
static void prometheus_row_free(zbx_prometheus_row_t *row)
{
zbx_free(row->metric);
zbx_free(row->value);
zbx_free(row->raw);
zbx_vector_ptr_clear_ext(&row->labels, (zbx_clean_func_t)prometheus_label_free);
zbx_vector_ptr_destroy(&row->labels);
zbx_free(row);
}
/******************************************************************************
* *
* Function: condition_match_key_value *
* *
* Purpose: matches key,value against filter condition *
* *
* Parameters: condition - [IN] the condition *
* key - [IN] the key (optional, can be NULL) *
* value - [IN] the value *
* *
* Return value: SUCCEED - the key,value pair matches condition *
* FAIL - otherwise *
* *
******************************************************************************/
static int condition_match_key_value(const zbx_prometheus_condition_t *condition, const char *key,
const char *value)
{
/* perform key match, succeeds if key is not defined in filter */
if (NULL != condition->key && (NULL == key || 0 != strcmp(key, condition->key)))
return FAIL;
/* match value */
switch (condition->op)
{
case ZBX_PROMETHEUS_CONDITION_OP_EQUAL:
case ZBX_PROMETHEUS_CONDITION_OP_EQUAL_VALUE:
if (0 != strcmp(value, condition->pattern))
return FAIL;
break;
case ZBX_PROMETHEUS_CONDITION_OP_REGEX:
if (NULL == zbx_regexp_match(value, condition->pattern, NULL))
return FAIL;
break;
default:
return FAIL;
}
return SUCCEED;
}
/******************************************************************************
* *
* Function: prometheus_metric_parse_labels *
* *
* Purpose: parses metric labels *
* *
* Parameters: data - [IN] the metric data *
* pos - [IN] the starting position in metric data *
* labels - [OUT] the parsed labels *
* loc - [OUT] the location of label block *
* error - [OUT] the error message *
* *
* Return value: SUCCEED - the labels were parsed successfully *
* FAIL - otherwise *
* *
******************************************************************************/
static int prometheus_metric_parse_labels(const char *data, size_t pos, zbx_vector_ptr_t *labels,
zbx_strloc_t *loc, char **error)
{
zbx_strloc_t loc_key, loc_value, loc_op;
zbx_prometheus_label_t *label;
pos = skip_spaces(data, pos + 1);
loc->l = pos;
while ('}' != data[pos])
{
zbx_prometheus_condition_op_t op;
if (FAIL == parse_condition(data, pos, &loc_key, &loc_op, &loc_value))
{
*error = zbx_strdup(*error, "cannot parse label");
return FAIL;
}
op = str_loc_op(data, &loc_op);
if (ZBX_PROMETHEUS_CONDITION_OP_EQUAL != op)
{
*error = zbx_strdup(*error, "invalid label assignment operator");
return FAIL;
}
label = (zbx_prometheus_label_t *)zbx_malloc(NULL, sizeof(zbx_prometheus_label_t));
label->name = str_loc_dup(data, &loc_key);
label->value = str_loc_unquote_dyn(data, &loc_value);
zbx_vector_ptr_append(labels, label);
pos = skip_spaces(data, loc_value.r + 1);
if (',' == data[pos])
{
pos = skip_spaces(data, pos + 1);
continue;
}
if ('\0' == data[pos])
{
*error = zbx_strdup(*error, "missing label list terminating character \"}\"");
return FAIL;
}
}
loc->r = pos;
return SUCCEED;
}
/******************************************************************************
* *
* Function: prometheus_parse_row *
* *
* Purpose: parses metric row *
* *
* Parameters: filter - [IN] the prometheus filter *
* data - [IN] the metric data *
* pos - [IN] the starting position in metric data *
* prow - [OUT] the parsed row (NULL if did not match filter) *
* loc_row - [OUT] the location of row in prometheus data *
* error - [OUT] the error message *
* *
* Return value: SUCCEED - the row was parsed successfully *
* FAIL - otherwise *
* *
* Comments: If there was no parsing errors, but the row does not match filter*
* conditions then success with NULL prow is be returned. *
* *
******************************************************************************/
static int prometheus_parse_row(zbx_prometheus_filter_t *filter, const char *data, size_t pos,
zbx_prometheus_row_t **prow, zbx_strloc_t *loc_row, char **error)
{
zbx_strloc_t loc;
zbx_prometheus_row_t *row;
int ret = FAIL, match = SUCCEED, i, j;
loc_row->l = pos;
row = (zbx_prometheus_row_t *)zbx_malloc(NULL, sizeof(zbx_prometheus_row_t));
memset(row, 0, sizeof(zbx_prometheus_row_t));
zbx_vector_ptr_create(&row->labels);
/* parse metric and check against the filter */
if (SUCCEED != parse_metric(data, pos, &loc))
{
*error = zbx_strdup(*error, "cannot parse metric name");
goto out;
}
row->metric = str_loc_dup(data, &loc);
if (NULL != filter->metric)
{
if (FAIL == (match = condition_match_key_value(filter->metric, NULL, row->metric)))
goto out;
}
/* parse labels and check against the filter */
pos = skip_spaces(data, loc.r + 1);
if ('{' == data[pos])
{
if (SUCCEED != prometheus_metric_parse_labels(data, pos, &row->labels, &loc, error))
goto out;
for (i = 0; i < filter->labels.values_num; i++)
{
zbx_prometheus_condition_t *condition = filter->labels.values[i];
for (j = 0; j < row->labels.values_num; j++)
{
zbx_prometheus_label_t *label = row->labels.values[j];
if (SUCCEED == condition_match_key_value(condition, label->name, label->value))
break;
}
if (j == row->labels.values_num)
{
/* no matching labels */
match = FAIL;
goto out;
}
}
pos = loc.r + 1;
}
/* parse value and check against the filter */
pos = skip_spaces(data, pos);
if (FAIL == parse_metric_value(data, pos, &loc))
{
*error = zbx_strdup(*error, "cannot parse metric value");
goto out;
}
row->value = str_loc_dup(data, &loc);
if (NULL != filter->value)
{
if (SUCCEED != (match = condition_match_key_value(filter->value, NULL, row->value)))
goto out;
}
/* row was successfully parsed and matched all filter conditions */
pos = loc.r + 1;
ret = SUCCEED;
out:
if (FAIL == ret)
{
prometheus_row_free(row);
*prow = NULL;
/* match failure, return success with NULL row */
if (FAIL == match)
ret = SUCCEED;
}
else
*prow = row;
if (SUCCEED == ret)
{
/* find the row location */
pos = skip_row(data, loc.r + 1);
if ('\0' == data[pos])
loc_row->r = pos - 1;
else
loc_row->r = pos - 2;
}
return ret;
}
/******************************************************************************
* *
* Function: parse_help *
* *
* Purpose: parses HELP comment metric and help text *
* *
* Parameters: data - [IN] the prometheus data *
* pos - [IN] the starting position in metric data *
* loc_metric - [OUT] the metric location in data *
* loc_help - [OUT] the help location in data *
* *
* Return value: SUCCEED - the help hint was parsed successfully *
* FAIL - otherwise *
* *
******************************************************************************/
static int parse_help(const char *data, size_t pos, zbx_strloc_t *loc_metric, zbx_strloc_t *loc_help)
{
const char *ptr;
if (SUCCEED != parse_metric(data, pos, loc_metric))
return FAIL;
pos = skip_spaces(data, loc_metric->r + 1);
loc_help->l = pos;
if (NULL == (ptr = strchr(data + pos, '\n')))
loc_help->r = strlen(data + pos) + pos - 1;
else
loc_help->r = ptr - data - 1;
return SUCCEED;
}
/******************************************************************************
* *
* Function: parse_type *
* *
* Purpose: parses TYPE comment metric and the type *
* *
* Parameters: data - [IN] the prometheus data *
* pos - [IN] the starting position in metric data *
* loc_metric - [OUT] the metric location in data *
* loc_type - [OUT] the type location in data *
* *
* Return value: SUCCEED - the type hint was parsed successfully *
* FAIL - otherwise *
* *
******************************************************************************/
static int parse_type(const char *data, size_t pos, zbx_strloc_t *loc_metric, zbx_strloc_t *loc_type)
{
const char *ptr;
if (SUCCEED != parse_metric(data, pos, loc_metric))
return FAIL;
pos = skip_spaces(data, loc_metric->r + 1);
loc_type->l = pos;
ptr = data + pos;
while (0 != isalpha(*ptr))
ptr++;
/* invalid metric type */
if (pos == (loc_type->r = ptr - data))
return FAIL;
loc_type->r--;
return SUCCEED;
}
/******************************************************************************
* *
* Function: prometheus_register_hint *
* *
* Purpose: registers TYPE/HELP comment hint to the specified metric *
* *
* Parameters: hints - [IN/OUT] the hint registry *
* data - [IN] the prometheus data *
* metric - [IN] the metric *
* loc_hint - [IN] the hint location in prometheus data *
* hint_type - [IN] the hint type *
* error - [OUT] the error message *
* *
* Return value: SUCCEED - the hint was registered successfully *
* FAIL - otherwise *
* *
******************************************************************************/
static int prometheus_register_hint(zbx_hashset_t *hints, const char *data, char *metric, zbx_strloc_t *loc_hint,
int hint_type, char **error)
{
zbx_prometheus_hint_t *hint, hint_local;
hint_local.metric = metric;
if (NULL == (hint = (zbx_prometheus_hint_t *)zbx_hashset_search(hints, &hint_local)))
{
hint = zbx_hashset_insert(hints, &hint_local, sizeof(hint_local));
hint->type = NULL;
hint->help = NULL;
}
else
zbx_free(metric);
if (ZBX_PROMETHEUS_HINT_HELP == hint_type)
{
if (NULL != hint->help)
{
*error = zbx_dsprintf(*error, "multiple HELP comments found for metric \"%s\"", hint->metric);
return FAIL;
}
hint->help = str_loc_dup(data, loc_hint);
}
else /* ZBX_PROMETHEUS_HINT_TYPE */
{
if (NULL != hint->type)
{
*error = zbx_dsprintf(*error, "multiple TYPE comments found for metric \"%s\"", hint->metric);
return FAIL;
}
hint->type = str_loc_dup(data, loc_hint);
}
return SUCCEED;
}
/******************************************************************************
* *
* Function: prometheus_parse_hint *
* *
* Purpose: parses TYPE/HELP comment hint and registers it *
* *
* Parameters: filter - [IN] the prometheus filter *
* data - [IN] the prometheus data *
* pso - [IN] the position of comments in prometheus data *
* hints - [IN/OUT] the hint registry *
* error - [OUT] the error message *
* *
* Return value: SUCCEED - the hint was registered successfully *
* FAIL - otherwise *
* *
******************************************************************************/
static int prometheus_parse_hint(zbx_prometheus_filter_t *filter, const char *data, size_t pos,
zbx_hashset_t *hints, zbx_strloc_t *loc, char **error)
{
int ret, hint_type;
zbx_strloc_t loc_metric, loc_hint;
char *metric;
loc->l = pos;
pos = skip_spaces(data, pos + 1);
if (0 == strncmp(data + pos, "HELP", 4))
{
pos = skip_spaces(data, pos + 4);
ret = parse_help(data, pos, &loc_metric, &loc_hint);
hint_type = ZBX_PROMETHEUS_HINT_HELP;
}
else if (0 == strncmp(data + pos, "TYPE", 4))
{
pos = skip_spaces(data, pos + 4);
ret = parse_type(data, pos, &loc_metric, &loc_hint);
hint_type = ZBX_PROMETHEUS_HINT_TYPE;
}
else
{
/* skip the comment */
const char *ptr;
ptr = strchr(data + pos, '\n');
loc->r = ptr - data - 1;
return SUCCEED;
}
if (SUCCEED != ret)
{
*error = zbx_strdup(*error, "cannot parse comment");
return FAIL;
}
loc->r = loc_hint.r;
metric = str_loc_dup(data, &loc_metric);
/* skip hints of metrics not matching filter */
if (NULL != filter->metric && SUCCEED != condition_match_key_value(filter->metric, NULL, metric))
{
zbx_free(metric);
return SUCCEED;
}
return prometheus_register_hint(hints, data, metric, &loc_hint, hint_type, error);
}
/******************************************************************************
* *
* Function: prometheus_parse_rows *
* *
* Purpose: parses rows with metrics from prometheus data *
* *
* Parameters: filter - [IN] the prometheus filter *
* data - [IN] the metric data *
* rows - [OUT] the parsed rows *
* hints - [OUT] the TYPE/HELP hint registry (optional) *
* error - [OUT] the error message *
* *
* Return value: SUCCEED - the rows were parsed successfully *
* FAIL - otherwise *
* *
******************************************************************************/
static int prometheus_parse_rows(zbx_prometheus_filter_t *filter, const char *data, zbx_vector_ptr_t *rows,
zbx_hashset_t *hints, char **error)
{
const char *__function_name = "prometheus_parse_rows";
size_t pos = 0;
int row_num = 1, ret = FAIL;
zbx_prometheus_row_t *row;
char *errmsg = NULL;
zbx_strloc_t loc;
zabbix_log(LOG_LEVEL_DEBUG, "In %s()", __function_name);
for (pos = 0; '\0' != data[pos]; pos = skip_row(data, pos), row_num++)
{
pos = skip_spaces(data, pos);
/* skip empty strings */
if ('\n' == data[pos])
continue;
if ('#' == data[pos])
{
if (NULL != hints)
{
if (SUCCEED != prometheus_parse_hint(filter, data, pos, hints, &loc, &errmsg))
goto out;
pos = loc.r + 1;
}
continue;
}
if (SUCCEED != prometheus_parse_row(filter, data, pos, &row, &loc, &errmsg))
goto out;
if (NULL != row)
{
if (NULL != hints)
row->raw = str_loc_dup(data, &loc);
zbx_vector_ptr_append(rows, row);
}
pos = loc.r + 1;
}
ret = SUCCEED;
out:
if (SUCCEED != ret)
{
const char *ptr, *suffix = "";
int len;
if (NULL != (ptr = strchr(data + pos, '\n')))
len = ptr - data - pos;
else
len = strlen(data + pos);
if (ZBX_PROMEHTEUS_ERROR_MAX_ROW_LENGTH < len)
{
len = ZBX_PROMEHTEUS_ERROR_MAX_ROW_LENGTH;
suffix = "...";
}
*error = zbx_dsprintf(*error, "data parsing error at row %d \"%.*s%s\": %s", row_num, len, data + pos,
suffix, errmsg);
zbx_free(errmsg);
}
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%s rows:%d", __function_name, zbx_result_string(ret),
rows->values_num);
return ret;
}
/******************************************************************************
* *
* Function: prometheus_extract_value *
* *
* Purpose: extracts value from filtered rows according to output template *
* *
* Parameters: filter - [IN] the prometheus filter *
* output - [IN] the output template *
* value - [OUT] the extracted value *
* error - [OUT] the error message *
* *
* Return value: SUCCEED - the value was extracted successfully *
* FAIL - otherwise *
* *
******************************************************************************/
static int prometheus_extract_value(zbx_vector_ptr_t *rows, const char *output, char **value, char **error)
{
zbx_prometheus_row_t *row;
if (0 == rows->values_num)
{
*error = zbx_strdup(*error, "no metric matches the filter");
return FAIL;
}
if (1 < rows->values_num)
{
*error = zbx_strdup(*error, "multiple metrics match the filter");
return FAIL;
}
row = (zbx_prometheus_row_t *)rows->values[0];
if ('\0' != *output)
{
int i;
zbx_prometheus_label_t *label;
for (i = 0; i < row->labels.values_num; i++)
{
label = (zbx_prometheus_label_t *)row->labels.values[i];
if (0 == strcmp(label->name, output))
break;
}
if (i == row->labels.values_num)
{
*error = zbx_strdup(*error, "no label matches the specified output");
return FAIL;
}
*value = zbx_strdup(NULL, label->value);
}
else
*value = zbx_strdup(NULL, row->value);
return SUCCEED;
}
/******************************************************************************
* *
* Function: zbx_prometheus_pattern *
* *
* Purpose: extracts value from prometheus data by the specified filter *
* *
* Parameters: data - [IN] the prometheus data *
* fitler_data - [IN] the filter in text format *
* output - [IN] the output template *
* value - [OUT] the extracted value *
* error - [OUT] the error message *
* *
* Return value: SUCCEED - the value was extracted successfully *
* FAIL - otherwise *
* *
******************************************************************************/
int zbx_prometheus_pattern(const char *data, const char *filter_data, const char *output, char **value,
char **error)
{
const char *__function_name = "zbx_prometheus_pattern";
zbx_prometheus_filter_t filter;
char *errmsg = NULL;
int ret = FAIL;
zbx_vector_ptr_t rows;
zabbix_log(LOG_LEVEL_DEBUG, "In %s()", __function_name);
if (FAIL == prometheus_filter_init(&filter, filter_data, &errmsg))
{
*error = zbx_dsprintf(*error, "filter error: %s", errmsg);
zbx_free(errmsg);
goto out;
}
zbx_vector_ptr_create(&rows);
if (FAIL == prometheus_parse_rows(&filter, data, &rows, NULL, error))
goto cleanup;
if (FAIL == prometheus_extract_value(&rows, output, value, &errmsg))
{
*error = zbx_dsprintf(*error, "data extraction error: %s", errmsg);
zbx_free(errmsg);
goto cleanup;
}
ret = SUCCEED;
cleanup:
zbx_vector_ptr_clear_ext(&rows, (zbx_clean_func_t)prometheus_row_free);
zbx_vector_ptr_destroy(&rows);
prometheus_filter_clear(&filter);
out:
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%s", __function_name, zbx_result_string(ret));
return ret;
}
/******************************************************************************
* *
* Function: zbx_prometheus_to_json *
* *
* Purpose: converts filtered prometheus data to json to be used with LLD *
* *
* Parameters: data - [IN] the prometheus data *
* fitler_data - [IN] the filter in text format *
* value - [OUT] the converted data *
* error - [OUT] the error message *
* *
* Return value: SUCCEED - the data was converted successfully *
* FAIL - otherwise *
* *
******************************************************************************/
int zbx_prometheus_to_json(const char *data, const char *filter_data, char **value, char **error)
{
const char *__function_name = "zbx_prometheus_to_json";
zbx_prometheus_filter_t filter;
char *errmsg = NULL;
int ret = FAIL, i, j;
zbx_vector_ptr_t rows;
zbx_hashset_t hints;
zbx_prometheus_hint_t *hint, hint_local;
zbx_hashset_iter_t iter;
struct zbx_json json;
zabbix_log(LOG_LEVEL_DEBUG, "In %s()", __function_name);
if (FAIL == prometheus_filter_init(&filter, filter_data, &errmsg))
{
*error = zbx_dsprintf(*error, "filter error: %s", errmsg);
zbx_free(errmsg);
goto out;
}
zbx_vector_ptr_create(&rows);
zbx_hashset_create(&hints, 100, prometheus_hint_hash, prometheus_hint_compare);
zbx_json_initarray(&json, rows.values_num * 100);
if (FAIL == prometheus_parse_rows(&filter, data, &rows, &hints, error))
goto cleanup;
for (i = 0; i < rows.values_num; i++)
{
zbx_prometheus_row_t *row = (zbx_prometheus_row_t *)rows.values[i];
char *hint_type;
zbx_json_addobject(&json, NULL);
zbx_json_addstring(&json, ZBX_PROTO_TAG_NAME, row->metric, ZBX_JSON_TYPE_STRING);
zbx_json_addstring(&json, ZBX_PROTO_TAG_VALUE, row->value, ZBX_JSON_TYPE_STRING);
zbx_json_addstring(&json, ZBX_PROTO_TAG_LINE_RAW, row->raw, ZBX_JSON_TYPE_STRING);
if (0 != row->labels.values_num)
{
zbx_json_addobject(&json, ZBX_PROTO_TAG_LABELS);
for (j = 0; j < row->labels.values_num; j++)
{
zbx_prometheus_label_t *label = (zbx_prometheus_label_t *)row->labels.values[j];
zbx_json_addstring(&json, label->name, label->value, ZBX_JSON_TYPE_STRING);
}
zbx_json_close(&json);
}
hint_local.metric = row->metric;
hint = (zbx_prometheus_hint_t *)zbx_hashset_search(&hints, &hint_local);
hint_type = (NULL != hint && NULL != hint->type ? hint->type : ZBX_PROMETHEUS_TYPE_UNTYPED);
zbx_json_addstring(&json, ZBX_PROTO_TAG_TYPE, hint_type, ZBX_JSON_TYPE_STRING);
if (NULL != hint && NULL != hint->help)
zbx_json_addstring(&json, ZBX_PROTO_TAG_HELP, hint->help, ZBX_JSON_TYPE_STRING);
zbx_json_close(&json);
}
*value = zbx_strdup(NULL, json.buffer);
ret = SUCCEED;
cleanup:
zbx_json_free(&json);
zbx_hashset_iter_reset(&hints, &iter);
while (NULL != (hint = (zbx_prometheus_hint_t *)zbx_hashset_iter_next(&iter)))
{
zbx_free(hint->metric);
zbx_free(hint->help);
zbx_free(hint->type);
}
zbx_hashset_destroy(&hints);
zbx_vector_ptr_clear_ext(&rows, (zbx_clean_func_t)prometheus_row_free);
zbx_vector_ptr_destroy(&rows);
prometheus_filter_clear(&filter);
out:
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%s", __function_name, zbx_result_string(ret));
return ret;
}
#ifdef HAVE_TESTS
# include "../../../tests/libs/zbxprometheus/prometheus_test.c"
#endif
|