Skip to content

Reintroduce username labels in metrics and make them configurable. #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sysvinit merged 2 commits into from
Jun 20, 2022
Merged

Reintroduce username labels in metrics and make them configurable. #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e9e1be
Make username labeling in metrics configurable.
sysvinit Jun 15, 2022
51c6f86
Use NULL instead of literal zero.
sysvinit Jun 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.turnserver
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,10 @@ Flags:
disabled. Would listen on port 9641 unther the path /metrics
also the path / on this port can be used as a health check.
See also options --prometheus-ip and --prometheus-port.
--prometheus-no-username-labels Disable labeling prometheus traffic
metrics with client usernames. Labeling with client usernames is
enabled by default, however this may cause memory leaks when using
authentication with ephemeral usernames (e.g. TURN REST API).

-h Help.

Expand Down
7 changes: 7 additions & 0 deletions man/man1/turnserver.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,6 +440,13 @@ Enable prometheus metrics. By default it is
disabled. Would listen on port 9641 unther the path /metrics
also the path / on this port can be used as a health check.
See also \fIoptions\fP \fB\-\-prometheus\-ip\fP and \fB\-\-prometheus\-port\fP.
.TP
.B
\fB\-\-prometheus\-no\-username\-labels\fP
Disable labeling prometheus traffic
metrics with client usernames. Labeling with client usernames is
enabled by default, however this may cause memory leaks when using
authentication with ephemeral usernames (e.g. TURN REST API).
.RE
.TP
.B
Expand Down
7 changes: 7 additions & 0 deletions src/apps/relay/mainrelay.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ TURN_CREDENTIALS_NONE, /* ct */
0, /* user_quota */
#if !defined(TURN_NO_PROMETHEUS)
0, /* prometheus disabled by default */
1, /* prometheus username labelling enabled by default when prometheus is enabled */
#endif
///////////// Users DB //////////////
{ (TURN_USERDB_TYPE)0, {"\0"}, {0,NULL, {NULL,0}} },
Expand Down Expand Up @@ -563,6 +564,7 @@ static char Usage[] = "Usage: turnserver [options]\n"
" --prometheus Enable prometheus metrics. It is disabled by default.\n"
" When enabled, it will listen on port 9641 on the wildcard address under the path /metrics.\n"
" The path / on this port can also be used as a health check.\n"
" --prometheus-no-username-labels When metrics are enabled, do not label metrics with client usernames.\n"
" --prometheus-ip=<ip> IP address for the Prometheus listener. Default is the wildcard address.\n"
" --prometheus-port=<port> Prometheus listener port. Default is 9641.\n"
#endif
Expand Down Expand Up @@ -795,6 +797,7 @@ enum EXTRA_OPTS {
CHANNEL_LIFETIME_OPT,
PERMISSION_LIFETIME_OPT,
PROMETHEUS_OPT,
PROMETHEUS_DISABLE_USERNAMES_OPT,
PROMETHEUS_IP_OPT,
PROMETHEUS_PORT_OPT,
AUTH_SECRET_OPT,
Expand Down Expand Up @@ -913,6 +916,7 @@ static const struct myoption long_options[] = {
#endif
#if !defined(TURN_NO_PROMETHEUS)
{ "prometheus", optional_argument, NULL, PROMETHEUS_OPT },
{ "prometheus-no-username-labels", optional_argument, NULL, PROMETHEUS_DISABLE_USERNAMES_OPT },
{ "prometheus-ip", required_argument, NULL, PROMETHEUS_IP_OPT },
{ "prometheus-port", required_argument, NULL, PROMETHEUS_PORT_OPT },
#endif
Expand Down Expand Up @@ -1548,6 +1552,9 @@ static void set_option(int c, char *value)
case PROMETHEUS_OPT:
turn_params.prometheus = turn_params.prometheus == PROM_DISABLED ? PROM_ENABLED : turn_params.prometheus;
break;
case PROMETHEUS_DISABLE_USERNAMES_OPT:
turn_params.prometheus_username_labels = 0;
break;
case PROMETHEUS_IP_OPT:
if(make_ioa_addr((const uint8_t*)value,0,&prometheus_addr)<0) {
TURN_LOG_FUNC(TURN_LOG_LEVEL_ERROR,"Cannot parse Prometheus listener address: %s\n", value);
Expand Down
1 change: 1 addition & 0 deletions src/apps/relay/mainrelay.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,7 @@ typedef struct _turn_params_ {
vint user_quota;
#if !defined(TURN_NO_PROMETHEUS)
int prometheus;
int prometheus_username_labels;
#endif


Expand Down
33 changes: 20 additions & 13 deletions src/apps/relay/prom_server.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,20 +33,26 @@ int start_prometheus_server(void){
return 1;
}
prom_collector_registry_default_init();

const char *label[] = {"realm"};

const char *label[] = {"realm", NULL};
size_t nlabels = 1;

if (turn_params.prometheus_username_labels) {
label[1] = "user";
nlabels++;
}

// Create traffic counter metrics
turn_traffic_rcvp = prom_collector_registry_must_register_metric(prom_counter_new("turn_traffic_rcvp", "Represents finished sessions received packets", 1, label));
turn_traffic_rcvb = prom_collector_registry_must_register_metric(prom_counter_new("turn_traffic_rcvb", "Represents finished sessions received bytes", 1, label));
turn_traffic_sentp = prom_collector_registry_must_register_metric(prom_counter_new("turn_traffic_sentp", "Represents finished sessions sent packets", 1, label));
turn_traffic_sentb = prom_collector_registry_must_register_metric(prom_counter_new("turn_traffic_sentb", "Represents finished sessions sent bytes", 1, label));
turn_traffic_rcvp = prom_collector_registry_must_register_metric(prom_counter_new("turn_traffic_rcvp", "Represents finished sessions received packets", nlabels, label));
turn_traffic_rcvb = prom_collector_registry_must_register_metric(prom_counter_new("turn_traffic_rcvb", "Represents finished sessions received bytes", nlabels, label));
turn_traffic_sentp = prom_collector_registry_must_register_metric(prom_counter_new("turn_traffic_sentp", "Represents finished sessions sent packets", nlabels, label));
turn_traffic_sentb = prom_collector_registry_must_register_metric(prom_counter_new("turn_traffic_sentb", "Represents finished sessions sent bytes", nlabels, label));

// Create finished sessions traffic for peers counter metrics
turn_traffic_peer_rcvp = prom_collector_registry_must_register_metric(prom_counter_new("turn_traffic_peer_rcvp", "Represents finished sessions peer received packets", 1, label));
turn_traffic_peer_rcvb = prom_collector_registry_must_register_metric(prom_counter_new("turn_traffic_peer_rcvb", "Represents finished sessions peer received bytes", 1, label));
turn_traffic_peer_sentp = prom_collector_registry_must_register_metric(prom_counter_new("turn_traffic_peer_sentp", "Represents finished sessions peer sent packets", 1, label));
turn_traffic_peer_sentb = prom_collector_registry_must_register_metric(prom_counter_new("turn_traffic_peer_sentb", "Represents finished sessions peer sent bytes", 1, label));
turn_traffic_peer_rcvp = prom_collector_registry_must_register_metric(prom_counter_new("turn_traffic_peer_rcvp", "Represents finished sessions peer received packets", nlabels, label));
turn_traffic_peer_rcvb = prom_collector_registry_must_register_metric(prom_counter_new("turn_traffic_peer_rcvb", "Represents finished sessions peer received bytes", nlabels, label));
turn_traffic_peer_sentp = prom_collector_registry_must_register_metric(prom_counter_new("turn_traffic_peer_sentp", "Represents finished sessions peer sent packets", nlabels, label));
turn_traffic_peer_sentb = prom_collector_registry_must_register_metric(prom_counter_new("turn_traffic_peer_sentb", "Represents finished sessions peer sent bytes", nlabels, label));

// Create total finished traffic counter metrics
turn_total_traffic_rcvp = prom_collector_registry_must_register_metric(prom_counter_new("turn_total_traffic_rcvp", "Represents total finished sessions received packets", 0, NULL));
Expand Down Expand Up @@ -93,11 +99,12 @@ int start_prometheus_server(void){
}

void prom_set_finished_traffic(const char* realm, const char* user, unsigned long rsvp, unsigned long rsvb, unsigned long sentp, unsigned long sentb, bool peer){
(void) user;

if (turn_params.prometheus > PROM_DISABLED){

const char *label[] = {realm};
const char *label[] = {realm, NULL};
if (turn_params.prometheus_username_labels){
label[1] = user;
}

if (peer){
prom_counter_add(turn_traffic_peer_rcvp, rsvp, label);
Expand Down