[tor-commits] [tor/master] relay: Log if we can't find an address for configured ORPort

[nickm at torproject.org]

commit f03047332ceaa465a13fac3ff3de6378f4f2794a
Author: David Goulet <dgoulet at torproject.org>
Date:   Fri Jan 22 10:59:05 2021 -0500

    relay: Log if we can't find an address for configured ORPort
    
    Everytime we try to discover an address we want to publish, emit a log notice
    if we are unable to find it even though an ORPort was configured for it.
    
    Because the function can be called quite often, we rate limit that notice to
    every hour so it gets annoying just enough so the operator fixes that.
    
    Related to #40254
    
    Signed-off-by: David Goulet <dgoulet at torproject.org>
---
 src/feature/relay/relay_find_addr.c | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/src/feature/relay/relay_find_addr.c b/src/feature/relay/relay_find_addr.c
index e942a8fa77..39e1cc6a19 100644
--- a/src/feature/relay/relay_find_addr.c
+++ b/src/feature/relay/relay_find_addr.c
@@ -144,6 +144,17 @@ relay_find_addr_to_publish, (const or_options_t *options, int family,
     if (find_my_address(options, family, LOG_INFO, addr_out, NULL, NULL)) {
       goto found;
     }
+    /* No publishable address was found even though we have an ORPort thus
+     * print a notice log so operator can notice. We'll do that every hour so
+     * it is not too spammy but enough so operators address the issue. */
+    static ratelim_t rlim = RATELIM_INIT(3600);
+    log_fn_ratelim(&rlim, LOG_NOTICE, LD_CONFIG,
+                   "Unable to find %s address for ORPort %u. "
+                   "You might want to specify %sOnly to it or set an "
+                   "explicit address or set Address.",
+                   fmt_af_family(family),
+                   routerconf_find_or_port(options, family),
+                   fmt_af_family(family));
   }
 
   /* Third, consider address from our suggestion cache. */