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
|
/* Copyright (c) 2021, The Tor Project, Inc. */
/* See LICENSE for licensing information */
/**
* @file relay_metrics.c
* @brief Relay metrics exposed through the MetricsPort
**/
#define RELAY_METRICS_ENTRY_PRIVATE
#include "orconfig.h"
#include "core/or/or.h"
#include "core/or/relay.h"
#include "lib/malloc/malloc.h"
#include "lib/container/smartlist.h"
#include "lib/metrics/metrics_store.h"
#include "lib/log/util_bug.h"
#include "feature/relay/relay_metrics.h"
#include "feature/stats/rephist.h"
/** Declarations of each fill function for metrics defined in base_metrics. */
static void fill_oom_values(void);
static void fill_onionskins_values(void);
/** The base metrics that is a static array of metrics added to the metrics
* store.
*
* The key member MUST be also the index of the entry in the array. */
static const relay_metrics_entry_t base_metrics[] =
{
{
.key = RELAY_METRICS_NUM_OOM_BYTES,
.type = METRICS_TYPE_COUNTER,
.name = METRICS_NAME(relay_load_oom_bytes_total),
.help = "Total number of bytes the OOM has freed by subsystem",
.fill_fn = fill_oom_values,
},
{
.key = RELAY_METRICS_NUM_ONIONSKINS,
.type = METRICS_TYPE_COUNTER,
.name = METRICS_NAME(relay_load_onionskins_total),
.help = "Total number of onionskins handled",
.fill_fn = fill_onionskins_values,
},
};
static const size_t num_base_metrics = ARRAY_LENGTH(base_metrics);
/** The only and single store of all the relay metrics. */
static metrics_store_t *the_store;
/** Helper function to convert an handshake type into a string. */
static inline const char *
handshake_type_to_str(const uint16_t type)
{
switch (type) {
case ONION_HANDSHAKE_TYPE_TAP:
return "tap";
case ONION_HANDSHAKE_TYPE_FAST:
return "fast";
case ONION_HANDSHAKE_TYPE_NTOR:
return "ntor";
default:
// LCOV_EXCL_START
tor_assert_unreached();
// LCOV_EXCL_STOP
}
}
/** Fill function for the RELAY_METRICS_NUM_ONIONSKINS metrics. */
static void
fill_onionskins_values(void)
{
metrics_store_entry_t *sentry;
const relay_metrics_entry_t *rentry =
&base_metrics[RELAY_METRICS_NUM_ONIONSKINS];
for (uint16_t t = 0; t <= MAX_ONION_HANDSHAKE_TYPE; t++) {
/* Dup the label because metrics_format_label() returns a pointer to a
* string on the stack and we need that label for all metrics. */
char *type_label =
tor_strdup(metrics_format_label("type", handshake_type_to_str(t)));
sentry = metrics_store_add(the_store, rentry->type, rentry->name,
rentry->help);
metrics_store_entry_add_label(sentry, type_label);
metrics_store_entry_add_label(sentry,
metrics_format_label("action", "processed"));
metrics_store_entry_update(sentry,
rep_hist_get_circuit_handshake_assigned(t));
sentry = metrics_store_add(the_store, rentry->type, rentry->name,
rentry->help);
metrics_store_entry_add_label(sentry, type_label);
metrics_store_entry_add_label(sentry,
metrics_format_label("action", "dropped"));
metrics_store_entry_update(sentry,
rep_hist_get_circuit_handshake_dropped(t));
tor_free(type_label);
}
}
/** Fill function for the RELAY_METRICS_NUM_OOM_BYTES metrics. */
static void
fill_oom_values(void)
{
metrics_store_entry_t *sentry;
const relay_metrics_entry_t *rentry =
&base_metrics[RELAY_METRICS_NUM_OOM_BYTES];
sentry = metrics_store_add(the_store, rentry->type, rentry->name,
rentry->help);
metrics_store_entry_add_label(sentry, "subsys=cell");
metrics_store_entry_update(sentry, oom_stats_n_bytes_removed_cell);
sentry = metrics_store_add(the_store, rentry->type, rentry->name,
rentry->help);
metrics_store_entry_add_label(sentry, "subsys=dns");
metrics_store_entry_update(sentry, oom_stats_n_bytes_removed_dns);
sentry = metrics_store_add(the_store, rentry->type, rentry->name,
rentry->help);
metrics_store_entry_add_label(sentry, "subsys=geoip");
metrics_store_entry_update(sentry, oom_stats_n_bytes_removed_geoip);
sentry = metrics_store_add(the_store, rentry->type, rentry->name,
rentry->help);
metrics_store_entry_add_label(sentry, "subsys=hsdir");
metrics_store_entry_update(sentry, oom_stats_n_bytes_removed_hsdir);
}
/** Reset the global store and fill it with all the metrics from base_metrics
* and their associated values.
*
* To pull this off, every metrics has a "fill" function that is called and in
* charge of adding the metrics to the store, appropriate labels and finally
* updating the value to report. */
static void
fill_store(void)
{
/* Reset the current store, we are about to fill it with all the things. */
metrics_store_reset(the_store);
/* Call the fill function for each metrics. */
for (size_t i = 0; i < num_base_metrics; i++) {
if (BUG(!base_metrics[i].fill_fn)) {
continue;
}
base_metrics[i].fill_fn();
}
}
/** Return a list of all the relay metrics stores. This is the
* function attached to the .get_metrics() member of the subsys_t. */
const smartlist_t *
relay_metrics_get_stores(void)
{
/* We can't have the caller to free the returned list so keep it static,
* simply update it. */
static smartlist_t *stores_list = NULL;
/* We dynamically fill the store with all the metrics upon a request. The
* reason for this is because the exposed metrics of a relay are often
* internal counters in the fast path and thus we fetch the value when a
* metrics port request arrives instead of keeping a local metrics store of
* those values. */
fill_store();
if (!stores_list) {
stores_list = smartlist_new();
smartlist_add(stores_list, the_store);
}
return stores_list;
}
/** Initialize the relay metrics. */
void
relay_metrics_init(void)
{
if (BUG(the_store)) {
return;
}
the_store = metrics_store_new();
}
/** Free the relay metrics. */
void
relay_metrics_free(void)
{
if (!the_store) {
return;
}
/* NULL is set with this call. */
metrics_store_free(the_store);
}
|
