drivers/main.c, conf/ups.conf.sample, docs/man/ups.conf.txt: Introduce reconnect_report_freq to manage verbosity of on-going reconnect_trying() streak [#3541]

Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>

Author: jimklimov

conf/ups.conf.sample

@@ -124,6 +124,13 @@ maxretry = 3
 #              indefinitely (e.g. data cable fell out, or the data path
 #              to a networked UPS was lost for a significant time).
 #
+# reconnect_report_freq: OPTIONAL.  This can be set as a global variable
+#              above your first UPS definition and it can also be set in a
+#              UPS section, and used in conjunction with reconnect_max_tries
+#              to report progress (and on-going lack of success) every N
+#              attempts, to avoid flooding the logs.  A non-positive value
+#              disables such updates completely (default).
+#
 #   debug_min: OPTIONAL.  Specify a minimum debug level for all driver daemons
 #              and for the upsdrvctl tool (when specified at global level),
 #              or for this driver daemon (when specified in a driver section),

docs/man/ups.conf.txt

@@ -113,6 +113,14 @@ A negative value (default) means to try reconnecting indefinitely (e.g. data
 cable fell out, or the data path to a networked UPS was lost for a significant
 time).
 
+*reconnect_report_freq*::
+
+Optional.  This can be used in conjunction with `reconnect_max_tries` to
+report progress (and on-going lack of success) every `N` attempts, to avoid
+flooding the logs.
++
+A non-positive value disables such updates completely (default).
+
 *maxstartdelay*::
 
 Optional.  Same as the UPS field of the same name, but this is the
@@ -358,6 +366,11 @@ Optional.  This can be set as a global variable above your first UPS
 definition and it can also be set in a UPS section.  See explanation
 above, in the global section.
 
+*reconnect_report_freq*::
+Optional.  This can be set as a global variable above your first UPS
+definition and it can also be set in a UPS section.  See explanation
+above, in the global section.
+
 *maxretry*::
 Optional.  This can be set as a global variable above your first UPS
 definition and it can also be set in a UPS section.  See explanation

drivers/main.c

@@ -102,7 +102,7 @@ vartab_t	*vartab_h = NULL;
 time_t	poll_interval = 2;
 static char	*chroot_path = NULL, *user = NULL, *group = NULL;
 static int	user_from_cmdline = 0, group_from_cmdline = 0,
-		reconnect_max_tries = -1, reconnect_count = 0;
+		reconnect_max_tries = -1, reconnect_count = 0, reconnect_report_freq = -1;
 
 /* signal handling */
 int	exit_flag = 0;
@@ -1410,6 +1410,15 @@ static int main_arg(char *var, char *val)
 		}
 	}
 
+	if (!strcmp(var, "reconnect_report_freq")) {
+		int	intval = -1;
+		if ( str_to_int (val, &intval, 10) ) {
+			reconnect_report_freq = intval;
+		} else {
+			upslogx(LOG_INFO, "WARNING : Invalid reconnect_report_freq value found in ups.conf global settings");
+		}
+	}
+
 	/* only for upsdrvctl - ignored here */
 	if (!strcmp(var, "sdorder"))
 		return 1;	/* handled */
@@ -1596,6 +1605,17 @@ static void do_global_args(const char *var, const char *val)
 		return;
 	}
 
+	if (!strcmp(var, "reconnect_report_freq")) {
+		int	intval = -1;
+		if ( str_to_int (val, &intval, 10) ) {
+			reconnect_report_freq = intval;
+		} else {
+			upslogx(LOG_INFO, "WARNING : Invalid reconnect_report_freq value found in ups.conf global settings");
+		}
+
+		return;
+	}
+
 	/* Allow to specify its minimal debugging level for all drivers -
 	 * admins can set more with command-line args, but can't set
 	 * less without changing config. Should help debug of services.
@@ -2260,6 +2280,10 @@ int reconnect_trying(reconnect_state_t trying) {
 						"max %d attempts, then will exit",
 						upsname, reconnect_max_tries);
 				}
+			} else if (reconnect_report_freq > 0 && (reconnect_count % reconnect_report_freq) == 0) {
+				upslogx(LOG_WARNING, "Driver still reconnecting "
+					"to the device [%s] for %d attempts",
+					upsname, reconnect_count);
 			}
 
 			if (reconnect_count < INT_MAX) {