Skip to content

Commit 1fe4976

Browse files
committed
DOC-4357 RS: Add output field names and descriptions to rladmin status extra all reference
1 parent 6a3cee9 commit 1fe4976

File tree

1 file changed

+63
-0
lines changed
  • content/operate/rs/references/cli-utilities/rladmin

1 file changed

+63
-0
lines changed

content/operate/rs/references/cli-utilities/rladmin/status.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,23 @@ If `sort <column_titles>` is specified, the result is sorted by the specified ta
120120

121121
If `issues_only` is specified, it only shows databases that do not have an `OK` status.
122122

123+
| Field | Description |
124+
|-------|-------------|
125+
| DB:ID | Database ID |
126+
| NAME | Database name |
127+
| TYPE | Databases type: Redis or Memcached |
128+
| STATUS | Databases status |
129+
| SHARDS | The number of primary shards in the database |
130+
| PLACEMENT | The database's shad placement: dense or sparse. It means how the shards will be spread between the nodes in the cluster. |
131+
| REPLICATION | Is replication enabled for the database |
132+
| PERSISTENCE | Is persistence enabled for the database |
133+
| ENDPOINT | Database endpoint |
134+
| EXEC_STATE | The state of the state machine - the operation in which it is |
135+
| EXEC_STATE_MACHINE | The name of state machine being run |
136+
| BACKUP_PROGRESS | The database’s backup progress |
137+
| MISSING_BACKUP_TIME | How long ago a backup was done |
138+
| REDIS_VERSION | The database’s Redis version |
139+
123140
### Example
124141

125142
``` sh
@@ -174,6 +191,16 @@ If `sort <column_titles>` is specified, the result is sorted by the specified ta
174191
175192
If `issues_only` is specified, it only shows endpoints that do not have an `OK` status.
176193
194+
| Field | Description |
195+
|-------|-------------|
196+
| DB:ID | Database ID |
197+
| NAME | Database name |
198+
| ID | Endpoint ID |
199+
| NODE | The node that hosts the endpoint |
200+
| ROLE | The proxy policy of the database: single, all-master-shards, all-nodes |
201+
| SSL | Is SSL enabled |
202+
| WATCHDOG_STATUS | The shards related to that endpoint are monitored and are healthy |
203+
177204
### Example
178205
179206
``` sh
@@ -274,6 +301,27 @@ If `issues_only` is specified, it only shows nodes that do not have an `OK` stat
274301
275302
`*node` indicates which node you are connected to.
276303
304+
| Field | Description |
305+
|-------|-------------|
306+
| NODE:ID | Node ID |
307+
| ROLE | Is the node a primary (`master`) or secondary (`slave`) node? Most management requests are handled by the primary node. |
308+
| ADDRESS | The node’s internal IP address |
309+
| EXTERNAL ADDRESS | The node’s external IP address |
310+
| HOSTNAME | Node name |
311+
| MASTERS | The number of primary shards on the node |
312+
| SLAVES | The number of replica shards on the node |
313+
| OVERBOOKING_DEPTH | Memory available to create new shards, accounting for the memory reserved for existing shards to grow, even if `shards_overbooking` is enabled. A negative value indicates how much memory is overbooked rather than just showing that no memory is available for new shards. |
314+
| SHARDS | The number of shards on the node |
315+
| CORES | The number of cores on the node |
316+
| FREE_RAM | free_memory/total_memory<br />**free_memory**: the amount of free memory reported by the OS.<br />**total_memory**: the total physical memory available on the node. |
317+
| PROVISIONAL_RAM | Memory available to create new shards, displayed as available_provisional_memory/total_provisional_memory.<br />**available_provisional_memory**: memory currently available for the creation of new shards.<br />**total_provisional_memory**: memory that would be available to create new shards if the used memory on the node was 0.<br />If the available provisional memory is 0, the node cannot create new shards because the node has reached its shards limit, is in maintenance mode, or is a quorum-only node. |
318+
| FLASH | Very similar to FREE_RAM |
319+
| AVAILABLE_FLASH | Very similar PROVISIONAL_RAM |
320+
| VERSION | The cluster version installed on the node |
321+
| SHA | The node’s SHA hash |
322+
| RACK-ID | The node’s rack-id |
323+
| STATUS | The node’s status |
324+
277325
### Example
278326
279327
``` sh
@@ -329,6 +377,21 @@ If `sort <column_titles>` is specified, the result is sorted by the specified ta
329377
330378
If `issues_only` is specified, it only shows shards that do not have an `OK` status.
331379
380+
| Field | Description |
381+
|-------|-------------|
382+
| DB:ID | Database ID |
383+
| NAME | Database name |
384+
| ID | Shard ID |
385+
| NODE | The node on which the shard resides |
386+
| ROLE | The shard’s role: primary (`master`) or replica (`slave`). |
387+
| SLOTS | Redis keys slot range of the shard |
388+
| USED_MEMORY | Memory used by the shard |
389+
| BACKUP_PROGRESS | Shard’s backup progress. |
390+
| RAM_FRAG | Shard’s RAM fragmentation caused by deleted data or expired keys. A large value can indicate inefficient memory allocation. |
391+
| FLASH_FRAG | For Auto Tiering databases, the shard’s FLASH fragmentation |
392+
| WATCHDOG_STATUS | The shard is being monitored by the node watchdog and the shard is healthy |
393+
| STATUS | The shard’s status |
394+
332395
### Example
333396
334397
``` sh

0 commit comments

Comments
 (0)