From 22861c2f4083e7e29a732a4907c2dcadd6a6a4db Mon Sep 17 00:00:00 2001
From: David Goulet <dgoulet@torproject.org>
Date: Thu, 6 May 2021 11:17:26 -0400
Subject: relay: Add TCP port exhaustion metrics

Signed-off-by: David Goulet <dgoulet@torproject.org>
---
 src/core/mainloop/connection.c    |  2 +-
 src/feature/relay/relay_metrics.c | 21 +++++++++++++++++++++
 src/feature/relay/relay_metrics.h |  2 ++
 src/feature/stats/rephist.c       | 19 +++++++++++++++++++
 src/feature/stats/rephist.h       |  3 +++
 5 files changed, 46 insertions(+), 1 deletion(-)

diff --git a/src/core/mainloop/connection.c b/src/core/mainloop/connection.c
index 9c6da1295f..4832f25491 100644
--- a/src/core/mainloop/connection.c
+++ b/src/core/mainloop/connection.c
@@ -1261,7 +1261,7 @@ socket_failed_from_resource_exhaustion(void)
    */
   if (get_max_sockets() > 65535) {
     /* TCP port exhaustion */
-    rep_hist_note_overload(OVERLOAD_GENERAL);
+    rep_hist_note_tcp_exhaustion();
   } else {
     /* File descriptor exhaustion */
     rep_hist_note_overload(OVERLOAD_FD_EXHAUSTED);
diff --git a/src/feature/relay/relay_metrics.c b/src/feature/relay/relay_metrics.c
index 466e4da55e..2c24728d9a 100644
--- a/src/feature/relay/relay_metrics.c
+++ b/src/feature/relay/relay_metrics.c
@@ -30,6 +30,7 @@ static void fill_global_bw_limit_values(void);
 static void fill_socket_values(void);
 static void fill_onionskins_values(void);
 static void fill_oom_values(void);
+static void fill_tcp_exhaustion_values(void);
 
 /** The base metrics that is a static array of metrics added to the metrics
  * store.
@@ -79,6 +80,13 @@ static const relay_metrics_entry_t base_metrics[] =
     .help = "Total number of DNS errors encountered by this relay",
     .fill_fn = fill_dns_error_values,
   },
+  {
+    .key = RELAY_METRICS_NUM_TCP_EXHAUSTION,
+    .type = METRICS_TYPE_COUNTER,
+    .name = METRICS_NAME(relay_load_tcp_exhaustion_total),
+    .help = "Total number of times we ran out of TCP ports",
+    .fill_fn = fill_tcp_exhaustion_values,
+  },
 };
 static const size_t num_base_metrics = ARRAY_LENGTH(base_metrics);
 
@@ -103,6 +111,19 @@ handshake_type_to_str(const uint16_t type)
   }
 }
 
+/** Fill function for the RELAY_METRICS_NUM_DNS metrics. */
+static void
+fill_tcp_exhaustion_values(void)
+{
+  metrics_store_entry_t *sentry;
+  const relay_metrics_entry_t *rentry =
+    &base_metrics[RELAY_METRICS_NUM_TCP_EXHAUSTION];
+
+  sentry = metrics_store_add(the_store, rentry->type, rentry->name,
+                             rentry->help);
+  metrics_store_entry_update(sentry, rep_hist_get_n_tcp_exhaustion());
+}
+
 /** Helper array containing mapping for the name of the different DNS records
  * and their corresponding libevent values. */
 static struct dns_type {
diff --git a/src/feature/relay/relay_metrics.h b/src/feature/relay/relay_metrics.h
index 67f58f6029..00dfeaa624 100644
--- a/src/feature/relay/relay_metrics.h
+++ b/src/feature/relay/relay_metrics.h
@@ -27,6 +27,8 @@ typedef enum {
   RELAY_METRICS_NUM_DNS        = 4,
   /** Number of DNS query errors. */
   RELAY_METRICS_NUM_DNS_ERRORS = 5,
+  /** Number of TCP exhaustion reached. */
+  RELAY_METRICS_NUM_TCP_EXHAUSTION = 6,
 } relay_metrics_key_t;
 
 /** The metadata of a relay metric. */
diff --git a/src/feature/stats/rephist.c b/src/feature/stats/rephist.c
index 7481b2f0a8..01fa644b9e 100644
--- a/src/feature/stats/rephist.c
+++ b/src/feature/stats/rephist.c
@@ -214,6 +214,9 @@ static overload_stats_t overload_stats;
 static uint64_t stats_n_read_limit_reached = 0;
 static uint64_t stats_n_write_limit_reached = 0;
 
+/** Total number of times we've reached TCP port exhaustion. */
+static uint64_t stats_n_tcp_exhaustion = 0;
+
 /***** DNS statistics *****/
 
 /** Represents the statistics of DNS queries seen if it is an Exit. */
@@ -512,6 +515,22 @@ rep_hist_note_overload(overload_type_t overload)
   }
 }
 
+/** Note down that we've reached a TCP port exhaustion. This triggers an
+ * overload general event. */
+void
+rep_hist_note_tcp_exhaustion(void)
+{
+  stats_n_tcp_exhaustion++;
+  rep_hist_note_overload(OVERLOAD_GENERAL);
+}
+
+/** Return the total number of TCP exhaustion times we've reached. */
+uint64_t
+rep_hist_get_n_tcp_exhaustion(void)
+{
+  return stats_n_tcp_exhaustion;
+}
+
 /** Return the or_history_t for the OR with identity digest <b>id</b>,
  * creating it if necessary. */
 static or_history_t *
diff --git a/src/feature/stats/rephist.h b/src/feature/stats/rephist.h
index 9d2e457b4b..ca305dfd8d 100644
--- a/src/feature/stats/rephist.h
+++ b/src/feature/stats/rephist.h
@@ -167,6 +167,9 @@ void rep_hist_note_overload(overload_type_t overload);
 char *rep_hist_get_overload_general_line(void);
 char *rep_hist_get_overload_stats_lines(void);
 
+void rep_hist_note_tcp_exhaustion(void);
+uint64_t rep_hist_get_n_tcp_exhaustion(void);
+
 uint64_t rep_hist_get_n_read_limit_reached(void);
 uint64_t rep_hist_get_n_write_limit_reached(void);
 
-- 
cgit v1.2.3-54-g00ecf