Skip to content

Commit 448613f

Browse files
authored
RS: Add extra output field names and descriptions to rladmin status reference (#1191)
* DOC-4357 RS: Add output field names and descriptions to rladmin status extra all reference * DOC-4357 Added table intro text & some copy edits
1 parent 2e61f91 commit 448613f

File tree

1 file changed

+77
-4
lines changed
  • content/operate/rs/references/cli-utilities/rladmin

1 file changed

+77
-4
lines changed

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

Lines changed: 77 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ If `issues_only` is specified, it only shows instances that do not have an `OK`
5050

5151
In the `CLUSTER NODES` section, `*node` indicates which node you are connected to.
5252

53+
For descriptions of the fields returned by `rladmin status extra all`, see the output tables for [nodes](#returns-nodes), [databases](#returns-dbs), [endpoints](#returns-endpoints), and [shards](#returns-shards).
54+
5355
### Example
5456

5557
``` sh
@@ -112,14 +114,33 @@ rladmin status databases
112114
| extra state_machine | Shows execution of state machine information |
113115
| extra watchdog | Shows watchdog status |
114116

115-
### Returns
117+
### Returns {#returns-dbs}
116118

117119
Returns a table of the status of all databases on the cluster.
118120

119121
If `sort <column_titles>` is specified, the result is sorted by the specified table columns.
120122

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

125+
The following table describes the fields returned by `rladmin status databases extra all`:
126+
127+
| Field | Description |
128+
|-------|-------------|
129+
| DB:ID | Database ID |
130+
| NAME | Database name |
131+
| TYPE | Database type: Redis or Memcached |
132+
| STATUS | Database status |
133+
| SHARDS | The number of primary shards in the database |
134+
| PLACEMENT | How the shards are spread across nodes in the cluster, densely or sparsely |
135+
| REPLICATION | Is replication enabled for the database |
136+
| PERSISTENCE | Is persistence enabled for the database |
137+
| ENDPOINT | Database endpoint |
138+
| EXEC_STATE | The current state of the state machine |
139+
| EXEC_STATE_MACHINE | The name of the running state machine |
140+
| BACKUP_PROGRESS | The database’s backup progress |
141+
| MISSING_BACKUP_TIME | How long ago a backup was done |
142+
| REDIS_VERSION | The database’s Redis version |
143+
123144
### Example
124145

125146
``` sh
@@ -166,14 +187,26 @@ rladmin status endpoints
166187
| extra state_machine | Shows execution of state machine information |
167188
| extra watchdog | Shows watchdog status |
168189
169-
### Returns
190+
### Returns {#returns-endpoints}
170191
171192
Returns a table of the status of all endpoints on the cluster.
172193
173194
If `sort <column_titles>` is specified, the result is sorted by the specified table columns.
174195
175196
If `issues_only` is specified, it only shows endpoints that do not have an `OK` status.
176197
198+
The following table describes the fields returned by `rladmin status endpoints extra all`:
199+
200+
| Field | Description |
201+
|-------|-------------|
202+
| DB:ID | Database ID |
203+
| NAME | Database name |
204+
| ID | Endpoint ID |
205+
| NODE | The node that hosts the endpoint |
206+
| ROLE | The proxy policy of the database: single, all-master-shards, or all-nodes |
207+
| SSL | Is SSL enabled |
208+
| WATCHDOG_STATUS | The shards related to the endpoint are monitored and healthy |
209+
177210
### Example
178211
179212
``` sh
@@ -264,7 +297,7 @@ rladmin status nodes
264297
| extra state_machine | Shows execution of state machine information |
265298
| extra watchdog | Shows watchdog status |
266299
267-
### Returns
300+
### Returns {#returns-nodes}
268301
269302
Returns a table of the status of all nodes on the cluster.
270303
@@ -274,6 +307,29 @@ If `issues_only` is specified, it only shows nodes that do not have an `OK` stat
274307
275308
`*node` indicates which node you are connected to.
276309
310+
The following table describes the fields returned by `rladmin status nodes extra all`:
311+
312+
| Field | Description |
313+
|-------|-------------|
314+
| NODE:ID | Node ID |
315+
| ROLE | Is the node a primary (`master`) or secondary (`slave`) node |
316+
| ADDRESS | The node’s internal IP address |
317+
| EXTERNAL ADDRESS | The node’s external IP address |
318+
| HOSTNAME | Node name |
319+
| MASTERS | The number of primary shards on the node |
320+
| SLAVES | The number of replica shards on the node |
321+
| 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. |
322+
| SHARDS | The number of shards on the node |
323+
| CORES | The number of cores on the node |
324+
| 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. |
325+
| 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 shard limit, is in maintenance mode, or is a quorum-only node. |
326+
| FLASH | The amount of flash memory available on the node, similar to `FREE_RAM` |
327+
| AVAILABLE_FLASH | Flash memory available to create new shards, similar to `PROVISIONAL_RAM` |
328+
| VERSION | The cluster version installed on the node |
329+
| SHA | The node’s SHA hash |
330+
| RACK-ID | The node’s rack ID |
331+
| STATUS | The node’s status |
332+
277333
### Example
278334
279335
``` sh
@@ -321,14 +377,31 @@ rladmin status shards
321377
| extra state_machine | Shows execution of state machine information |
322378
| extra watchdog | Shows watchdog status |
323379
324-
### Returns
380+
### Returns {#returns-shards}
325381
326382
Returns a table of the status of all shards on the cluster.
327383
328384
If `sort <column_titles>` is specified, the result is sorted by the specified table columns.
329385
330386
If `issues_only` is specified, it only shows shards that do not have an `OK` status.
331387
388+
The following table describes the fields returned by `rladmin status shards extra all`:
389+
390+
| Field | Description |
391+
|-------|-------------|
392+
| DB:ID | Database ID |
393+
| NAME | Database name |
394+
| ID | Shard ID |
395+
| NODE | The node on which the shard resides |
396+
| ROLE | The shard’s role: primary (`master`) or replica (`slave`) |
397+
| SLOTS | Redis keys slot range of the shard |
398+
| USED_MEMORY | Memory used by the shard |
399+
| BACKUP_PROGRESS | The shard’s backup progress |
400+
| RAM_FRAG | The shard’s RAM fragmentation caused by deleted data or expired keys. A large value can indicate inefficient memory allocation. |
401+
| FLASH_FRAG | For Auto Tiering databases, the shard’s flash fragmentation |
402+
| WATCHDOG_STATUS | The shard is being monitored by the node watchdog and the shard is healthy |
403+
| STATUS | The shard’s status |
404+
332405
### Example
333406
334407
``` sh

0 commit comments

Comments
 (0)