mirror of
https://github.com/redis/redis.git
synced 2026-02-11 14:53:19 -05:00
54038811c0
If `hide-user-data-from-log` config is enabled, we don't print client argv in the crashlog to avoid leaking user info. Though, debugging a crash becomes harder as we don't see the command arguments causing the crash. With this PR, we'll be printing command tokens to the log. As we have command tokens defined in json schema for each command, using this data, we can find tokens in the client argv. e.g. `SET key value GET EX 10` ---> we'll print `SET * * GET EX *` in the log. Modules should introduce their command structure via `RM_SetCommandInfo()`. Then, on a crash we'll able to know module command tokens.
129 lines
6.5 KiB
Tcl
129 lines
6.5 KiB
Tcl
# This file is used to test certain crash edge cases to make sure they produce
|
|
# correct stack traces for debugging.
|
|
set testmodule [file normalize tests/modules/crash.so]
|
|
set backtrace_supported [system_backtrace_supported]
|
|
|
|
# Valgrind will complain that the process terminated by a signal, skip it.
|
|
if {!$::valgrind} {
|
|
start_server {tags {"modules"}} {
|
|
r module load $testmodule assert
|
|
test {Test module crash when info crashes with an assertion } {
|
|
catch {r 0 info modulecrash}
|
|
set res [wait_for_log_messages 0 {"*=== REDIS BUG REPORT START: Cut & paste starting from here ===*"} 0 10 1000]
|
|
set loglines [lindex $res 1]
|
|
|
|
set res [wait_for_log_messages 0 {"*ASSERTION FAILED*"} $loglines 10 1000]
|
|
set loglines [lindex $res 1]
|
|
|
|
set res [wait_for_log_messages 0 {"*RECURSIVE ASSERTION FAILED*"} $loglines 10 1000]
|
|
set loglines [lindex $res 1]
|
|
|
|
wait_for_log_messages 0 {"*=== REDIS BUG REPORT END. Make sure to include from START to END. ===*"} $loglines 10 1000
|
|
assert_equal 1 [count_log_message 0 "=== REDIS BUG REPORT END. Make sure to include from START to END. ==="]
|
|
assert_equal 2 [count_log_message 0 "ASSERTION FAILED"]
|
|
if {$backtrace_supported} {
|
|
# Make sure the crash trace is printed twice. There will be 3 instances of,
|
|
# assertCrash 1 in the first stack trace and 2 in the second.
|
|
assert_equal 3 [count_log_message 0 "assertCrash"]
|
|
}
|
|
assert_equal 1 [count_log_message 0 "RECURSIVE ASSERTION FAILED"]
|
|
assert_equal 1 [count_log_message 0 "=== REDIS BUG REPORT START: Cut & paste starting from here ==="]
|
|
}
|
|
}
|
|
|
|
start_server {tags {"modules"}} {
|
|
r module load $testmodule segfault
|
|
test {Test module crash when info crashes with a segfault} {
|
|
catch {r 0 info modulecrash}
|
|
set res [wait_for_log_messages 0 {"*=== REDIS BUG REPORT START: Cut & paste starting from here ===*"} 0 10 1000]
|
|
set loglines [lindex $res 1]
|
|
|
|
if {$backtrace_supported} {
|
|
set res [wait_for_log_messages 0 {"*Crashed running the instruction at*"} $loglines 10 1000]
|
|
set loglines [lindex $res 1]
|
|
|
|
set res [wait_for_log_messages 0 {"*Crashed running signal handler. Providing reduced version of recursive crash report*"} $loglines 10 1000]
|
|
set loglines [lindex $res 1]
|
|
set res [wait_for_log_messages 0 {"*Crashed running the instruction at*"} $loglines 10 1000]
|
|
set loglines [lindex $res 1]
|
|
}
|
|
|
|
wait_for_log_messages 0 {"*=== REDIS BUG REPORT END. Make sure to include from START to END. ===*"} $loglines 10 1000
|
|
assert_equal 1 [count_log_message 0 "=== REDIS BUG REPORT END. Make sure to include from START to END. ==="]
|
|
assert_equal 1 [count_log_message 0 "Crashed running signal handler. Providing reduced version of recursive crash report"]
|
|
if {$backtrace_supported} {
|
|
assert_equal 2 [count_log_message 0 "Crashed running the instruction at"]
|
|
# Make sure the crash trace is printed twice. There will be 3 instances of
|
|
# modulesCollectInfo, 1 in the first stack trace and 2 in the second.
|
|
assert_equal 3 [count_log_message 0 "modulesCollectInfo"]
|
|
}
|
|
assert_equal 1 [count_log_message 0 "=== REDIS BUG REPORT START: Cut & paste starting from here ==="]
|
|
}
|
|
}
|
|
|
|
start_server {tags {"modules"}} {
|
|
r module load $testmodule
|
|
|
|
# memcheck confuses sanitizer
|
|
r config set crash-memcheck-enabled no
|
|
|
|
test {Test command tokens are printed when hide-user-data-from-log is enabled (xadd)} {
|
|
r config set hide-user-data-from-log yes
|
|
catch {r 0 modulecrash.xadd key NOMKSTREAM MAXLEN ~ 1000 * a b}
|
|
|
|
wait_for_log_messages 0 {"*argv*0*: *modulecrash.xadd*"} 0 10 1000
|
|
wait_for_log_messages 0 {"*argv*1*: *redacted*"} 0 10 1000
|
|
wait_for_log_messages 0 {"*argv*2*: *NOMKSTREAM*"} 0 10 1000
|
|
wait_for_log_messages 0 {"*argv*3*: *MAXLEN*"} 0 10 1000
|
|
wait_for_log_messages 0 {"*argv*4*: *~*"} 0 10 1000
|
|
wait_for_log_messages 0 {"*argv*5*: *redacted*"} 0 10 1000
|
|
wait_for_log_messages 0 {"*argv*6*: *\**"} 0 10 1000
|
|
wait_for_log_messages 0 {"*argv*7*: *redacted*"} 0 10 1000
|
|
wait_for_log_messages 0 {"*argv*8*: *redacted*"} 0 10 1000
|
|
}
|
|
}
|
|
|
|
start_server {tags {"modules"}} {
|
|
r module load $testmodule
|
|
|
|
# memcheck confuses sanitizer
|
|
r config set crash-memcheck-enabled no
|
|
|
|
test {Test command tokens are printed when hide-user-data-from-log is enabled (zunion)} {
|
|
r config set hide-user-data-from-log yes
|
|
catch {r 0 modulecrash.zunion 2 zset1 zset2 WEIGHTS 1 2 WITHSCORES somedata}
|
|
|
|
wait_for_log_messages 0 {"*argv*0*: *modulecrash.zunion*"} 0 10 1000
|
|
wait_for_log_messages 0 {"*argv*1*: *redacted*"} 0 10 1000
|
|
wait_for_log_messages 0 {"*argv*2*: *redacted*"} 0 10 1000
|
|
wait_for_log_messages 0 {"*argv*3*: *redacted*"} 0 10 1000
|
|
wait_for_log_messages 0 {"*argv*4*: *WEIGHTS*"} 0 10 1000
|
|
wait_for_log_messages 0 {"*argv*5*: *redacted*"} 0 10 1000
|
|
wait_for_log_messages 0 {"*argv*6*: *redacted*"} 0 10 1000
|
|
wait_for_log_messages 0 {"*argv*7*: *WITHSCORES*"} 0 10 1000
|
|
|
|
# We don't expect arguments after WITHSCORE but just in case there
|
|
# is we rather not print it
|
|
wait_for_log_messages 0 {"*argv*8*: *redacted*"} 0 10 1000
|
|
}
|
|
}
|
|
|
|
start_server {tags {"modules"}} {
|
|
r module load $testmodule
|
|
|
|
# memcheck confuses sanitizer
|
|
r config set crash-memcheck-enabled no
|
|
|
|
test {Test subcommand name is printed when hide-user-data-from-log is enabled} {
|
|
r config set hide-user-data-from-log yes
|
|
catch {r 0 modulecrash.parent subcmd key TOKEN a b}
|
|
|
|
wait_for_log_messages 0 {"*argv*0*: *modulecrash.parent*"} 0 10 1000
|
|
wait_for_log_messages 0 {"*argv*1*: *subcmd*"} 0 10 1000
|
|
wait_for_log_messages 0 {"*argv*2*: *redacted*"} 0 10 1000
|
|
wait_for_log_messages 0 {"*argv*3*: *TOKEN*"} 0 10 1000
|
|
wait_for_log_messages 0 {"*argv*4*: *redacted*"} 0 10 1000
|
|
wait_for_log_messages 0 {"*argv*5*: *redacted*"} 0 10 1000
|
|
}
|
|
}
|
|
}
|