Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions content/commands/cluster-slot-stats.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,14 @@ The command reports on the following statistics:

* `KEY-COUNT`: Number of keys stored in the slot.
* `CPU-USEC`: CPU time (in microseconds) spent handling the slot.
* `MEMORY-BYTES`: Number of bytes allocated by the slot.
* `NETWORK-BYTES-IN`: Total inbound network traffic (in bytes) received by the slot.
* `NETWORK-BYTES-OUT`: Total outbound network traffic (in bytes) sent from the slot.

{{< note>}}
`MEMORY-BYTES` requires that you set `cluster-slot-stats-enabled` to `yes` in your `redis.conf` file.
{{< /note >}}

## Redis Enterprise and Redis Cloud compatibility

| Redis<br />Enterprise | Redis<br />Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> |
Expand Down
127 changes: 127 additions & 0 deletions content/develop/tools/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ even on the terminal with the `--raw` option:
You can force human readable output when writing to a file or in
pipe to other commands by using `--no-raw`.

For complete command line usage, see [below](#usage).

## String quoting and escaping

When `redis-cli` parses a command, whitespace characters automatically delimit the arguments.
Expand Down Expand Up @@ -964,3 +966,128 @@ minutes the output stabilizes to the following figures:
140500 Gets/sec | Hits: 135947 (96.76%) | Misses: 4553 (3.24%)

With 500MB there is sufficient space for the key quantity (10 million) and distribution (80-20 style).

## Usage

```
Usage: redis-cli [OPTIONS] [cmd [arg [arg ...]]]
-h <hostname> Server hostname (default: 127.0.0.1).
-p <port> Server port (default: 6379).
-t <timeout> Server connection timeout in seconds (decimals allowed).
Default timeout is 0, meaning no limit, depending on the OS.
-s <socket> Server socket (overrides hostname and port).
-a <password> Password to use when connecting to the server.
You can also use the REDISCLI_AUTH environment
variable to pass this password more safely
(if both are used, this argument takes precedence).
--user <username> Used to send ACL style 'AUTH username pass'. Needs -a.
--pass <password> Alias of -a for consistency with the new --user option.
--askpass Force user to input password with mask from STDIN.
If this argument is used, '-a' and REDISCLI_AUTH
environment variable will be ignored.
-u <uri> Server URI on format redis://user:password@host:port/dbnum
User, password and dbnum are optional. For authentication
without a username, use username 'default'. For TLS, use
the scheme 'rediss'.
-r <repeat> Execute specified command N times.
-i <interval> When -r is used, waits <interval> seconds per command.
It is possible to specify sub-second times like -i 0.1.
This interval is also used in --scan and --stat per cycle.
and in --bigkeys, --memkeys, --keystats, and --hotkeys per 100 cycles.
-n <db> Database number.
-2 Start session in RESP2 protocol mode.
-3 Start session in RESP3 protocol mode.
-x Read last argument from STDIN (see example below).
-X Read <tag> argument from STDIN (see example below).
-d <delimiter> Delimiter between response bulks for raw formatting (default: \n).
-D <delimiter> Delimiter between responses for raw formatting (default: \n).
-c Enable cluster mode (follow -ASK and -MOVED redirections).
-e Return exit error code when command execution fails.
-4 Prefer IPv4 over IPv6 on DNS lookup.
-6 Prefer IPv6 over IPv4 on DNS lookup.
--raw Use raw formatting for replies (default when STDOUT is
not a tty).
--no-raw Force formatted output even when STDOUT is not a tty.
--quoted-input Force input to be handled as quoted strings.
--csv Output in CSV format.
--json Output in JSON format (default RESP3, use -2 if you want to use with RESP2).
--quoted-json Same as --json, but produce ASCII-safe quoted strings, not Unicode.
--show-pushes <yn> Whether to print RESP3 PUSH messages. Enabled by default when
STDOUT is a tty but can be overridden with --show-pushes no.
--stat Print rolling stats about server: mem, clients, ...
--latency Enter a special mode continuously sampling latency.
If you use this mode in an interactive session it runs
forever displaying real-time stats. Otherwise if --raw or
--csv is specified, or if you redirect the output to a non
TTY, it samples the latency for 1 second (you can use
-i to change the interval), then produces a single output
and exits.
--latency-history Like --latency but tracking latency changes over time.
Default time interval is 15 sec. Change it using -i.
--latency-dist Shows latency as a spectrum, requires xterm 256 colors.
Default time interval is 1 sec. Change it using -i.
--lru-test <keys> Simulate a cache workload with an 80-20 distribution.
--replica Simulate a replica showing commands received from the master.
--rdb <filename> Transfer an RDB dump from remote server to local file.
Use filename of "-" to write to stdout.
--functions-rdb <filename> Like --rdb but only get the functions (not the keys)
when getting the RDB dump file.
--pipe Transfer raw Redis protocol from stdin to server.
--pipe-timeout <n> In --pipe mode, abort with error if after sending all data.
no reply is received within <n> seconds.
Default timeout: 30. Use 0 to wait forever.
--bigkeys Sample Redis keys looking for keys with many elements (complexity).
--memkeys Sample Redis keys looking for keys consuming a lot of memory.
--memkeys-samples <n> Sample Redis keys looking for keys consuming a lot of memory.
And define number of key elements to sample
--keystats Sample Redis keys looking for keys memory size and length (combine bigkeys and memkeys).
--keystats-samples <n> Sample Redis keys looking for keys memory size and length.
And define number of key elements to sample (only for memory usage).
--cursor <n> Start the scan at the cursor <n> (usually after a Ctrl-C).
Optionally used with --keystats and --keystats-samples.
--top <n> To display <n> top key sizes (default: 10).
Optionally used with --keystats and --keystats-samples.
--hotkeys Sample Redis keys looking for hot keys.
only works when maxmemory-policy is *lfu.
--scan List all keys using the SCAN command.
--pattern <pat> Keys pattern when using the --scan, --bigkeys, --memkeys,
--keystats or --hotkeys options (default: *).
--count <count> Count option when using the --scan, --bigkeys, --memkeys,
--keystats or --hotkeys (default: 10).
--quoted-pattern <pat> Same as --pattern, but the specified string can be
quoted, in order to pass an otherwise non binary-safe string.
--intrinsic-latency <sec> Run a test to measure intrinsic system latency.
The test will run for the specified amount of seconds.
--eval <file> Send an EVAL command using the Lua script at <file>.
--ldb Used with --eval enable the Redis Lua debugger.
--ldb-sync-mode Like --ldb but uses the synchronous Lua debugger, in
this mode the server is blocked and script changes are
not rolled back from the server memory.
--cluster <command> [args...] [opts...]
Cluster Manager command and arguments (see below).
--verbose Verbose mode.
--no-auth-warning Don't show warning message when using password on command
line interface.
--help Output this help and exit.
--version Output version and exit.

Cluster Manager Commands:
Use --cluster help to list all available cluster manager commands.

Examples:
redis-cli -u redis://default:PASSWORD@localhost:6379/0
cat /etc/passwd | redis-cli -x set mypasswd
redis-cli -D "" --raw dump key > key.dump && redis-cli -X dump_tag restore key2 0 dump_tag replace < key.dump
redis-cli -r 100 lpush mylist x
redis-cli -r 100 -i 1 info | grep used_memory_human:
redis-cli --quoted-input set '"null-\x00-separated"' value
redis-cli --eval myscript.lua key1 key2 , arg1 arg2 arg3
redis-cli --scan --pattern '*:12345*'
redis-cli --scan --pattern '*:12345*' --count 100

(Note: when using --eval the comma separates KEYS[] from ARGV[] items)

When no command is given, redis-cli starts in interactive mode.
Type "help" in interactive mode for information on available commands
and settings.
```
2 changes: 1 addition & 1 deletion content/embeds/k8s/openshift_rec.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ spec:

redisEnterpriseImageSpec:
repository: registry.connect.redhat.com/redislabs/redis-enterprise
versionTag: 8.0.2-17
versionTag: 8.0.6-50
redisEnterpriseServicesRiggerImageSpec:
repository: registry.connect.redhat.com/redislabs/services-manager
bootstrapperImageSpec:
Expand Down
12 changes: 10 additions & 2 deletions content/embeds/k8s/openshift_role.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,25 @@ metadata:
rules:
- apiGroups:
- rbac.authorization.k8s.io
- ""
resources:
- roles
- serviceaccounts
- rolebindings
verbs:
- create
- get
- update
- patch
- delete
- apiGroups:
- ""
resources:
- serviceaccounts
verbs:
- create
- get
- update
- patch
- delete
- apiGroups:
- app.redislabs.com
resources:
Expand Down
12 changes: 10 additions & 2 deletions content/embeds/k8s/role.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,25 @@ metadata:
rules:
- apiGroups:
- rbac.authorization.k8s.io
- ""
resources:
- roles
- serviceaccounts
- rolebindings
verbs:
- create
- get
- update
- patch
- delete
- apiGroups:
- ""
resources:
- serviceaccounts
verbs:
- create
- get
- update
- patch
- delete
- apiGroups:
- app.redislabs.com
resources:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,14 @@ The Active-Active database global configurations, contains the global properties
<td><a href="#specglobalconfigurationsalertsettings">alertSettings</a></td>
<td>object</td>
<td>
Settings for database alerts. Note - Alert settings are not supported for Active-Active database.<br/>
Settings for database alerts.<br/>
</td>
<td>false</td>
</tr><tr>
<td><a href="#specglobalconfigurationsauditing">auditing</a></td>
<td>object</td>
<td>
Database auditing configuration.<br/>
</td>
<td>false</td>
</tr><tr>
Expand Down Expand Up @@ -323,6 +330,16 @@ The Active-Active database global configurations, contains the global properties
Whether this database supports RESP3 protocol. Note - Deleting this property after explicitly setting its value shall have no effect. Please view the corresponding field in RS doc for more info.<br/>
</td>
<td>false</td>
</tr><tr>
<td>rofRamRatio</td>
<td>integer</td>
<td>
RAM allocation ratio for Redis Flex (v2) databases as a percentage of total data size. Valid range 0-100. When omitted, RS uses the default value of 50%. Controls how much RAM is allocated per unit of data (e.g., 30% means 3MB RAM per 10MB data). RAM grows proportionally with data until rofRamSize limit is reached (if specified). Only applicable when isRof=true and Redis version >= 8.0 (BigStore v2 - Redis Flex).<br/>
<br/>
<i>Minimum</i>: 0<br/>
<i>Maximum</i>: 100<br/>
</td>
<td>false</td>
</tr><tr>
<td>rofRamSize</td>
<td>string</td>
Expand Down Expand Up @@ -422,7 +439,7 @@ Connection/ association to the Active-Active database.
### spec.globalConfigurations.alertSettings
<sup><sup>[↩ Parent](#specglobalconfigurations)</sup></sup>

Settings for database alerts. Note - Alert settings are not supported for Active-Active database.
Settings for database alerts.

<table>
<thead>
Expand Down Expand Up @@ -1022,6 +1039,31 @@ Dataset size has reached the threshold value [% of the memory limit]
</table>


### spec.globalConfigurations.auditing
<sup><sup>[↩ Parent](#specglobalconfigurations)</sup></sup>

Database auditing configuration.

<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td>dbConnsAuditing</td>
<td>boolean</td>
<td>
Enables auditing of database connection and authentication events. When enabled, connection, authentication, and disconnection events are tracked and sent to the configured audit listener (configured at the cluster level). The cluster-level auditing configuration must be set before enabling this on a database.<br/>
</td>
<td>false</td>
</tr></tbody>
</table>


### spec.globalConfigurations.backup
<sup><sup>[↩ Parent](#specglobalconfigurations)</sup></sup>

Expand Down
Loading