2020-12-31 09:53:43 -05:00
|
|
|
proc cmdstat {cmd} {
|
|
|
|
return [cmdrstat $cmd r]
|
|
|
|
}
|
|
|
|
|
|
|
|
proc errorstat {cmd} {
|
|
|
|
return [errorrstat $cmd r]
|
|
|
|
}
|
|
|
|
|
2021-06-09 08:13:24 -04:00
|
|
|
start_server {tags {"info" "external:skip"}} {
|
2020-12-31 09:53:43 -05:00
|
|
|
start_server {} {
|
|
|
|
|
|
|
|
test {errorstats: failed call authentication error} {
|
|
|
|
r config resetstat
|
|
|
|
assert_match {} [errorstat ERR]
|
|
|
|
assert_equal [s total_error_replies] 0
|
|
|
|
catch {r auth k} e
|
|
|
|
assert_match {ERR AUTH*} $e
|
|
|
|
assert_match {*count=1*} [errorstat ERR]
|
|
|
|
assert_match {*calls=1,*,rejected_calls=0,failed_calls=1} [cmdstat auth]
|
|
|
|
assert_equal [s total_error_replies] 1
|
|
|
|
r config resetstat
|
|
|
|
assert_match {} [errorstat ERR]
|
|
|
|
}
|
|
|
|
|
|
|
|
test {errorstats: failed call within MULTI/EXEC} {
|
|
|
|
r config resetstat
|
|
|
|
assert_match {} [errorstat ERR]
|
|
|
|
assert_equal [s total_error_replies] 0
|
|
|
|
r multi
|
|
|
|
r set a b
|
|
|
|
r auth a
|
|
|
|
catch {r exec} e
|
|
|
|
assert_match {ERR AUTH*} $e
|
|
|
|
assert_match {*count=1*} [errorstat ERR]
|
|
|
|
assert_match {*calls=1,*,rejected_calls=0,failed_calls=0} [cmdstat set]
|
|
|
|
assert_match {*calls=1,*,rejected_calls=0,failed_calls=1} [cmdstat auth]
|
|
|
|
assert_match {*calls=1,*,rejected_calls=0,failed_calls=0} [cmdstat exec]
|
|
|
|
assert_equal [s total_error_replies] 1
|
|
|
|
|
|
|
|
# MULTI/EXEC command errors should still be pinpointed to him
|
|
|
|
catch {r exec} e
|
|
|
|
assert_match {ERR EXEC without MULTI} $e
|
|
|
|
assert_match {*calls=2,*,rejected_calls=0,failed_calls=1} [cmdstat exec]
|
|
|
|
assert_match {*count=2*} [errorstat ERR]
|
|
|
|
assert_equal [s total_error_replies] 2
|
|
|
|
}
|
|
|
|
|
|
|
|
test {errorstats: failed call within LUA} {
|
|
|
|
r config resetstat
|
|
|
|
assert_match {} [errorstat ERR]
|
|
|
|
assert_equal [s total_error_replies] 0
|
|
|
|
catch {r eval {redis.pcall('XGROUP', 'CREATECONSUMER', 's1', 'mygroup', 'consumer') return } 0} e
|
|
|
|
assert_match {*count=1*} [errorstat ERR]
|
Treat subcommands as commands (#9504)
## Intro
The purpose is to allow having different flags/ACL categories for
subcommands (Example: CONFIG GET is ok-loading but CONFIG SET isn't)
We create a small command table for every command that has subcommands
and each subcommand has its own flags, etc. (same as a "regular" command)
This commit also unites the Redis and the Sentinel command tables
## Affected commands
CONFIG
Used to have "admin ok-loading ok-stale no-script"
Changes:
1. Dropped "ok-loading" in all except GET (this doesn't change behavior since
there were checks in the code doing that)
XINFO
Used to have "read-only random"
Changes:
1. Dropped "random" in all except CONSUMERS
XGROUP
Used to have "write use-memory"
Changes:
1. Dropped "use-memory" in all except CREATE and CREATECONSUMER
COMMAND
No changes.
MEMORY
Used to have "random read-only"
Changes:
1. Dropped "random" in PURGE and USAGE
ACL
Used to have "admin no-script ok-loading ok-stale"
Changes:
1. Dropped "admin" in WHOAMI, GENPASS, and CAT
LATENCY
No changes.
MODULE
No changes.
SLOWLOG
Used to have "admin random ok-loading ok-stale"
Changes:
1. Dropped "random" in RESET
OBJECT
Used to have "read-only random"
Changes:
1. Dropped "random" in ENCODING and REFCOUNT
SCRIPT
Used to have "may-replicate no-script"
Changes:
1. Dropped "may-replicate" in all except FLUSH and LOAD
CLIENT
Used to have "admin no-script random ok-loading ok-stale"
Changes:
1. Dropped "random" in all except INFO and LIST
2. Dropped "admin" in ID, TRACKING, CACHING, GETREDIR, INFO, SETNAME, GETNAME, and REPLY
STRALGO
No changes.
PUBSUB
No changes.
CLUSTER
Changes:
1. Dropped "admin in countkeysinslots, getkeysinslot, info, nodes, keyslot, myid, and slots
SENTINEL
No changes.
(note that DEBUG also fits, but we decided not to convert it since it's for
debugging and anyway undocumented)
## New sub-command
This commit adds another element to the per-command output of COMMAND,
describing the list of subcommands, if any (in the same structure as "regular" commands)
Also, it adds a new subcommand:
```
COMMAND LIST [FILTERBY (MODULE <module-name>|ACLCAT <cat>|PATTERN <pattern>)]
```
which returns a set of all commands (unless filters), but excluding subcommands.
## Module API
A new module API, RM_CreateSubcommand, was added, in order to allow
module writer to define subcommands
## ACL changes:
1. Now, that each subcommand is actually a command, each has its own ACL id.
2. The old mechanism of allowed_subcommands is redundant
(blocking/allowing a subcommand is the same as blocking/allowing a regular command),
but we had to keep it, to support the widespread usage of allowed_subcommands
to block commands with certain args, that aren't subcommands (e.g. "-select +select|0").
3. I have renamed allowed_subcommands to allowed_firstargs to emphasize the difference.
4. Because subcommands are commands in ACL too, you can now use "-" to block subcommands
(e.g. "+client -client|kill"), which wasn't possible in the past.
5. It is also possible to use the allowed_firstargs mechanism with subcommand.
For example: `+config -config|set +config|set|loglevel` will block all CONFIG SET except
for setting the log level.
6. All of the ACL changes above required some amount of refactoring.
## Misc
1. There are two approaches: Either each subcommand has its own function or all
subcommands use the same function, determining what to do according to argv[0].
For now, I took the former approaches only with CONFIG and COMMAND,
while other commands use the latter approach (for smaller blamelog diff).
2. Deleted memoryGetKeys: It is no longer needed because MEMORY USAGE now uses the "range" key spec.
4. Bugfix: GETNAME was missing from CLIENT's help message.
5. Sentinel and Redis now use the same table, with the same function pointer.
Some commands have a different implementation in Sentinel, so we redirect
them (these are ROLE, PUBLISH, and INFO).
6. Command stats now show the stats per subcommand (e.g. instead of stats just
for "config" you will have stats for "config|set", "config|get", etc.)
7. It is now possible to use COMMAND directly on subcommands:
COMMAND INFO CONFIG|GET (The pipeline syntax was inspired from ACL, and
can be used in functions lookupCommandBySds and lookupCommandByCString)
8. STRALGO is now a container command (has "help")
## Breaking changes:
1. Command stats now show the stats per subcommand (see (5) above)
2021-10-20 04:52:57 -04:00
|
|
|
assert_match {*calls=1,*,rejected_calls=0,failed_calls=1} [cmdstat xgroup\\|createconsumer]
|
2020-12-31 09:53:43 -05:00
|
|
|
assert_match {*calls=1,*,rejected_calls=0,failed_calls=0} [cmdstat eval]
|
|
|
|
|
|
|
|
# EVAL command errors should still be pinpointed to him
|
|
|
|
catch {r eval a} e
|
|
|
|
assert_match {ERR wrong*} $e
|
|
|
|
assert_match {*calls=1,*,rejected_calls=1,failed_calls=0} [cmdstat eval]
|
|
|
|
assert_match {*count=2*} [errorstat ERR]
|
|
|
|
assert_equal [s total_error_replies] 2
|
|
|
|
}
|
|
|
|
|
2021-02-24 11:45:13 -05:00
|
|
|
test {errorstats: failed call NOSCRIPT error} {
|
|
|
|
r config resetstat
|
|
|
|
assert_equal [s total_error_replies] 0
|
|
|
|
assert_match {} [errorstat NOSCRIPT]
|
|
|
|
catch {r evalsha NotValidShaSUM 0} e
|
|
|
|
assert_match {NOSCRIPT*} $e
|
|
|
|
assert_match {*count=1*} [errorstat NOSCRIPT]
|
|
|
|
assert_match {*calls=1,*,rejected_calls=0,failed_calls=1} [cmdstat evalsha]
|
|
|
|
assert_equal [s total_error_replies] 1
|
|
|
|
r config resetstat
|
|
|
|
assert_match {} [errorstat NOSCRIPT]
|
|
|
|
}
|
|
|
|
|
2020-12-31 09:53:43 -05:00
|
|
|
test {errorstats: failed call NOGROUP error} {
|
|
|
|
r config resetstat
|
|
|
|
assert_match {} [errorstat NOGROUP]
|
|
|
|
r del mystream
|
|
|
|
r XADD mystream * f v
|
|
|
|
catch {r XGROUP CREATECONSUMER mystream mygroup consumer} e
|
|
|
|
assert_match {NOGROUP*} $e
|
|
|
|
assert_match {*count=1*} [errorstat NOGROUP]
|
Treat subcommands as commands (#9504)
## Intro
The purpose is to allow having different flags/ACL categories for
subcommands (Example: CONFIG GET is ok-loading but CONFIG SET isn't)
We create a small command table for every command that has subcommands
and each subcommand has its own flags, etc. (same as a "regular" command)
This commit also unites the Redis and the Sentinel command tables
## Affected commands
CONFIG
Used to have "admin ok-loading ok-stale no-script"
Changes:
1. Dropped "ok-loading" in all except GET (this doesn't change behavior since
there were checks in the code doing that)
XINFO
Used to have "read-only random"
Changes:
1. Dropped "random" in all except CONSUMERS
XGROUP
Used to have "write use-memory"
Changes:
1. Dropped "use-memory" in all except CREATE and CREATECONSUMER
COMMAND
No changes.
MEMORY
Used to have "random read-only"
Changes:
1. Dropped "random" in PURGE and USAGE
ACL
Used to have "admin no-script ok-loading ok-stale"
Changes:
1. Dropped "admin" in WHOAMI, GENPASS, and CAT
LATENCY
No changes.
MODULE
No changes.
SLOWLOG
Used to have "admin random ok-loading ok-stale"
Changes:
1. Dropped "random" in RESET
OBJECT
Used to have "read-only random"
Changes:
1. Dropped "random" in ENCODING and REFCOUNT
SCRIPT
Used to have "may-replicate no-script"
Changes:
1. Dropped "may-replicate" in all except FLUSH and LOAD
CLIENT
Used to have "admin no-script random ok-loading ok-stale"
Changes:
1. Dropped "random" in all except INFO and LIST
2. Dropped "admin" in ID, TRACKING, CACHING, GETREDIR, INFO, SETNAME, GETNAME, and REPLY
STRALGO
No changes.
PUBSUB
No changes.
CLUSTER
Changes:
1. Dropped "admin in countkeysinslots, getkeysinslot, info, nodes, keyslot, myid, and slots
SENTINEL
No changes.
(note that DEBUG also fits, but we decided not to convert it since it's for
debugging and anyway undocumented)
## New sub-command
This commit adds another element to the per-command output of COMMAND,
describing the list of subcommands, if any (in the same structure as "regular" commands)
Also, it adds a new subcommand:
```
COMMAND LIST [FILTERBY (MODULE <module-name>|ACLCAT <cat>|PATTERN <pattern>)]
```
which returns a set of all commands (unless filters), but excluding subcommands.
## Module API
A new module API, RM_CreateSubcommand, was added, in order to allow
module writer to define subcommands
## ACL changes:
1. Now, that each subcommand is actually a command, each has its own ACL id.
2. The old mechanism of allowed_subcommands is redundant
(blocking/allowing a subcommand is the same as blocking/allowing a regular command),
but we had to keep it, to support the widespread usage of allowed_subcommands
to block commands with certain args, that aren't subcommands (e.g. "-select +select|0").
3. I have renamed allowed_subcommands to allowed_firstargs to emphasize the difference.
4. Because subcommands are commands in ACL too, you can now use "-" to block subcommands
(e.g. "+client -client|kill"), which wasn't possible in the past.
5. It is also possible to use the allowed_firstargs mechanism with subcommand.
For example: `+config -config|set +config|set|loglevel` will block all CONFIG SET except
for setting the log level.
6. All of the ACL changes above required some amount of refactoring.
## Misc
1. There are two approaches: Either each subcommand has its own function or all
subcommands use the same function, determining what to do according to argv[0].
For now, I took the former approaches only with CONFIG and COMMAND,
while other commands use the latter approach (for smaller blamelog diff).
2. Deleted memoryGetKeys: It is no longer needed because MEMORY USAGE now uses the "range" key spec.
4. Bugfix: GETNAME was missing from CLIENT's help message.
5. Sentinel and Redis now use the same table, with the same function pointer.
Some commands have a different implementation in Sentinel, so we redirect
them (these are ROLE, PUBLISH, and INFO).
6. Command stats now show the stats per subcommand (e.g. instead of stats just
for "config" you will have stats for "config|set", "config|get", etc.)
7. It is now possible to use COMMAND directly on subcommands:
COMMAND INFO CONFIG|GET (The pipeline syntax was inspired from ACL, and
can be used in functions lookupCommandBySds and lookupCommandByCString)
8. STRALGO is now a container command (has "help")
## Breaking changes:
1. Command stats now show the stats per subcommand (see (5) above)
2021-10-20 04:52:57 -04:00
|
|
|
assert_match {*calls=1,*,rejected_calls=0,failed_calls=1} [cmdstat xgroup\\|createconsumer]
|
2020-12-31 09:53:43 -05:00
|
|
|
r config resetstat
|
|
|
|
assert_match {} [errorstat NOGROUP]
|
|
|
|
}
|
|
|
|
|
|
|
|
test {errorstats: rejected call unknown command} {
|
|
|
|
r config resetstat
|
|
|
|
assert_equal [s total_error_replies] 0
|
|
|
|
assert_match {} [errorstat ERR]
|
|
|
|
catch {r asdf} e
|
|
|
|
assert_match {ERR unknown*} $e
|
|
|
|
assert_match {*count=1*} [errorstat ERR]
|
|
|
|
assert_equal [s total_error_replies] 1
|
|
|
|
r config resetstat
|
|
|
|
assert_match {} [errorstat ERR]
|
|
|
|
}
|
|
|
|
|
|
|
|
test {errorstats: rejected call within MULTI/EXEC} {
|
|
|
|
r config resetstat
|
|
|
|
assert_equal [s total_error_replies] 0
|
|
|
|
assert_match {} [errorstat ERR]
|
|
|
|
r multi
|
|
|
|
catch {r set} e
|
|
|
|
assert_match {ERR wrong number of arguments*} $e
|
|
|
|
catch {r exec} e
|
|
|
|
assert_match {EXECABORT*} $e
|
|
|
|
assert_match {*count=1*} [errorstat ERR]
|
2021-08-06 22:27:24 -04:00
|
|
|
assert_match {*count=1*} [errorstat EXECABORT]
|
|
|
|
assert_equal [s total_error_replies] 2
|
2020-12-31 09:53:43 -05:00
|
|
|
assert_match {*calls=0,*,rejected_calls=1,failed_calls=0} [cmdstat set]
|
|
|
|
assert_match {*calls=1,*,rejected_calls=0,failed_calls=0} [cmdstat multi]
|
2021-08-06 22:27:24 -04:00
|
|
|
assert_match {*calls=1,*,rejected_calls=0,failed_calls=1} [cmdstat exec]
|
|
|
|
assert_equal [s total_error_replies] 2
|
2020-12-31 09:53:43 -05:00
|
|
|
r config resetstat
|
|
|
|
assert_match {} [errorstat ERR]
|
|
|
|
}
|
|
|
|
|
|
|
|
test {errorstats: rejected call due to wrong arity} {
|
|
|
|
r config resetstat
|
|
|
|
assert_equal [s total_error_replies] 0
|
|
|
|
assert_match {} [errorstat ERR]
|
|
|
|
catch {r set k} e
|
|
|
|
assert_match {ERR wrong number of arguments*} $e
|
|
|
|
assert_match {*count=1*} [errorstat ERR]
|
|
|
|
assert_match {*calls=0,*,rejected_calls=1,failed_calls=0} [cmdstat set]
|
|
|
|
# ensure that after a rejected command, valid ones are counted properly
|
|
|
|
r set k1 v1
|
|
|
|
r set k2 v2
|
|
|
|
assert_match {calls=2,*,rejected_calls=1,failed_calls=0} [cmdstat set]
|
|
|
|
assert_equal [s total_error_replies] 1
|
|
|
|
}
|
|
|
|
|
|
|
|
test {errorstats: rejected call by OOM error} {
|
|
|
|
r config resetstat
|
|
|
|
assert_equal [s total_error_replies] 0
|
|
|
|
assert_match {} [errorstat OOM]
|
|
|
|
r config set maxmemory 1
|
|
|
|
catch {r set a b} e
|
|
|
|
assert_match {OOM*} $e
|
|
|
|
assert_match {*count=1*} [errorstat OOM]
|
|
|
|
assert_match {*calls=0,*,rejected_calls=1,failed_calls=0} [cmdstat set]
|
|
|
|
assert_equal [s total_error_replies] 1
|
|
|
|
r config resetstat
|
|
|
|
assert_match {} [errorstat OOM]
|
|
|
|
}
|
|
|
|
|
|
|
|
test {errorstats: rejected call by authorization error} {
|
|
|
|
r config resetstat
|
|
|
|
assert_equal [s total_error_replies] 0
|
|
|
|
assert_match {} [errorstat NOPERM]
|
|
|
|
r ACL SETUSER alice on >p1pp0 ~cached:* +get +info +config
|
|
|
|
r auth alice p1pp0
|
|
|
|
catch {r set a b} e
|
|
|
|
assert_match {NOPERM*} $e
|
|
|
|
assert_match {*count=1*} [errorstat NOPERM]
|
|
|
|
assert_match {*calls=0,*,rejected_calls=1,failed_calls=0} [cmdstat set]
|
|
|
|
assert_equal [s total_error_replies] 1
|
|
|
|
r config resetstat
|
|
|
|
assert_match {} [errorstat NOPERM]
|
|
|
|
}
|
|
|
|
}
|
2021-02-15 10:08:53 -05:00
|
|
|
|
|
|
|
start_server {} {
|
|
|
|
test {Unsafe command names are sanitized in INFO output} {
|
|
|
|
catch {r host:} e
|
|
|
|
set info [r info commandstats]
|
|
|
|
assert_match {*cmdstat_host_:calls=1*} $info
|
|
|
|
}
|
|
|
|
}
|
2020-12-31 09:53:43 -05:00
|
|
|
}
|