Provide example when format string is rate limited

Here's an example log line in the new format:
    [RATE LIMITED] format string "open-conn-track: timeout opening %v; no associated peer node" (example: "open-conn-track: timeout opening ([ip] => [ip]); no associated peer node")
This should make debugging logging issues a bit easier, and give more
context as to why something was rate limited. This change was proposed
in a comment on #1110.

Signed-off-by: Smitty <me@smitop.com>
pull/1119/head
Smitty 4 years ago committed by Josh Bleecher Snyder
parent ce058c8280
commit 2bf49ddf90

@ -132,7 +132,7 @@ func RateLimitedFn(logf Logf, f time.Duration, burst int, maxCache int) Logf {
logf(format, args...) logf(format, args...)
case warn: case warn:
// For the warning, log the specific format string // For the warning, log the specific format string
logf("[RATE LIMITED] format string \"%s\"", format) logf("[RATE LIMITED] format string \"%s\" (example: \"%s\")", format, fmt.Sprintf(format, args...))
} }
} }
} }

@ -45,8 +45,8 @@ func TestRateLimiter(t *testing.T) {
"templated format string no. 0", "templated format string no. 0",
"boring string with constant formatting (constant)", "boring string with constant formatting (constant)",
"templated format string no. 1", "templated format string no. 1",
"[RATE LIMITED] format string \"boring string with constant formatting %s\"", "[RATE LIMITED] format string \"boring string with constant formatting %s\" (example: \"boring string with constant formatting (constant)\")",
"[RATE LIMITED] format string \"templated format string no. %d\"", "[RATE LIMITED] format string \"templated format string no. %d\" (example: \"templated format string no. 2\")",
"Make sure this string makes it through the rest (that are blocked) 4", "Make sure this string makes it through the rest (that are blocked) 4",
"4 shouldn't get filtered.", "4 shouldn't get filtered.",
} }

Loading…
Cancel
Save