torproject/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-12-06 19:41:15 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'tor-gitlab/mr/700'

Browse Source
This commit is contained in:
David Goulet
2023-03-13 11:22:31 -04:00
parent 8f50f490a6 1a60fa547f
commit 59456cb3cf
16 changed files with 602 additions and 127 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/test/test_hs_metrics.c
+4 -4
View File
@@ -40,7 +40,7 @@ test_metrics(void *arg)
/* Update entry by identifier. */
hs_metrics_update_by_ident(HS_METRICS_NUM_INTRODUCTIONS,
&service->keys.identity_pk, 0, NULL, 42);
&service->keys.identity_pk, 0, NULL, 42, 0);
/* Confirm the entry value. */
const smartlist_t *entries = metrics_store_get_all(service->metrics.store,
@@ -53,14 +53,14 @@ test_metrics(void *arg)
/* Update entry by service now. */
hs_metrics_update_by_service(HS_METRICS_NUM_INTRODUCTIONS,
service, 0, NULL, 42);
service, 0, NULL, 42, 0);
tt_int_op(metrics_store_entry_get_value(entry), OP_EQ, 84);
const char *reason = HS_METRICS_ERR_INTRO_REQ_BAD_AUTH_KEY;
/* Update tor_hs_intro_rejected_intro_req_count */
hs_metrics_update_by_ident(HS_METRICS_NUM_REJECTED_INTRO_REQ,
&service->keys.identity_pk, 0, reason, 112);
&service->keys.identity_pk, 0, reason, 112, 0);
entries = metrics_store_get_all(service->metrics.store,
"tor_hs_intro_rejected_intro_req_count");
@@ -75,7 +75,7 @@ test_metrics(void *arg)
/* Update tor_hs_intro_rejected_intro_req_count entry by service now. */
hs_metrics_update_by_service(HS_METRICS_NUM_REJECTED_INTRO_REQ, service, 0,
reason, 10);
reason, 10, 0);
tt_int_op(metrics_store_entry_get_value(entry), OP_EQ, 122);
done:
src/test/test_metrics.c
+143 -3
View File
@@ -28,11 +28,16 @@
#include "lib/encoding/confline.h"
#include "lib/metrics/metrics_store.h"
#include <limits.h>
#define TEST_METRICS_ENTRY_NAME "entryA"
#define TEST_METRICS_ENTRY_HELP "Description of entryA"
#define TEST_METRICS_ENTRY_LABEL_1 "label=\"farfadet\""
#define TEST_METRICS_ENTRY_LABEL_2 "label=\"ponki\""
#define TEST_METRICS_HIST_ENTRY_NAME "test_hist_entry"
#define TEST_METRICS_HIST_ENTRY_HELP "Description of test_hist_entry"
static void
set_metrics_port(or_options_t *options)
{
@@ -189,7 +194,8 @@ test_prometheus(void *arg)
/* Add entry and validate its content. */
entry = metrics_store_add(store, METRICS_TYPE_COUNTER,
TEST_METRICS_ENTRY_NAME,
TEST_METRICS_ENTRY_HELP);
TEST_METRICS_ENTRY_HELP,
0, NULL);
tt_assert(entry);
metrics_store_entry_add_label(entry, TEST_METRICS_ENTRY_LABEL_1);
@@ -208,11 +214,61 @@ test_prometheus(void *arg)
metrics_store_free(store);
}
static void
test_prometheus_histogram(void *arg)
{
metrics_store_t *store = NULL;
metrics_store_entry_t *entry = NULL;
buf_t *buf = buf_new();
char *output = NULL;
const int64_t buckets[] = { 10, 20, 3000 };
(void) arg;
/* Fresh new store. No entries. */
store = metrics_store_new();
tt_assert(store);
/* Add a histogram entry and validate its content. */
entry = metrics_store_add(store, METRICS_TYPE_HISTOGRAM,
TEST_METRICS_HIST_ENTRY_NAME,
TEST_METRICS_HIST_ENTRY_HELP,
ARRAY_LENGTH(buckets), buckets);
tt_assert(entry);
metrics_store_entry_add_label(entry, TEST_METRICS_ENTRY_LABEL_1);
static const char *expected =
"# HELP " TEST_METRICS_HIST_ENTRY_NAME " "
TEST_METRICS_HIST_ENTRY_HELP "\n"
"# TYPE " TEST_METRICS_HIST_ENTRY_NAME " histogram\n"
TEST_METRICS_HIST_ENTRY_NAME "_bucket{"
TEST_METRICS_ENTRY_LABEL_1 ",le=\"10.00\"} 0\n"
TEST_METRICS_HIST_ENTRY_NAME "_bucket{"
TEST_METRICS_ENTRY_LABEL_1 ",le=\"20.00\"} 0\n"
TEST_METRICS_HIST_ENTRY_NAME "_bucket{"
TEST_METRICS_ENTRY_LABEL_1 ",le=\"3000.00\"} 0\n"
TEST_METRICS_HIST_ENTRY_NAME "_bucket{"
TEST_METRICS_ENTRY_LABEL_1 ",le=\"+Inf\"} 0\n"
TEST_METRICS_HIST_ENTRY_NAME "_sum{" TEST_METRICS_ENTRY_LABEL_1 "} 0\n"
TEST_METRICS_HIST_ENTRY_NAME "_count{" TEST_METRICS_ENTRY_LABEL_1 "} 0\n";
metrics_store_get_output(METRICS_FORMAT_PROMETHEUS, store, buf);
output = buf_extract(buf, NULL);
tt_str_op(expected, OP_EQ, output);
done:
buf_free(buf);
tor_free(output);
metrics_store_free(store);
}
static void
test_store(void *arg)
{
metrics_store_t *store = NULL;
metrics_store_entry_t *entry = NULL;
const int64_t buckets[] = { 10, 20, 3000 };
const size_t bucket_count = ARRAY_LENGTH(buckets);
(void) arg;
@@ -224,7 +280,7 @@ test_store(void *arg)
/* Add entry and validate its content. */
entry = metrics_store_add(store, METRICS_TYPE_COUNTER,
TEST_METRICS_ENTRY_NAME,
TEST_METRICS_ENTRY_HELP);
TEST_METRICS_ENTRY_HELP, 0, NULL);
tt_assert(entry);
tt_int_op(entry->type, OP_EQ, METRICS_TYPE_COUNTER);
tt_str_op(entry->name, OP_EQ, TEST_METRICS_ENTRY_NAME);
@@ -251,7 +307,7 @@ test_store(void *arg)
/* Add entry and validate its content. */
entry = metrics_store_add(store, METRICS_TYPE_COUNTER,
TEST_METRICS_ENTRY_NAME,
TEST_METRICS_ENTRY_HELP);
TEST_METRICS_ENTRY_HELP, 0, NULL);
tt_assert(entry);
metrics_store_entry_add_label(entry, TEST_METRICS_ENTRY_LABEL_2);
@@ -261,6 +317,89 @@ test_store(void *arg)
tt_assert(entries);
tt_int_op(smartlist_len(entries), OP_EQ, 2);
/* Add a histogram entry and validate its content. */
entry = metrics_store_add(store, METRICS_TYPE_HISTOGRAM,
TEST_METRICS_HIST_ENTRY_NAME,
TEST_METRICS_HIST_ENTRY_HELP,
bucket_count, buckets);
tt_assert(entry);
tt_int_op(entry->type, OP_EQ, METRICS_TYPE_HISTOGRAM);
tt_str_op(entry->name, OP_EQ, TEST_METRICS_HIST_ENTRY_NAME);
tt_str_op(entry->help, OP_EQ, TEST_METRICS_HIST_ENTRY_HELP);
tt_uint_op(entry->u.histogram.bucket_count, OP_EQ, bucket_count);
for (size_t i = 0; i < bucket_count; ++i) {
tt_uint_op(entry->u.histogram.buckets[i].bucket, OP_EQ, buckets[i]);
tt_uint_op(entry->u.histogram.buckets[i].value, OP_EQ, 0);
}
/* Access the entry. */
tt_assert(metrics_store_get_all(store, TEST_METRICS_HIST_ENTRY_NAME));
/* Record various observations. */
metrics_store_hist_entry_update(entry, 3, 11);
tt_int_op(metrics_store_hist_entry_get_value(entry, 10), OP_EQ, 0);
tt_int_op(metrics_store_hist_entry_get_value(entry, 20), OP_EQ, 3);
tt_int_op(metrics_store_hist_entry_get_value(entry, 3000), OP_EQ, 3);
tt_int_op(metrics_store_hist_entry_get_value(entry, 3000), OP_EQ, 3);
tt_int_op(metrics_store_hist_entry_get_count(entry), OP_EQ, 3);
tt_int_op(metrics_store_hist_entry_get_sum(entry), OP_EQ, 11);
metrics_store_hist_entry_update(entry, 1, 42);
tt_int_op(metrics_store_hist_entry_get_value(entry, 10), OP_EQ, 0);
tt_int_op(metrics_store_hist_entry_get_value(entry, 20), OP_EQ, 3);
tt_int_op(metrics_store_hist_entry_get_value(entry, 3000), OP_EQ, 4);
tt_int_op(metrics_store_hist_entry_get_value(entry, 3000), OP_EQ, 4);
tt_int_op(metrics_store_hist_entry_get_count(entry), OP_EQ, 4);
tt_int_op(metrics_store_hist_entry_get_sum(entry), OP_EQ, 53);
/* Ensure this resets all buckets back to 0. */
metrics_store_entry_reset(entry);
for (size_t i = 0; i < bucket_count; ++i) {
tt_uint_op(entry->u.histogram.buckets[i].bucket, OP_EQ, buckets[i]);
tt_uint_op(entry->u.histogram.buckets[i].value, OP_EQ, 0);
}
/* tt_int_op assigns the third argument to a variable of type long, which
* overflows on some platforms (e.g. on some 32-bit systems). We disable
* these checks for those platforms. */
#if LONG_MAX >= INT64_MAX
metrics_store_hist_entry_update(entry, 1, INT64_MAX - 13);
tt_int_op(metrics_store_hist_entry_get_sum(entry), OP_EQ, INT64_MAX - 13);
metrics_store_hist_entry_update(entry, 1, 13);
tt_int_op(metrics_store_hist_entry_get_sum(entry), OP_EQ, INT64_MAX);
/* Uh-oh, the sum of all observations is now greater than INT64_MAX. Make
* sure we reset the entry instead of overflowing the sum. */
metrics_store_hist_entry_update(entry, 1, 1);
tt_int_op(metrics_store_hist_entry_get_value(entry, 10), OP_EQ, 1);
tt_int_op(metrics_store_hist_entry_get_value(entry, 20), OP_EQ, 1);
tt_int_op(metrics_store_hist_entry_get_value(entry, 3000), OP_EQ, 1);
tt_int_op(metrics_store_hist_entry_get_value(entry, 3000), OP_EQ, 1);
tt_int_op(metrics_store_hist_entry_get_count(entry), OP_EQ, 1);
tt_int_op(metrics_store_hist_entry_get_sum(entry), OP_EQ, 1);
#endif
#if LONG_MIN <= INT64_MIN
metrics_store_entry_reset(entry);
/* In practice, we're not going to have negative observations (as we only use
* histograms for timings, which are always positive), but technically
* prometheus _does_ support negative observations. */
metrics_store_hist_entry_update(entry, 1, INT64_MIN + 13);
tt_int_op(metrics_store_hist_entry_get_sum(entry), OP_EQ, INT64_MIN + 13);
metrics_store_hist_entry_update(entry, 1, -13);
tt_int_op(metrics_store_hist_entry_get_sum(entry), OP_EQ, INT64_MIN);
/* Uh-oh, the sum of all observations is now less than INT64_MIN. Make
* sure we reset the entry instead of underflowing the sum. */
metrics_store_hist_entry_update(entry, 1, -1);
tt_int_op(metrics_store_hist_entry_get_value(entry, 10), OP_EQ, 1);
tt_int_op(metrics_store_hist_entry_get_value(entry, 20), OP_EQ, 1);
tt_int_op(metrics_store_hist_entry_get_value(entry, 3000), OP_EQ, 1);
tt_int_op(metrics_store_hist_entry_get_value(entry, 3000), OP_EQ, 1);
tt_int_op(metrics_store_hist_entry_get_count(entry), OP_EQ, 1);
tt_int_op(metrics_store_hist_entry_get_sum(entry), OP_EQ, -1);
#endif
done:
metrics_store_free(store);
}
@@ -270,6 +409,7 @@ struct testcase_t metrics_tests[] = {
{ "config", test_config, TT_FORK, NULL, NULL },
{ "connection", test_connection, TT_FORK, NULL, NULL },
{ "prometheus", test_prometheus, TT_FORK, NULL, NULL },
{ "prometheus_histogram", test_prometheus_histogram, TT_FORK, NULL, NULL },
{ "store", test_store, TT_FORK, NULL, NULL },
END_OF_TESTCASES