From f8b26182a9282d91f0528caa43d07689a17c08c5 Mon Sep 17 00:00:00 2001 From: Johannes Truschnigg Date: Wed, 16 Mar 2022 22:29:02 +0100 Subject: [PATCH] Document config vars --- lagdetect.sh | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/lagdetect.sh b/lagdetect.sh index f53efd0..840d40e 100755 --- a/lagdetect.sh +++ b/lagdetect.sh @@ -1,17 +1,21 @@ #!/bin/sh -THRESHOLD=1.2 -FUDGE_MS=17.0 -PING_PEERS='1.1.1.1 8.8.8.8' -PING_GW_IPV4=no -PING_GW_IPV6=no -PING_SLOTS_PER_PEER=5 -PING_INTERVAL=300 -STATS_RX='/sys/class/net/eth1/statistics/rx_bytes' -IFACE_RX='eth1' -STATS_TX='/sys/class/net/eth1/statistics/tx_bytes' -IFACE_TX='eth1' -BW_MIN_RX=10000 #Kbps -BW_MAX_RX=30000 #Kbps + +# CONFIGURATION - adapt these variables to yor needs. +# These will be docmented once this is finished - promise ;) + +FUDGE_MS=20.0 # "fudge" factor in msec that yor PING_PEERS are expected to fluctuate in latency under normal conditions +THRESHOLD=1.2 # factor relevant in judging crrent latency compared to avg. - leave it at 1.2 +PING_PEERS='1.1.1.1 8.8.8.8' # space-separated list of peer addresses to ping +PING_GW_IPV4=no # do not use - broken +PING_GW_IPV6=no # do not use - broken +PING_SLOTS_PER_PEER=5 # number of samples per PING_PEER to collet averages over +PING_INTERVAL=300 # interval in msec to emit ICMP ECHO towards each PING_PEER +STATS_RX='/sys/class/net/eth1/statistics/rx_bytes' # downstream bandwidth accounting file for your SQM'd interface +IFACE_RX='eth1' # interface to apply downstream SQM to +STATS_TX='/sys/class/net/eth1/statistics/tx_bytes' # upstream bandwidth accounting file for your SQM'd interface (presently not used) +IFACE_TX='eth1' # interface to apply downstream SQM to (presently not used) +BW_MIN_RX=10000 # your min. acceptable downstream bandwidth to shape to in Kbps +BW_MAX_RX=30000 # your max. desired downstream bandwidth to shape to in Kbps -- 2.39.5